- 1.73.0 (latest)
- 1.72.0
- 1.71.1
- 1.70.0
- 1.69.0
- 1.68.0
- 1.67.1
- 1.66.0
- 1.65.0
- 1.63.0
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
Summary of entries of Methods for aiplatform.
google.cloud.aiplatform.autolog
autolog(disable=False)
Enables autologging of parameters and metrics to Vertex Experiments.
See more: google.cloud.aiplatform.autolog
google.cloud.aiplatform.end_run
end_run(
state: google.cloud.aiplatform_v1.types.execution.Execution.State = State.COMPLETE,
)
Ends the the current experiment run.
See more: google.cloud.aiplatform.end_run
google.cloud.aiplatform.end_upload_tb_log
end_upload_tb_log()
Ends the current TensorBoard uploader.
google.cloud.aiplatform.get_experiment_df
get_experiment_df(experiment: typing.Optional[str] = None) -> pd.DataFrame
Returns a Pandas DataFrame of the parameters and metrics associated with one experiment.
google.cloud.aiplatform.get_experiment_model
get_experiment_model(
artifact_id: str,
*,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel
Retrieves an existing ExperimentModel artifact given an artifact id.
google.cloud.aiplatform.get_pipeline_df
get_pipeline_df(pipeline: str) -> pd.DataFrame
Returns a Pandas DataFrame of the parameters and metrics associated with one pipeline.
See more: google.cloud.aiplatform.get_pipeline_df
google.cloud.aiplatform.init
init(
*,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
experiment: typing.Optional[str] = None,
experiment_description: typing.Optional[str] = None,
experiment_tensorboard: typing.Optional[
typing.Union[
str,
google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard,
bool,
]
] = None,
staging_bucket: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
encryption_spec_key_name: typing.Optional[str] = None,
network: typing.Optional[str] = None,
service_account: typing.Optional[str] = None,
api_endpoint: typing.Optional[str] = None,
api_transport: typing.Optional[str] = None
)
Updates common initialization parameters with provided options.
See more: google.cloud.aiplatform.init
google.cloud.aiplatform.log
log(
*,
pipeline_job: typing.Optional[
google.cloud.aiplatform.pipeline_jobs.PipelineJob
] = None
)
Log Vertex AI Resources to the current experiment run.
See more: google.cloud.aiplatform.log
google.cloud.aiplatform.log_classification_metrics
log_classification_metrics(
*,
labels: typing.Optional[typing.List[str]] = None,
matrix: typing.Optional[typing.List[typing.List[int]]] = None,
fpr: typing.Optional[typing.List[float]] = None,
tpr: typing.Optional[typing.List[float]] = None,
threshold: typing.Optional[typing.List[float]] = None,
display_name: typing.Optional[str] = None
) -> (
google.cloud.aiplatform.metadata.schema.google.artifact_schema.ClassificationMetrics
)
Create an artifact for classification metrics and log to ExperimentRun.
See more: google.cloud.aiplatform.log_classification_metrics
google.cloud.aiplatform.log_metrics
log_metrics(metrics: typing.Dict[str, typing.Union[float, int, str]])
Log single or multiple Metrics with specified key and value pairs.
See more: google.cloud.aiplatform.log_metrics
google.cloud.aiplatform.log_model
log_model(
model: typing.Union[sklearn.base.BaseEstimator, xgb.Booster, tf.Module],
artifact_id: typing.Optional[str] = None,
*,
uri: typing.Optional[str] = None,
input_example: typing.Union[list, dict, pd.DataFrame, np.ndarray] = None,
display_name: typing.Optional[str] = None,
metadata_store_id: typing.Optional[str] = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel
Saves a ML model into a MLMD artifact and log it to this ExperimentRun.
See more: google.cloud.aiplatform.log_model
google.cloud.aiplatform.log_params
log_params(params: typing.Dict[str, typing.Union[float, int, str]])
Log single or multiple parameters with specified key and value pairs.
See more: google.cloud.aiplatform.log_params
google.cloud.aiplatform.log_time_series_metrics
log_time_series_metrics(
metrics: typing.Dict[str, float],
step: typing.Optional[int] = None,
wall_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
)
Logs time series metrics to to this Experiment Run.
google.cloud.aiplatform.save_model
save_model(
model: typing.Union[sklearn.base.BaseEstimator, xgb.Booster, tf.Module],
artifact_id: typing.Optional[str] = None,
*,
uri: typing.Optional[str] = None,
input_example: typing.Union[list, dict, pd.DataFrame, np.ndarray] = None,
tf_save_model_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None,
display_name: typing.Optional[str] = None,
metadata_store_id: typing.Optional[str] = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel
Saves a ML model into a MLMD artifact.
See more: google.cloud.aiplatform.save_model
google.cloud.aiplatform.start_execution
start_execution(
*,
schema_title: typing.Optional[str] = None,
display_name: typing.Optional[str] = None,
resource_id: typing.Optional[str] = None,
metadata: typing.Optional[typing.Dict[str, typing.Any]] = None,
schema_version: typing.Optional[str] = None,
description: typing.Optional[str] = None,
resume: bool = False,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.execution.Execution
Create and starts a new Metadata Execution or resumes a previously created Execution.
See more: google.cloud.aiplatform.start_execution
google.cloud.aiplatform.start_run
start_run(
run: str,
*,
tensorboard: typing.Optional[
typing.Union[
google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard, str
]
] = None,
resume=False
) -> google.cloud.aiplatform.metadata.experiment_run_resource.ExperimentRun
Start a run to current session.
See more: google.cloud.aiplatform.start_run
google.cloud.aiplatform.start_upload_tb_log
start_upload_tb_log(
tensorboard_experiment_name: str,
logdir: str,
tensorboard_id: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
experiment_display_name: typing.Optional[str] = None,
run_name_prefix: typing.Optional[str] = None,
description: typing.Optional[str] = None,
allowed_plugins: typing.Optional[typing.FrozenSet[str]] = None,
)
Continues to listen for new data in the logdir and uploads when it appears.
google.cloud.aiplatform.upload_tb_log
upload_tb_log(
tensorboard_experiment_name: str,
logdir: str,
tensorboard_id: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
experiment_display_name: typing.Optional[str] = None,
run_name_prefix: typing.Optional[str] = None,
description: typing.Optional[str] = None,
verbosity: typing.Optional[int] = 1,
allowed_plugins: typing.Optional[typing.FrozenSet[str]] = None,
)
upload only the existing data in the logdir and then return immediately.
See more: google.cloud.aiplatform.upload_tb_log
vertexai.init
init(
*,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
experiment: typing.Optional[str] = None,
experiment_description: typing.Optional[str] = None,
experiment_tensorboard: typing.Optional[
typing.Union[
str,
google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard,
bool,
]
] = None,
staging_bucket: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
encryption_spec_key_name: typing.Optional[str] = None,
network: typing.Optional[str] = None,
service_account: typing.Optional[str] = None,
api_endpoint: typing.Optional[str] = None,
api_transport: typing.Optional[str] = None
)
Updates common initialization parameters with provided options.
See more: vertexai.init
vertexai.preview.end_run
end_run(
state: google.cloud.aiplatform_v1.types.execution.Execution.State = State.COMPLETE,
)
Ends the the current experiment run.
See more: vertexai.preview.end_run
vertexai.preview.from_pretrained
from_pretrained(
*,
model_name: typing.Optional[str] = None,
custom_job_name: typing.Optional[str] = None,
foundation_model_name: typing.Optional[str] = None
) -> typing.Union[sklearn.base.BaseEstimator, tf.Module, torch.nn.Module]
Pulls a model from Model Registry or from a CustomJob ID for retraining.
See more: vertexai.preview.from_pretrained
vertexai.preview.get_experiment_df
get_experiment_df(experiment: typing.Optional[str] = None) -> pd.DataFrame
Returns a Pandas DataFrame of the parameters and metrics associated with one experiment.
See more: vertexai.preview.get_experiment_df
vertexai.preview.init
init(
*,
remote: typing.Optional[bool] = None,
autolog: typing.Optional[bool] = None,
cluster: typing.Optional[
vertexai.preview._workflow.shared.configs.PersistentResourceConfig
] = None
)
Updates preview global parameters for Vertex remote execution.
See more: vertexai.preview.init
vertexai.preview.log_classification_metrics
log_classification_metrics(
*,
labels: typing.Optional[typing.List[str]] = None,
matrix: typing.Optional[typing.List[typing.List[int]]] = None,
fpr: typing.Optional[typing.List[float]] = None,
tpr: typing.Optional[typing.List[float]] = None,
threshold: typing.Optional[typing.List[float]] = None,
display_name: typing.Optional[str] = None
) -> (
google.cloud.aiplatform.metadata.schema.google.artifact_schema.ClassificationMetrics
)
Create an artifact for classification metrics and log to ExperimentRun.
vertexai.preview.log_metrics
log_metrics(metrics: typing.Dict[str, typing.Union[float, int, str]])
Log single or multiple Metrics with specified key and value pairs.
See more: vertexai.preview.log_metrics
vertexai.preview.log_params
log_params(params: typing.Dict[str, typing.Union[float, int, str]])
Log single or multiple parameters with specified key and value pairs.
See more: vertexai.preview.log_params
vertexai.preview.log_time_series_metrics
log_time_series_metrics(
metrics: typing.Dict[str, float],
step: typing.Optional[int] = None,
wall_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
)
Logs time series metrics to to this Experiment Run.
See more: vertexai.preview.log_time_series_metrics
vertexai.preview.register
register(
model: typing.Union[sklearn.base.BaseEstimator, tf.Module, torch.nn.Module],
use_gpu: bool = False,
) -> google.cloud.aiplatform.models.Model
Registers a model and returns a Model representing the registered Model resource.
See more: vertexai.preview.register
vertexai.preview.remote
remote(cls_or_method: typing.Any) -> typing.Any
Takes a class or method and add Vertex remote execution support.
See more: vertexai.preview.remote
vertexai.preview.start_run
start_run(
run: str,
*,
tensorboard: typing.Optional[
typing.Union[
google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard, str
]
] = None,
resume=False
) -> google.cloud.aiplatform.metadata.experiment_run_resource.ExperimentRun
Start a run to current session.
See more: vertexai.preview.start_run
vertexai.preview.evaluation.make_metric
make_metric(
name: str,
metric_function: typing.Callable[
[typing.Dict[str, typing.Any]], typing.Dict[str, typing.Any]
],
) -> vertexai.preview.evaluation.metrics._base.CustomMetric
Makes a custom metric.
See more: vertexai.preview.evaluation.make_metric
google.cloud.aiplatform.Artifact
Artifact(
artifact_name: str,
*,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
)
Retrieves an existing Metadata Artifact given a resource name or ID.
See more: google.cloud.aiplatform.Artifact
google.cloud.aiplatform.Artifact.create
create(
schema_title: str,
*,
resource_id: typing.Optional[str] = None,
uri: typing.Optional[str] = None,
display_name: typing.Optional[str] = None,
schema_version: typing.Optional[str] = None,
description: typing.Optional[str] = None,
metadata: typing.Optional[typing.Dict] = None,
state: google.cloud.aiplatform_v1.types.artifact.Artifact.State = State.LIVE,
metadata_store_id: typing.Optional[str] = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.artifact.Artifact
Creates a new Metadata Artifact.
See more: google.cloud.aiplatform.Artifact.create
google.cloud.aiplatform.Artifact.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.Artifact.delete
google.cloud.aiplatform.Artifact.get
get(
resource_id: str,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.metadata.resource._Resource
Retrieves a Metadata resource.
See more: google.cloud.aiplatform.Artifact.get
google.cloud.aiplatform.Artifact.get_or_create
get_or_create(
resource_id: str,
schema_title: str,
display_name: typing.Optional[str] = None,
schema_version: typing.Optional[str] = None,
description: typing.Optional[str] = None,
metadata: typing.Optional[typing.Dict] = None,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.metadata.resource._Resource
Retrieves or Creates (if it does not exist) a Metadata resource.
google.cloud.aiplatform.Artifact.get_with_uri
get_with_uri(
uri: str,
*,
metadata_store_id: typing.Optional[str] = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.artifact.Artifact
Get an Artifact by it's uri.
google.cloud.aiplatform.Artifact.list
list(
filter: typing.Optional[str] = None,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
order_by: typing.Optional[str] = None,
) -> typing.List[google.cloud.aiplatform.metadata.resource._Resource]
List resources that match the list filter in target metadataStore.
See more: google.cloud.aiplatform.Artifact.list
google.cloud.aiplatform.Artifact.sync_resource
sync_resource()
Syncs local resource with the resource in metadata store.
google.cloud.aiplatform.Artifact.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.Artifact.to_dict
google.cloud.aiplatform.Artifact.update
update(
metadata: typing.Optional[typing.Dict] = None,
description: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Updates an existing Metadata resource with new metadata.
See more: google.cloud.aiplatform.Artifact.update
google.cloud.aiplatform.Artifact.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.Artifact.wait
google.cloud.aiplatform.AutoMLForecastingTrainingJob
AutoMLForecastingTrainingJob(
display_name: typing.Optional[str] = None,
optimization_objective: typing.Optional[str] = None,
column_specs: typing.Optional[typing.Dict[str, str]] = None,
column_transformations: typing.Optional[
typing.List[typing.Dict[str, typing.Dict[str, str]]]
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
training_encryption_spec_key_name: typing.Optional[str] = None,
model_encryption_spec_key_name: typing.Optional[str] = None,
)
Constructs a Forecasting Training Job.
See more: google.cloud.aiplatform.AutoMLForecastingTrainingJob
google.cloud.aiplatform.AutoMLForecastingTrainingJob.cancel
cancel() -> None
Starts asynchronous cancellation on the TrainingJob.
See more: google.cloud.aiplatform.AutoMLForecastingTrainingJob.cancel
google.cloud.aiplatform.AutoMLForecastingTrainingJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.AutoMLForecastingTrainingJob.delete
google.cloud.aiplatform.AutoMLForecastingTrainingJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.AutoMLForecastingTrainingJob.done
google.cloud.aiplatform.AutoMLForecastingTrainingJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.training_jobs._TrainingJob
Get Training Job for the given resource_name.
See more: google.cloud.aiplatform.AutoMLForecastingTrainingJob.get
google.cloud.aiplatform.AutoMLForecastingTrainingJob.get_model
get_model(sync=True) -> google.cloud.aiplatform.models.Model
Vertex AI Model produced by this training, if one was produced.
See more: google.cloud.aiplatform.AutoMLForecastingTrainingJob.get_model
google.cloud.aiplatform.AutoMLForecastingTrainingJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this TrainingJob resource.
See more: google.cloud.aiplatform.AutoMLForecastingTrainingJob.list
google.cloud.aiplatform.AutoMLForecastingTrainingJob.run
run(
dataset: google.cloud.aiplatform.datasets.time_series_dataset.TimeSeriesDataset,
target_column: str,
time_column: str,
time_series_identifier_column: str,
unavailable_at_forecast_columns: typing.List[str],
available_at_forecast_columns: typing.List[str],
forecast_horizon: int,
data_granularity_unit: str,
data_granularity_count: int,
training_fraction_split: typing.Optional[float] = None,
validation_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
predefined_split_column_name: typing.Optional[str] = None,
timestamp_split_column_name: typing.Optional[str] = None,
weight_column: typing.Optional[str] = None,
time_series_attribute_columns: typing.Optional[typing.List[str]] = None,
context_window: typing.Optional[int] = None,
export_evaluated_data_items: bool = False,
export_evaluated_data_items_bigquery_destination_uri: typing.Optional[str] = None,
export_evaluated_data_items_override_destination: bool = False,
quantiles: typing.Optional[typing.List[float]] = None,
validation_options: typing.Optional[str] = None,
budget_milli_node_hours: int = 1000,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
additional_experiments: typing.Optional[typing.List[str]] = None,
hierarchy_group_columns: typing.Optional[typing.List[str]] = None,
hierarchy_group_total_weight: typing.Optional[float] = None,
hierarchy_temporal_total_weight: typing.Optional[float] = None,
hierarchy_group_temporal_total_weight: typing.Optional[float] = None,
window_column: typing.Optional[str] = None,
window_stride_length: typing.Optional[int] = None,
window_max_count: typing.Optional[int] = None,
holiday_regions: typing.Optional[typing.List[str]] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
enable_probabilistic_inference: bool = False,
) -> google.cloud.aiplatform.models.Model
Runs the training job and returns a model.
See more: google.cloud.aiplatform.AutoMLForecastingTrainingJob.run
google.cloud.aiplatform.AutoMLForecastingTrainingJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.AutoMLForecastingTrainingJob.to_dict
google.cloud.aiplatform.AutoMLForecastingTrainingJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.AutoMLForecastingTrainingJob.wait
google.cloud.aiplatform.AutoMLForecastingTrainingJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.AutoMLForecastingTrainingJob.wait_for_resource_creation
google.cloud.aiplatform.AutoMLImageTrainingJob.cancel
cancel() -> None
Starts asynchronous cancellation on the TrainingJob.
See more: google.cloud.aiplatform.AutoMLImageTrainingJob.cancel
google.cloud.aiplatform.AutoMLImageTrainingJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.AutoMLImageTrainingJob.delete
google.cloud.aiplatform.AutoMLImageTrainingJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.AutoMLImageTrainingJob.done
google.cloud.aiplatform.AutoMLImageTrainingJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.training_jobs._TrainingJob
Get Training Job for the given resource_name.
See more: google.cloud.aiplatform.AutoMLImageTrainingJob.get
google.cloud.aiplatform.AutoMLImageTrainingJob.get_model
get_model(sync=True) -> google.cloud.aiplatform.models.Model
Vertex AI Model produced by this training, if one was produced.
See more: google.cloud.aiplatform.AutoMLImageTrainingJob.get_model
google.cloud.aiplatform.AutoMLImageTrainingJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this TrainingJob resource.
See more: google.cloud.aiplatform.AutoMLImageTrainingJob.list
google.cloud.aiplatform.AutoMLImageTrainingJob.run
run(
dataset: google.cloud.aiplatform.datasets.image_dataset.ImageDataset,
training_fraction_split: typing.Optional[float] = None,
validation_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
training_filter_split: typing.Optional[str] = None,
validation_filter_split: typing.Optional[str] = None,
test_filter_split: typing.Optional[str] = None,
budget_milli_node_hours: typing.Optional[int] = None,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
disable_early_stopping: bool = False,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.models.Model
Runs the AutoML Image training job and returns a model.
See more: google.cloud.aiplatform.AutoMLImageTrainingJob.run
google.cloud.aiplatform.AutoMLImageTrainingJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.AutoMLImageTrainingJob.to_dict
google.cloud.aiplatform.AutoMLImageTrainingJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.AutoMLImageTrainingJob.wait
google.cloud.aiplatform.AutoMLImageTrainingJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.AutoMLImageTrainingJob.wait_for_resource_creation
google.cloud.aiplatform.AutoMLTabularTrainingJob.cancel
cancel() -> None
Starts asynchronous cancellation on the TrainingJob.
See more: google.cloud.aiplatform.AutoMLTabularTrainingJob.cancel
google.cloud.aiplatform.AutoMLTabularTrainingJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.AutoMLTabularTrainingJob.delete
google.cloud.aiplatform.AutoMLTabularTrainingJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.AutoMLTabularTrainingJob.done
google.cloud.aiplatform.AutoMLTabularTrainingJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.training_jobs._TrainingJob
Get Training Job for the given resource_name.
See more: google.cloud.aiplatform.AutoMLTabularTrainingJob.get
google.cloud.aiplatform.AutoMLTabularTrainingJob.get_auto_column_specs
get_auto_column_specs(
dataset: google.cloud.aiplatform.datasets.tabular_dataset.TabularDataset,
target_column: str,
) -> typing.Dict[str, str]
Returns a dict with all non-target columns as keys and 'auto' as values.
See more: google.cloud.aiplatform.AutoMLTabularTrainingJob.get_auto_column_specs
google.cloud.aiplatform.AutoMLTabularTrainingJob.get_model
get_model(sync=True) -> google.cloud.aiplatform.models.Model
Vertex AI Model produced by this training, if one was produced.
See more: google.cloud.aiplatform.AutoMLTabularTrainingJob.get_model
google.cloud.aiplatform.AutoMLTabularTrainingJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this TrainingJob resource.
See more: google.cloud.aiplatform.AutoMLTabularTrainingJob.list
google.cloud.aiplatform.AutoMLTabularTrainingJob.run
run(
dataset: google.cloud.aiplatform.datasets.tabular_dataset.TabularDataset,
target_column: str,
training_fraction_split: typing.Optional[float] = None,
validation_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
predefined_split_column_name: typing.Optional[str] = None,
timestamp_split_column_name: typing.Optional[str] = None,
weight_column: typing.Optional[str] = None,
budget_milli_node_hours: int = 1000,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
disable_early_stopping: bool = False,
export_evaluated_data_items: bool = False,
export_evaluated_data_items_bigquery_destination_uri: typing.Optional[str] = None,
export_evaluated_data_items_override_destination: bool = False,
additional_experiments: typing.Optional[typing.List[str]] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.models.Model
Runs the training job and returns a model.
See more: google.cloud.aiplatform.AutoMLTabularTrainingJob.run
google.cloud.aiplatform.AutoMLTabularTrainingJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.AutoMLTabularTrainingJob.to_dict
google.cloud.aiplatform.AutoMLTabularTrainingJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.AutoMLTabularTrainingJob.wait
google.cloud.aiplatform.AutoMLTabularTrainingJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.AutoMLTabularTrainingJob.wait_for_resource_creation
google.cloud.aiplatform.AutoMLTextTrainingJob.cancel
cancel() -> None
Starts asynchronous cancellation on the TrainingJob.
See more: google.cloud.aiplatform.AutoMLTextTrainingJob.cancel
google.cloud.aiplatform.AutoMLTextTrainingJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.AutoMLTextTrainingJob.delete
google.cloud.aiplatform.AutoMLTextTrainingJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.AutoMLTextTrainingJob.done
google.cloud.aiplatform.AutoMLTextTrainingJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.training_jobs._TrainingJob
Get Training Job for the given resource_name.
google.cloud.aiplatform.AutoMLTextTrainingJob.get_model
get_model(sync=True) -> google.cloud.aiplatform.models.Model
Vertex AI Model produced by this training, if one was produced.
See more: google.cloud.aiplatform.AutoMLTextTrainingJob.get_model
google.cloud.aiplatform.AutoMLTextTrainingJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this TrainingJob resource.
See more: google.cloud.aiplatform.AutoMLTextTrainingJob.list
google.cloud.aiplatform.AutoMLTextTrainingJob.run
run(
dataset: google.cloud.aiplatform.datasets.text_dataset.TextDataset,
training_fraction_split: typing.Optional[float] = None,
validation_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
training_filter_split: typing.Optional[str] = None,
validation_filter_split: typing.Optional[str] = None,
test_filter_split: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.models.Model
Runs the training job and returns a model.
google.cloud.aiplatform.AutoMLTextTrainingJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.AutoMLTextTrainingJob.to_dict
google.cloud.aiplatform.AutoMLTextTrainingJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.AutoMLTextTrainingJob.wait
google.cloud.aiplatform.AutoMLTextTrainingJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.AutoMLTextTrainingJob.wait_for_resource_creation
google.cloud.aiplatform.AutoMLVideoTrainingJob.cancel
cancel() -> None
Starts asynchronous cancellation on the TrainingJob.
See more: google.cloud.aiplatform.AutoMLVideoTrainingJob.cancel
google.cloud.aiplatform.AutoMLVideoTrainingJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.AutoMLVideoTrainingJob.delete
google.cloud.aiplatform.AutoMLVideoTrainingJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.AutoMLVideoTrainingJob.done
google.cloud.aiplatform.AutoMLVideoTrainingJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.training_jobs._TrainingJob
Get Training Job for the given resource_name.
See more: google.cloud.aiplatform.AutoMLVideoTrainingJob.get
google.cloud.aiplatform.AutoMLVideoTrainingJob.get_model
get_model(sync=True) -> google.cloud.aiplatform.models.Model
Vertex AI Model produced by this training, if one was produced.
See more: google.cloud.aiplatform.AutoMLVideoTrainingJob.get_model
google.cloud.aiplatform.AutoMLVideoTrainingJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this TrainingJob resource.
See more: google.cloud.aiplatform.AutoMLVideoTrainingJob.list
google.cloud.aiplatform.AutoMLVideoTrainingJob.run
run(
dataset: google.cloud.aiplatform.datasets.video_dataset.VideoDataset,
training_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
training_filter_split: typing.Optional[str] = None,
test_filter_split: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.models.Model
Runs the AutoML Video training job and returns a model.
See more: google.cloud.aiplatform.AutoMLVideoTrainingJob.run
google.cloud.aiplatform.AutoMLVideoTrainingJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.AutoMLVideoTrainingJob.to_dict
google.cloud.aiplatform.AutoMLVideoTrainingJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.AutoMLVideoTrainingJob.wait
google.cloud.aiplatform.AutoMLVideoTrainingJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.AutoMLVideoTrainingJob.wait_for_resource_creation
google.cloud.aiplatform.BatchPredictionJob.cancel
cancel() -> None
Cancels this Job.
google.cloud.aiplatform.BatchPredictionJob.create
create(
job_display_name: str,
model_name: typing.Union[str, google.cloud.aiplatform.models.Model],
instances_format: str = "jsonl",
predictions_format: str = "jsonl",
gcs_source: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
bigquery_source: typing.Optional[str] = None,
gcs_destination_prefix: typing.Optional[str] = None,
bigquery_destination_prefix: typing.Optional[str] = None,
model_parameters: typing.Optional[typing.Dict] = None,
machine_type: typing.Optional[str] = None,
accelerator_type: typing.Optional[str] = None,
accelerator_count: typing.Optional[int] = None,
starting_replica_count: typing.Optional[int] = None,
max_replica_count: typing.Optional[int] = None,
generate_explanation: typing.Optional[bool] = False,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
encryption_spec_key_name: typing.Optional[str] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
batch_size: typing.Optional[int] = None,
model_monitoring_objective_config: typing.Optional[
google.cloud.aiplatform.model_monitoring.objective.ObjectiveConfig
] = None,
model_monitoring_alert_config: typing.Optional[
google.cloud.aiplatform.model_monitoring.alert.AlertConfig
] = None,
analysis_instance_schema_uri: typing.Optional[str] = None,
service_account: typing.Optional[str] = None,
) -> google.cloud.aiplatform.jobs.BatchPredictionJob
Create a batch prediction job.
google.cloud.aiplatform.BatchPredictionJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
google.cloud.aiplatform.BatchPredictionJob.done
done() -> bool
Method indicating whether a job has completed.
google.cloud.aiplatform.BatchPredictionJob.iter_outputs
iter_outputs(
bq_max_results: typing.Optional[int] = 100,
) -> typing.Union[
typing.Iterable[storage.Blob], typing.Iterable[bigquery.table.RowIterator]
]
Returns an Iterable object to traverse the output files, either a list of GCS Blobs or a BigQuery RowIterator depending on the output config set when the BatchPredictionJob was created.
See more: google.cloud.aiplatform.BatchPredictionJob.iter_outputs
google.cloud.aiplatform.BatchPredictionJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Job Resource.
google.cloud.aiplatform.BatchPredictionJob.submit
submit(
*,
job_display_name: typing.Optional[str] = None,
model_name: typing.Union[str, google.cloud.aiplatform.models.Model],
instances_format: str = "jsonl",
predictions_format: str = "jsonl",
gcs_source: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
bigquery_source: typing.Optional[str] = None,
gcs_destination_prefix: typing.Optional[str] = None,
bigquery_destination_prefix: typing.Optional[str] = None,
model_parameters: typing.Optional[typing.Dict] = None,
machine_type: typing.Optional[str] = None,
accelerator_type: typing.Optional[str] = None,
accelerator_count: typing.Optional[int] = None,
starting_replica_count: typing.Optional[int] = None,
max_replica_count: typing.Optional[int] = None,
generate_explanation: typing.Optional[bool] = False,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
encryption_spec_key_name: typing.Optional[str] = None,
create_request_timeout: typing.Optional[float] = None,
batch_size: typing.Optional[int] = None,
model_monitoring_objective_config: typing.Optional[
google.cloud.aiplatform.model_monitoring.objective.ObjectiveConfig
] = None,
model_monitoring_alert_config: typing.Optional[
google.cloud.aiplatform.model_monitoring.alert.AlertConfig
] = None,
analysis_instance_schema_uri: typing.Optional[str] = None,
service_account: typing.Optional[str] = None
) -> google.cloud.aiplatform.jobs.BatchPredictionJob
Sumbit a batch prediction job (not waiting for completion).
google.cloud.aiplatform.BatchPredictionJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.BatchPredictionJob.to_dict
google.cloud.aiplatform.BatchPredictionJob.wait
wait()
Helper method that blocks until all futures are complete.
google.cloud.aiplatform.BatchPredictionJob.wait_for_completion
wait_for_completion() -> None
Waits for job to complete.
See more: google.cloud.aiplatform.BatchPredictionJob.wait_for_completion
google.cloud.aiplatform.BatchPredictionJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.BatchPredictionJob.wait_for_resource_creation
google.cloud.aiplatform.CustomContainerTrainingJob
CustomContainerTrainingJob(
display_name: str,
container_uri: str,
command: typing.Optional[typing.Sequence[str]] = None,
model_serving_container_image_uri: typing.Optional[str] = None,
model_serving_container_predict_route: typing.Optional[str] = None,
model_serving_container_health_route: typing.Optional[str] = None,
model_serving_container_command: typing.Optional[typing.Sequence[str]] = None,
model_serving_container_args: typing.Optional[typing.Sequence[str]] = None,
model_serving_container_environment_variables: typing.Optional[
typing.Dict[str, str]
] = None,
model_serving_container_ports: typing.Optional[typing.Sequence[int]] = None,
model_description: typing.Optional[str] = None,
model_instance_schema_uri: typing.Optional[str] = None,
model_parameters_schema_uri: typing.Optional[str] = None,
model_prediction_schema_uri: typing.Optional[str] = None,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
training_encryption_spec_key_name: typing.Optional[str] = None,
model_encryption_spec_key_name: typing.Optional[str] = None,
staging_bucket: typing.Optional[str] = None,
)
Constructs a Custom Container Training Job.
See more: google.cloud.aiplatform.CustomContainerTrainingJob
google.cloud.aiplatform.CustomContainerTrainingJob.cancel
cancel() -> None
Starts asynchronous cancellation on the TrainingJob.
See more: google.cloud.aiplatform.CustomContainerTrainingJob.cancel
google.cloud.aiplatform.CustomContainerTrainingJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.CustomContainerTrainingJob.delete
google.cloud.aiplatform.CustomContainerTrainingJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.CustomContainerTrainingJob.done
google.cloud.aiplatform.CustomContainerTrainingJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.training_jobs._TrainingJob
Get Training Job for the given resource_name.
See more: google.cloud.aiplatform.CustomContainerTrainingJob.get
google.cloud.aiplatform.CustomContainerTrainingJob.get_model
get_model(sync=True) -> google.cloud.aiplatform.models.Model
Vertex AI Model produced by this training, if one was produced.
See more: google.cloud.aiplatform.CustomContainerTrainingJob.get_model
google.cloud.aiplatform.CustomContainerTrainingJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this TrainingJob resource.
See more: google.cloud.aiplatform.CustomContainerTrainingJob.list
google.cloud.aiplatform.CustomContainerTrainingJob.run
run(
dataset: typing.Optional[
typing.Union[
google.cloud.aiplatform.datasets.image_dataset.ImageDataset,
google.cloud.aiplatform.datasets.tabular_dataset.TabularDataset,
google.cloud.aiplatform.datasets.text_dataset.TextDataset,
google.cloud.aiplatform.datasets.video_dataset.VideoDataset,
]
] = None,
annotation_schema_uri: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
base_output_dir: typing.Optional[str] = None,
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
bigquery_destination: typing.Optional[str] = None,
args: typing.Optional[typing.List[typing.Union[str, float, int]]] = None,
environment_variables: typing.Optional[typing.Dict[str, str]] = None,
replica_count: int = 1,
machine_type: str = "n1-standard-4",
accelerator_type: str = "ACCELERATOR_TYPE_UNSPECIFIED",
accelerator_count: int = 0,
boot_disk_type: str = "pd-ssd",
boot_disk_size_gb: int = 100,
reduction_server_replica_count: int = 0,
reduction_server_machine_type: typing.Optional[str] = None,
reduction_server_container_uri: typing.Optional[str] = None,
training_fraction_split: typing.Optional[float] = None,
validation_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
training_filter_split: typing.Optional[str] = None,
validation_filter_split: typing.Optional[str] = None,
test_filter_split: typing.Optional[str] = None,
predefined_split_column_name: typing.Optional[str] = None,
timestamp_split_column_name: typing.Optional[str] = None,
timeout: typing.Optional[int] = None,
restart_job_on_worker_restart: bool = False,
enable_web_access: bool = False,
enable_dashboard_access: bool = False,
tensorboard: typing.Optional[str] = None,
sync=True,
create_request_timeout: typing.Optional[float] = None,
disable_retries: bool = False,
persistent_resource_id: typing.Optional[str] = None,
) -> typing.Optional[google.cloud.aiplatform.models.Model]
Runs the custom training job.
See more: google.cloud.aiplatform.CustomContainerTrainingJob.run
google.cloud.aiplatform.CustomContainerTrainingJob.submit
submit(
dataset: typing.Optional[
typing.Union[
google.cloud.aiplatform.datasets.image_dataset.ImageDataset,
google.cloud.aiplatform.datasets.tabular_dataset.TabularDataset,
google.cloud.aiplatform.datasets.text_dataset.TextDataset,
google.cloud.aiplatform.datasets.video_dataset.VideoDataset,
]
] = None,
annotation_schema_uri: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
base_output_dir: typing.Optional[str] = None,
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
bigquery_destination: typing.Optional[str] = None,
args: typing.Optional[typing.List[typing.Union[str, float, int]]] = None,
environment_variables: typing.Optional[typing.Dict[str, str]] = None,
replica_count: int = 1,
machine_type: str = "n1-standard-4",
accelerator_type: str = "ACCELERATOR_TYPE_UNSPECIFIED",
accelerator_count: int = 0,
boot_disk_type: str = "pd-ssd",
boot_disk_size_gb: int = 100,
reduction_server_replica_count: int = 0,
reduction_server_machine_type: typing.Optional[str] = None,
reduction_server_container_uri: typing.Optional[str] = None,
training_fraction_split: typing.Optional[float] = None,
validation_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
training_filter_split: typing.Optional[str] = None,
validation_filter_split: typing.Optional[str] = None,
test_filter_split: typing.Optional[str] = None,
predefined_split_column_name: typing.Optional[str] = None,
timestamp_split_column_name: typing.Optional[str] = None,
timeout: typing.Optional[int] = None,
restart_job_on_worker_restart: bool = False,
enable_web_access: bool = False,
enable_dashboard_access: bool = False,
tensorboard: typing.Optional[str] = None,
sync=True,
create_request_timeout: typing.Optional[float] = None,
disable_retries: bool = False,
persistent_resource_id: typing.Optional[str] = None,
) -> typing.Optional[google.cloud.aiplatform.models.Model]
Submits the custom training job without blocking until completion.
See more: google.cloud.aiplatform.CustomContainerTrainingJob.submit
google.cloud.aiplatform.CustomContainerTrainingJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.CustomContainerTrainingJob.to_dict
google.cloud.aiplatform.CustomContainerTrainingJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.CustomContainerTrainingJob.wait
google.cloud.aiplatform.CustomContainerTrainingJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.CustomContainerTrainingJob.wait_for_resource_creation
google.cloud.aiplatform.CustomJob
CustomJob(
display_name: str,
worker_pool_specs: typing.Union[
typing.List[typing.Dict],
typing.List[google.cloud.aiplatform_v1.types.custom_job.WorkerPoolSpec],
],
base_output_dir: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
staging_bucket: typing.Optional[str] = None,
persistent_resource_id: typing.Optional[str] = None,
)
Constructs a Custom Job with Worker Pool Specs.
See more: google.cloud.aiplatform.CustomJob
google.cloud.aiplatform.CustomJob.cancel
cancel() -> None
Cancels this Job.
See more: google.cloud.aiplatform.CustomJob.cancel
google.cloud.aiplatform.CustomJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.CustomJob.delete
google.cloud.aiplatform.CustomJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.CustomJob.done
google.cloud.aiplatform.CustomJob.from_local_script
from_local_script(
display_name: str,
script_path: str,
container_uri: str,
enable_autolog: bool = False,
args: typing.Optional[typing.Sequence[str]] = None,
requirements: typing.Optional[typing.Sequence[str]] = None,
environment_variables: typing.Optional[typing.Dict[str, str]] = None,
replica_count: int = 1,
machine_type: str = "n1-standard-4",
accelerator_type: str = "ACCELERATOR_TYPE_UNSPECIFIED",
accelerator_count: int = 0,
boot_disk_type: str = "pd-ssd",
boot_disk_size_gb: int = 100,
reduction_server_replica_count: int = 0,
reduction_server_machine_type: typing.Optional[str] = None,
reduction_server_container_uri: typing.Optional[str] = None,
base_output_dir: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
staging_bucket: typing.Optional[str] = None,
persistent_resource_id: typing.Optional[str] = None,
) -> google.cloud.aiplatform.jobs.CustomJob
Configures a custom job from a local script.
See more: google.cloud.aiplatform.CustomJob.from_local_script
google.cloud.aiplatform.CustomJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.jobs._RunnableJob
Get a Vertex AI Job for the given resource_name.
See more: google.cloud.aiplatform.CustomJob.get
google.cloud.aiplatform.CustomJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Job Resource.
See more: google.cloud.aiplatform.CustomJob.list
google.cloud.aiplatform.CustomJob.run
run(
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
timeout: typing.Optional[int] = None,
restart_job_on_worker_restart: bool = False,
enable_web_access: bool = False,
experiment: typing.Optional[
typing.Union[
google.cloud.aiplatform.metadata.experiment_resources.Experiment, str
]
] = None,
experiment_run: typing.Optional[
typing.Union[
google.cloud.aiplatform.metadata.experiment_run_resource.ExperimentRun, str
]
] = None,
tensorboard: typing.Optional[str] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
disable_retries: bool = False,
persistent_resource_id: typing.Optional[str] = None,
) -> None
Run this configured CustomJob.
See more: google.cloud.aiplatform.CustomJob.run
google.cloud.aiplatform.CustomJob.submit
submit(
*,
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
timeout: typing.Optional[int] = None,
restart_job_on_worker_restart: bool = False,
enable_web_access: bool = False,
experiment: typing.Optional[
typing.Union[
google.cloud.aiplatform.metadata.experiment_resources.Experiment, str
]
] = None,
experiment_run: typing.Optional[
typing.Union[
google.cloud.aiplatform.metadata.experiment_run_resource.ExperimentRun, str
]
] = None,
tensorboard: typing.Optional[str] = None,
create_request_timeout: typing.Optional[float] = None,
disable_retries: bool = False,
persistent_resource_id: typing.Optional[str] = None
) -> None
Submit the configured CustomJob.
See more: google.cloud.aiplatform.CustomJob.submit
google.cloud.aiplatform.CustomJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.CustomJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.CustomJob.wait
google.cloud.aiplatform.CustomJob.wait_for_completion
wait_for_completion() -> None
Waits for job to complete.
See more: google.cloud.aiplatform.CustomJob.wait_for_completion
google.cloud.aiplatform.CustomJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.CustomJob.wait_for_resource_creation
google.cloud.aiplatform.CustomPythonPackageTrainingJob
CustomPythonPackageTrainingJob(
display_name: str,
python_package_gcs_uri: typing.Union[str, typing.List[str]],
python_module_name: str,
container_uri: str,
model_serving_container_image_uri: typing.Optional[str] = None,
model_serving_container_predict_route: typing.Optional[str] = None,
model_serving_container_health_route: typing.Optional[str] = None,
model_serving_container_command: typing.Optional[typing.Sequence[str]] = None,
model_serving_container_args: typing.Optional[typing.Sequence[str]] = None,
model_serving_container_environment_variables: typing.Optional[
typing.Dict[str, str]
] = None,
model_serving_container_ports: typing.Optional[typing.Sequence[int]] = None,
model_description: typing.Optional[str] = None,
model_instance_schema_uri: typing.Optional[str] = None,
model_parameters_schema_uri: typing.Optional[str] = None,
model_prediction_schema_uri: typing.Optional[str] = None,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
training_encryption_spec_key_name: typing.Optional[str] = None,
model_encryption_spec_key_name: typing.Optional[str] = None,
staging_bucket: typing.Optional[str] = None,
)
Constructs a Custom Training Job from a Python Package.
See more: google.cloud.aiplatform.CustomPythonPackageTrainingJob
google.cloud.aiplatform.CustomPythonPackageTrainingJob.cancel
cancel() -> None
Starts asynchronous cancellation on the TrainingJob.
See more: google.cloud.aiplatform.CustomPythonPackageTrainingJob.cancel
google.cloud.aiplatform.CustomPythonPackageTrainingJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.CustomPythonPackageTrainingJob.delete
google.cloud.aiplatform.CustomPythonPackageTrainingJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.CustomPythonPackageTrainingJob.done
google.cloud.aiplatform.CustomPythonPackageTrainingJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.training_jobs._TrainingJob
Get Training Job for the given resource_name.
See more: google.cloud.aiplatform.CustomPythonPackageTrainingJob.get
google.cloud.aiplatform.CustomPythonPackageTrainingJob.get_model
get_model(sync=True) -> google.cloud.aiplatform.models.Model
Vertex AI Model produced by this training, if one was produced.
See more: google.cloud.aiplatform.CustomPythonPackageTrainingJob.get_model
google.cloud.aiplatform.CustomPythonPackageTrainingJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this TrainingJob resource.
See more: google.cloud.aiplatform.CustomPythonPackageTrainingJob.list
google.cloud.aiplatform.CustomPythonPackageTrainingJob.run
run(
dataset: typing.Optional[
typing.Union[
google.cloud.aiplatform.datasets.image_dataset.ImageDataset,
google.cloud.aiplatform.datasets.tabular_dataset.TabularDataset,
google.cloud.aiplatform.datasets.text_dataset.TextDataset,
google.cloud.aiplatform.datasets.video_dataset.VideoDataset,
]
] = None,
annotation_schema_uri: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
base_output_dir: typing.Optional[str] = None,
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
bigquery_destination: typing.Optional[str] = None,
args: typing.Optional[typing.List[typing.Union[str, float, int]]] = None,
environment_variables: typing.Optional[typing.Dict[str, str]] = None,
replica_count: int = 1,
machine_type: str = "n1-standard-4",
accelerator_type: str = "ACCELERATOR_TYPE_UNSPECIFIED",
accelerator_count: int = 0,
boot_disk_type: str = "pd-ssd",
boot_disk_size_gb: int = 100,
reduction_server_replica_count: int = 0,
reduction_server_machine_type: typing.Optional[str] = None,
reduction_server_container_uri: typing.Optional[str] = None,
training_fraction_split: typing.Optional[float] = None,
validation_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
training_filter_split: typing.Optional[str] = None,
validation_filter_split: typing.Optional[str] = None,
test_filter_split: typing.Optional[str] = None,
predefined_split_column_name: typing.Optional[str] = None,
timestamp_split_column_name: typing.Optional[str] = None,
timeout: typing.Optional[int] = None,
restart_job_on_worker_restart: bool = False,
enable_web_access: bool = False,
enable_dashboard_access: bool = False,
tensorboard: typing.Optional[str] = None,
sync=True,
create_request_timeout: typing.Optional[float] = None,
disable_retries: bool = False,
persistent_resource_id: typing.Optional[str] = None,
) -> typing.Optional[google.cloud.aiplatform.models.Model]
Runs the custom training job.
See more: google.cloud.aiplatform.CustomPythonPackageTrainingJob.run
google.cloud.aiplatform.CustomPythonPackageTrainingJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.CustomPythonPackageTrainingJob.to_dict
google.cloud.aiplatform.CustomPythonPackageTrainingJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.CustomPythonPackageTrainingJob.wait
google.cloud.aiplatform.CustomPythonPackageTrainingJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.CustomPythonPackageTrainingJob.wait_for_resource_creation
google.cloud.aiplatform.CustomTrainingJob
CustomTrainingJob(
display_name: str,
script_path: str,
container_uri: str,
requirements: typing.Optional[typing.Sequence[str]] = None,
model_serving_container_image_uri: typing.Optional[str] = None,
model_serving_container_predict_route: typing.Optional[str] = None,
model_serving_container_health_route: typing.Optional[str] = None,
model_serving_container_command: typing.Optional[typing.Sequence[str]] = None,
model_serving_container_args: typing.Optional[typing.Sequence[str]] = None,
model_serving_container_environment_variables: typing.Optional[
typing.Dict[str, str]
] = None,
model_serving_container_ports: typing.Optional[typing.Sequence[int]] = None,
model_description: typing.Optional[str] = None,
model_instance_schema_uri: typing.Optional[str] = None,
model_parameters_schema_uri: typing.Optional[str] = None,
model_prediction_schema_uri: typing.Optional[str] = None,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
training_encryption_spec_key_name: typing.Optional[str] = None,
model_encryption_spec_key_name: typing.Optional[str] = None,
staging_bucket: typing.Optional[str] = None,
)
Constructs a Custom Training Job from a Python script.
google.cloud.aiplatform.CustomTrainingJob.cancel
cancel() -> None
Starts asynchronous cancellation on the TrainingJob.
google.cloud.aiplatform.CustomTrainingJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
google.cloud.aiplatform.CustomTrainingJob.done
done() -> bool
Method indicating whether a job has completed.
google.cloud.aiplatform.CustomTrainingJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.training_jobs._TrainingJob
Get Training Job for the given resource_name.
google.cloud.aiplatform.CustomTrainingJob.get_model
get_model(sync=True) -> google.cloud.aiplatform.models.Model
Vertex AI Model produced by this training, if one was produced.
See more: google.cloud.aiplatform.CustomTrainingJob.get_model
google.cloud.aiplatform.CustomTrainingJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this TrainingJob resource.
google.cloud.aiplatform.CustomTrainingJob.run
run(
dataset: typing.Optional[
typing.Union[
google.cloud.aiplatform.datasets.image_dataset.ImageDataset,
google.cloud.aiplatform.datasets.tabular_dataset.TabularDataset,
google.cloud.aiplatform.datasets.text_dataset.TextDataset,
google.cloud.aiplatform.datasets.video_dataset.VideoDataset,
]
] = None,
annotation_schema_uri: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
base_output_dir: typing.Optional[str] = None,
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
bigquery_destination: typing.Optional[str] = None,
args: typing.Optional[typing.List[typing.Union[str, float, int]]] = None,
environment_variables: typing.Optional[typing.Dict[str, str]] = None,
replica_count: int = 1,
machine_type: str = "n1-standard-4",
accelerator_type: str = "ACCELERATOR_TYPE_UNSPECIFIED",
accelerator_count: int = 0,
boot_disk_type: str = "pd-ssd",
boot_disk_size_gb: int = 100,
reduction_server_replica_count: int = 0,
reduction_server_machine_type: typing.Optional[str] = None,
reduction_server_container_uri: typing.Optional[str] = None,
training_fraction_split: typing.Optional[float] = None,
validation_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
training_filter_split: typing.Optional[str] = None,
validation_filter_split: typing.Optional[str] = None,
test_filter_split: typing.Optional[str] = None,
predefined_split_column_name: typing.Optional[str] = None,
timestamp_split_column_name: typing.Optional[str] = None,
timeout: typing.Optional[int] = None,
restart_job_on_worker_restart: bool = False,
enable_web_access: bool = False,
enable_dashboard_access: bool = False,
tensorboard: typing.Optional[str] = None,
sync=True,
create_request_timeout: typing.Optional[float] = None,
disable_retries: bool = False,
persistent_resource_id: typing.Optional[str] = None,
) -> typing.Optional[google.cloud.aiplatform.models.Model]
Runs the custom training job.
google.cloud.aiplatform.CustomTrainingJob.submit
submit(
dataset: typing.Optional[
typing.Union[
google.cloud.aiplatform.datasets.image_dataset.ImageDataset,
google.cloud.aiplatform.datasets.tabular_dataset.TabularDataset,
google.cloud.aiplatform.datasets.text_dataset.TextDataset,
google.cloud.aiplatform.datasets.video_dataset.VideoDataset,
]
] = None,
annotation_schema_uri: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
base_output_dir: typing.Optional[str] = None,
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
bigquery_destination: typing.Optional[str] = None,
args: typing.Optional[typing.List[typing.Union[str, float, int]]] = None,
environment_variables: typing.Optional[typing.Dict[str, str]] = None,
replica_count: int = 1,
machine_type: str = "n1-standard-4",
accelerator_type: str = "ACCELERATOR_TYPE_UNSPECIFIED",
accelerator_count: int = 0,
boot_disk_type: str = "pd-ssd",
boot_disk_size_gb: int = 100,
reduction_server_replica_count: int = 0,
reduction_server_machine_type: typing.Optional[str] = None,
reduction_server_container_uri: typing.Optional[str] = None,
training_fraction_split: typing.Optional[float] = None,
validation_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
training_filter_split: typing.Optional[str] = None,
validation_filter_split: typing.Optional[str] = None,
test_filter_split: typing.Optional[str] = None,
predefined_split_column_name: typing.Optional[str] = None,
timestamp_split_column_name: typing.Optional[str] = None,
timeout: typing.Optional[int] = None,
restart_job_on_worker_restart: bool = False,
enable_web_access: bool = False,
enable_dashboard_access: bool = False,
tensorboard: typing.Optional[str] = None,
sync=True,
create_request_timeout: typing.Optional[float] = None,
disable_retries: bool = False,
persistent_resource_id: typing.Optional[str] = None,
) -> typing.Optional[google.cloud.aiplatform.models.Model]
Submits the custom training job without blocking until completion.
google.cloud.aiplatform.CustomTrainingJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.CustomTrainingJob.wait
wait()
Helper method that blocks until all futures are complete.
google.cloud.aiplatform.CustomTrainingJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.CustomTrainingJob.wait_for_resource_creation
google.cloud.aiplatform.Endpoint.create
create(
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
encryption_spec_key_name: typing.Optional[str] = None,
sync=True,
create_request_timeout: typing.Optional[float] = None,
endpoint_id: typing.Optional[str] = None,
enable_request_response_logging=False,
request_response_logging_sampling_rate: typing.Optional[float] = None,
request_response_logging_bq_destination_table: typing.Optional[str] = None,
) -> google.cloud.aiplatform.models.Endpoint
Creates a new endpoint.
See more: google.cloud.aiplatform.Endpoint.create
google.cloud.aiplatform.Endpoint.delete
delete(force: bool = False, sync: bool = True) -> None
Deletes this Vertex AI Endpoint resource.
See more: google.cloud.aiplatform.Endpoint.delete
google.cloud.aiplatform.Endpoint.deploy
deploy(
model: google.cloud.aiplatform.models.Model,
deployed_model_display_name: typing.Optional[str] = None,
traffic_percentage: int = 0,
traffic_split: typing.Optional[typing.Dict[str, int]] = None,
machine_type: typing.Optional[str] = None,
min_replica_count: int = 1,
max_replica_count: int = 1,
accelerator_type: typing.Optional[str] = None,
accelerator_count: typing.Optional[int] = None,
tpu_topology: typing.Optional[str] = None,
service_account: typing.Optional[str] = None,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync=True,
deploy_request_timeout: typing.Optional[float] = None,
autoscaling_target_cpu_utilization: typing.Optional[int] = None,
autoscaling_target_accelerator_duty_cycle: typing.Optional[int] = None,
enable_access_logging=False,
disable_container_logging: bool = False,
) -> None
Deploys a Model to the Endpoint.
See more: google.cloud.aiplatform.Endpoint.deploy
google.cloud.aiplatform.Endpoint.explain
explain(
instances: typing.List[typing.Dict],
parameters: typing.Optional[typing.Dict] = None,
deployed_model_id: typing.Optional[str] = None,
timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.models.Prediction
Make a prediction with explanations against this Endpoint.
See more: google.cloud.aiplatform.Endpoint.explain
google.cloud.aiplatform.Endpoint.explain_async
explain_async(
instances: typing.List[typing.Dict],
*,
parameters: typing.Optional[typing.Dict] = None,
deployed_model_id: typing.Optional[str] = None,
timeout: typing.Optional[float] = None
) -> google.cloud.aiplatform.models.Prediction
Make a prediction with explanations against this Endpoint.
google.cloud.aiplatform.Endpoint.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.models.Endpoint]
List all Endpoint resource instances.
See more: google.cloud.aiplatform.Endpoint.list
google.cloud.aiplatform.Endpoint.list_models
list_models() -> (
typing.List[google.cloud.aiplatform_v1.types.endpoint.DeployedModel]
)
Returns a list of the models deployed to this Endpoint.
google.cloud.aiplatform.Endpoint.predict
predict(
instances: typing.List,
parameters: typing.Optional[typing.Dict] = None,
timeout: typing.Optional[float] = None,
use_raw_predict: typing.Optional[bool] = False,
) -> google.cloud.aiplatform.models.Prediction
Make a prediction against this Endpoint.
See more: google.cloud.aiplatform.Endpoint.predict
google.cloud.aiplatform.Endpoint.predict_async
predict_async(
instances: typing.List,
*,
parameters: typing.Optional[typing.Dict] = None,
timeout: typing.Optional[float] = None
) -> google.cloud.aiplatform.models.Prediction
Make an asynchronous prediction against this Endpoint.
google.cloud.aiplatform.Endpoint.raw_predict
raw_predict(
body: bytes, headers: typing.Dict[str, str]
) -> requests.models.Response
Makes a prediction request using arbitrary headers.
google.cloud.aiplatform.Endpoint.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.Endpoint.to_dict
google.cloud.aiplatform.Endpoint.undeploy
undeploy(
deployed_model_id: str,
traffic_split: typing.Optional[typing.Dict[str, int]] = None,
metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync=True,
) -> None
Undeploys a deployed model.
google.cloud.aiplatform.Endpoint.undeploy_all
undeploy_all(sync: bool = True) -> google.cloud.aiplatform.models.Endpoint
Undeploys every model deployed to this Endpoint.
google.cloud.aiplatform.Endpoint.update
update(
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
traffic_split: typing.Optional[typing.Dict[str, int]] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
update_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.models.Endpoint
Updates an endpoint.
See more: google.cloud.aiplatform.Endpoint.update
google.cloud.aiplatform.Endpoint.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.Endpoint.wait
google.cloud.aiplatform.EntityType
EntityType(
entity_type_name: str,
featurestore_id: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing managed entityType given an entityType resource name or an entity_type ID.
See more: google.cloud.aiplatform.EntityType
google.cloud.aiplatform.EntityType.batch_create_features
batch_create_features(
feature_configs: typing.Dict[
str, typing.Dict[str, typing.Union[bool, int, typing.Dict[str, str], str]]
],
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync: bool = True,
) -> google.cloud.aiplatform.featurestore._entity_type._EntityType
Batch creates Feature resources in this EntityType.
See more: google.cloud.aiplatform.EntityType.batch_create_features
google.cloud.aiplatform.EntityType.create
create(
entity_type_id: str,
featurestore_name: str,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.featurestore._entity_type._EntityType
Creates an EntityType resource in a Featurestore.
google.cloud.aiplatform.EntityType.create_feature
create_feature(
feature_id: str,
value_type: str,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.featurestore.feature.Feature
Creates a Feature resource in this EntityType.
google.cloud.aiplatform.EntityType.delete
delete(sync: bool = True, force: bool = False) -> None
Deletes this EntityType resource.
google.cloud.aiplatform.EntityType.delete_features
delete_features(feature_ids: typing.List[str], sync: bool = True) -> None
Deletes feature resources in this EntityType given their feature IDs.
See more: google.cloud.aiplatform.EntityType.delete_features
google.cloud.aiplatform.EntityType.get_feature
get_feature(
feature_id: str,
) -> google.cloud.aiplatform.featurestore.feature.Feature
Retrieves an existing managed feature in this EntityType.
google.cloud.aiplatform.EntityType.get_featurestore
get_featurestore() -> (
google.cloud.aiplatform.featurestore.featurestore.Featurestore
)
Retrieves the managed featurestore in which this EntityType is.
See more: google.cloud.aiplatform.EntityType.get_featurestore
google.cloud.aiplatform.EntityType.ingest_from_bq
ingest_from_bq(
feature_ids: typing.List[str],
feature_time: typing.Union[str, datetime.datetime],
bq_source_uri: str,
feature_source_fields: typing.Optional[typing.Dict[str, str]] = None,
entity_id_field: typing.Optional[str] = None,
disable_online_serving: typing.Optional[bool] = None,
worker_count: typing.Optional[int] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync: bool = True,
ingest_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.featurestore._entity_type._EntityType
Ingest feature values from BigQuery.
google.cloud.aiplatform.EntityType.ingest_from_df
ingest_from_df(
feature_ids: typing.List[str],
feature_time: typing.Union[str, datetime.datetime],
df_source: pd.DataFrame,
feature_source_fields: typing.Optional[typing.Dict[str, str]] = None,
entity_id_field: typing.Optional[str] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
ingest_request_timeout: typing.Optional[float] = None,
) -> _EntityType
Ingest feature values from DataFrame.
google.cloud.aiplatform.EntityType.ingest_from_gcs
ingest_from_gcs(
feature_ids: typing.List[str],
feature_time: typing.Union[str, datetime.datetime],
gcs_source_uris: typing.Union[str, typing.List[str]],
gcs_source_type: str,
feature_source_fields: typing.Optional[typing.Dict[str, str]] = None,
entity_id_field: typing.Optional[str] = None,
disable_online_serving: typing.Optional[bool] = None,
worker_count: typing.Optional[int] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync: bool = True,
ingest_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.featurestore._entity_type._EntityType
Ingest feature values from GCS.
See more: google.cloud.aiplatform.EntityType.ingest_from_gcs
google.cloud.aiplatform.EntityType.list
list(
featurestore_name: str,
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.featurestore._entity_type._EntityType]
Lists existing managed entityType resources in a featurestore, given a featurestore resource name or a featurestore ID.
See more: google.cloud.aiplatform.EntityType.list
google.cloud.aiplatform.EntityType.list_features
list_features(
filter: typing.Optional[str] = None, order_by: typing.Optional[str] = None
) -> typing.List[google.cloud.aiplatform.featurestore.feature.Feature]
Lists existing managed feature resources in this EntityType.
google.cloud.aiplatform.EntityType.read
read(
entity_ids: typing.Union[str, typing.List[str]],
feature_ids: typing.Union[str, typing.List[str]] = "*",
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
read_request_timeout: typing.Optional[float] = None,
) -> pd.DataFrame
Reads feature values for given feature IDs of given entity IDs in this EntityType.
See more: google.cloud.aiplatform.EntityType.read
google.cloud.aiplatform.EntityType.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.EntityType.update
update(
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
request_metadata: typing.Sequence[typing.Tuple[str, str]] = (),
update_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.featurestore._entity_type._EntityType
Updates an existing managed entityType resource.
google.cloud.aiplatform.EntityType.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.EntityType.wait
google.cloud.aiplatform.EntityType.write_feature_values
write_feature_values(
instances: typing.Union[
typing.List[
google.cloud.aiplatform_v1.types.featurestore_online_service.WriteFeatureValuesPayload
],
typing.Dict[
str,
typing.Dict[
str,
typing.Union[
int,
str,
float,
bool,
bytes,
typing.List[int],
typing.List[str],
typing.List[float],
typing.List[bool],
],
],
],
pd.DataFrame,
],
feature_time: typing.Union[str, datetime.datetime] = None,
) -> EntityType
Streaming ingestion.
See more: google.cloud.aiplatform.EntityType.write_feature_values
google.cloud.aiplatform.Execution
Execution(
execution_name: str,
*,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
)
Retrieves an existing Metadata Execution given a resource name or ID.
See more: google.cloud.aiplatform.Execution
google.cloud.aiplatform.Execution.assign_input_artifacts
assign_input_artifacts(
artifacts: typing.List[
typing.Union[
google.cloud.aiplatform.metadata.artifact.Artifact,
google.cloud.aiplatform.models.Model,
]
]
)
Assigns Artifacts as inputs to this Executions.
See more: google.cloud.aiplatform.Execution.assign_input_artifacts
google.cloud.aiplatform.Execution.assign_output_artifacts
assign_output_artifacts(
artifacts: typing.List[
typing.Union[
google.cloud.aiplatform.metadata.artifact.Artifact,
google.cloud.aiplatform.models.Model,
]
]
)
Assigns Artifacts as outputs to this Executions.
See more: google.cloud.aiplatform.Execution.assign_output_artifacts
google.cloud.aiplatform.Execution.create
create(
schema_title: str,
*,
state: google.cloud.aiplatform_v1.types.execution.Execution.State = State.RUNNING,
resource_id: typing.Optional[str] = None,
display_name: typing.Optional[str] = None,
schema_version: typing.Optional[str] = None,
metadata: typing.Optional[typing.Dict[str, typing.Any]] = None,
description: typing.Optional[str] = None,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials=typing.Optional[google.auth.credentials.Credentials]
) -> google.cloud.aiplatform.metadata.execution.Execution
Creates a new Metadata Execution.
See more: google.cloud.aiplatform.Execution.create
google.cloud.aiplatform.Execution.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.Execution.delete
google.cloud.aiplatform.Execution.get
get(
resource_id: str,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.metadata.resource._Resource
Retrieves a Metadata resource.
See more: google.cloud.aiplatform.Execution.get
google.cloud.aiplatform.Execution.get_input_artifacts
get_input_artifacts() -> (
typing.List[google.cloud.aiplatform.metadata.artifact.Artifact]
)
Get the input Artifacts of this Execution.
See more: google.cloud.aiplatform.Execution.get_input_artifacts
google.cloud.aiplatform.Execution.get_or_create
get_or_create(
resource_id: str,
schema_title: str,
display_name: typing.Optional[str] = None,
schema_version: typing.Optional[str] = None,
description: typing.Optional[str] = None,
metadata: typing.Optional[typing.Dict] = None,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.metadata.resource._Resource
Retrieves or Creates (if it does not exist) a Metadata resource.
google.cloud.aiplatform.Execution.get_output_artifacts
get_output_artifacts() -> (
typing.List[google.cloud.aiplatform.metadata.artifact.Artifact]
)
Get the output Artifacts of this Execution.
See more: google.cloud.aiplatform.Execution.get_output_artifacts
google.cloud.aiplatform.Execution.list
list(
filter: typing.Optional[str] = None,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
order_by: typing.Optional[str] = None,
) -> typing.List[google.cloud.aiplatform.metadata.resource._Resource]
List resources that match the list filter in target metadataStore.
See more: google.cloud.aiplatform.Execution.list
google.cloud.aiplatform.Execution.sync_resource
sync_resource()
Syncs local resource with the resource in metadata store.
google.cloud.aiplatform.Execution.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.Execution.update
update(
state: typing.Optional[
google.cloud.aiplatform_v1.types.execution.Execution.State
] = None,
description: typing.Optional[str] = None,
metadata: typing.Optional[typing.Dict[str, typing.Any]] = None,
)
Update this Execution.
See more: google.cloud.aiplatform.Execution.update
google.cloud.aiplatform.Execution.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.Execution.wait
google.cloud.aiplatform.Experiment
Experiment(
experiment_name: str,
*,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
)
my_experiment = aiplatform.Experiment('my-experiment')
.
See more: google.cloud.aiplatform.Experiment
google.cloud.aiplatform.Experiment.assign_backing_tensorboard
assign_backing_tensorboard(
tensorboard: typing.Union[
google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard, str
]
)
Assigns tensorboard as backing tensorboard to support time series metrics logging.
See more: google.cloud.aiplatform.Experiment.assign_backing_tensorboard
google.cloud.aiplatform.Experiment.create
create(
experiment_name: str,
*,
description: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.experiment_resources.Experiment
Creates a new experiment in Vertex AI Experiments.
google.cloud.aiplatform.Experiment.delete
delete(*, delete_backing_tensorboard_runs: bool = False)
Deletes this experiment all the experiment runs under this experiment.
google.cloud.aiplatform.Experiment.get
get(
experiment_name: str,
*,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> typing.Optional[google.cloud.aiplatform.metadata.experiment_resources.Experiment]
Gets experiment if one exists with this experiment_name in Vertex AI Experiments.
See more: google.cloud.aiplatform.Experiment.get
google.cloud.aiplatform.Experiment.get_backing_tensorboard_resource
get_backing_tensorboard_resource() -> (
typing.Optional[
google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard
]
)
Get the backing tensorboard for this experiment if one exists.
See more: google.cloud.aiplatform.Experiment.get_backing_tensorboard_resource
google.cloud.aiplatform.Experiment.get_data_frame
get_data_frame() -> pd.DataFrame
Get parameters, metrics, and time series metrics of all runs in this experiment as Dataframe.
google.cloud.aiplatform.Experiment.get_or_create
get_or_create(
experiment_name: str,
*,
description: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.experiment_resources.Experiment
Gets experiment if one exists with this experiment_name in Vertex AI Experiments.
google.cloud.aiplatform.Experiment.list
list(
*,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> typing.List[google.cloud.aiplatform.metadata.experiment_resources.Experiment]
List all Vertex AI Experiments in the given project.
See more: google.cloud.aiplatform.Experiment.list
google.cloud.aiplatform.ExperimentRun
ExperimentRun(
run_name: str,
experiment: typing.Union[
google.cloud.aiplatform.metadata.experiment_resources.Experiment, str
],
*,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
)
my_run = aiplatform.ExperimentRun('my-run', experiment='my-experiment')
.
See more: google.cloud.aiplatform.ExperimentRun
google.cloud.aiplatform.ExperimentRun.__init_subclass__
__init_subclass__(
*,
experiment_loggable_schemas: typing.Tuple[
google.cloud.aiplatform.metadata.experiment_resources._ExperimentLoggableSchema
],
**kwargs
)
Register the metadata_schema for the subclass so Experiment can use it to retrieve the associated types.
See more: google.cloud.aiplatform.ExperimentRun.init_subclass
google.cloud.aiplatform.ExperimentRun.assign_backing_tensorboard
assign_backing_tensorboard(
tensorboard: typing.Union[
google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard, str
]
)
Assigns tensorboard as backing tensorboard to support timeseries metrics logging for this run.
See more: google.cloud.aiplatform.ExperimentRun.assign_backing_tensorboard
google.cloud.aiplatform.ExperimentRun.associate_execution
associate_execution(
execution: google.cloud.aiplatform.metadata.execution.Execution,
)
Associate an execution to this experiment run.
See more: google.cloud.aiplatform.ExperimentRun.associate_execution
google.cloud.aiplatform.ExperimentRun.create
create(
run_name: str,
*,
experiment: typing.Optional[
typing.Union[
google.cloud.aiplatform.metadata.experiment_resources.Experiment, str
]
] = None,
tensorboard: typing.Optional[
typing.Union[
google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard, str
]
] = None,
state: google.cloud.aiplatform_v1.types.execution.Execution.State = State.RUNNING,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.experiment_run_resource.ExperimentRun
Creates a new experiment run in Vertex AI Experiments.
google.cloud.aiplatform.ExperimentRun.delete
delete(*, delete_backing_tensorboard_run: bool = False)
Deletes this experiment run.
google.cloud.aiplatform.ExperimentRun.end_run
end_run(
*,
state: google.cloud.aiplatform_v1.types.execution.Execution.State = State.COMPLETE
)
Ends this experiment run and sets state to COMPLETE.
google.cloud.aiplatform.ExperimentRun.get
get(
run_name: str,
*,
experiment: typing.Optional[
typing.Union[
google.cloud.aiplatform.metadata.experiment_resources.Experiment, str
]
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> typing.Optional[
google.cloud.aiplatform.metadata.experiment_run_resource.ExperimentRun
]
Gets experiment run if one exists with this run_name.
google.cloud.aiplatform.ExperimentRun.get_artifacts
get_artifacts() -> typing.List[google.cloud.aiplatform.metadata.artifact.Artifact]
Get the list of artifacts associated to this run.
See more: google.cloud.aiplatform.ExperimentRun.get_artifacts
google.cloud.aiplatform.ExperimentRun.get_classification_metrics
get_classification_metrics() -> (
typing.List[typing.Dict[str, typing.Union[str, typing.List]]]
)
Get all the classification metrics logged to this run.
See more: google.cloud.aiplatform.ExperimentRun.get_classification_metrics
google.cloud.aiplatform.ExperimentRun.get_executions
get_executions() -> (
typing.List[google.cloud.aiplatform.metadata.execution.Execution]
)
Get the List of Executions associated to this run .
See more: google.cloud.aiplatform.ExperimentRun.get_executions
google.cloud.aiplatform.ExperimentRun.get_experiment_models
get_experiment_models() -> (
typing.List[
google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel
]
)
Get all ExperimentModel associated to this experiment run.
See more: google.cloud.aiplatform.ExperimentRun.get_experiment_models
google.cloud.aiplatform.ExperimentRun.get_logged_custom_jobs
get_logged_custom_jobs() -> typing.List[google.cloud.aiplatform.jobs.CustomJob]
Get all CustomJobs associated to this experiment run.
See more: google.cloud.aiplatform.ExperimentRun.get_logged_custom_jobs
google.cloud.aiplatform.ExperimentRun.get_logged_pipeline_jobs
get_logged_pipeline_jobs() -> (
typing.List[google.cloud.aiplatform.pipeline_jobs.PipelineJob]
)
Get all PipelineJobs associated to this experiment run.
See more: google.cloud.aiplatform.ExperimentRun.get_logged_pipeline_jobs
google.cloud.aiplatform.ExperimentRun.get_metrics
get_metrics() -> typing.Dict[str, typing.Union[float, int, str]]
Get the summary metrics logged to this run.
google.cloud.aiplatform.ExperimentRun.get_params
get_params() -> typing.Dict[str, typing.Union[float, int, str]]
Get the parameters logged to this run.
google.cloud.aiplatform.ExperimentRun.get_state
get_state() -> google.cloud.aiplatform_v1.types.execution.Execution.State
The state of this run.
google.cloud.aiplatform.ExperimentRun.get_time_series_data_frame
get_time_series_data_frame() -> pd.DataFrame
Returns all time series in this Run as a DataFrame.
See more: google.cloud.aiplatform.ExperimentRun.get_time_series_data_frame
google.cloud.aiplatform.ExperimentRun.list
list(
*,
experiment: typing.Optional[
typing.Union[
google.cloud.aiplatform.metadata.experiment_resources.Experiment, str
]
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> typing.List[
google.cloud.aiplatform.metadata.experiment_run_resource.ExperimentRun
]
List the experiment runs for a given aiplatform.Experiment.
google.cloud.aiplatform.ExperimentRun.log
log(
*,
pipeline_job: typing.Optional[
google.cloud.aiplatform.pipeline_jobs.PipelineJob
] = None
)
Log a Vertex Resource to this experiment run.
google.cloud.aiplatform.ExperimentRun.log_classification_metrics
log_classification_metrics(
*,
labels: typing.Optional[typing.List[str]] = None,
matrix: typing.Optional[typing.List[typing.List[int]]] = None,
fpr: typing.Optional[typing.List[float]] = None,
tpr: typing.Optional[typing.List[float]] = None,
threshold: typing.Optional[typing.List[float]] = None,
display_name: typing.Optional[str] = None
) -> (
google.cloud.aiplatform.metadata.schema.google.artifact_schema.ClassificationMetrics
)
Create an artifact for classification metrics and log to ExperimentRun.
See more: google.cloud.aiplatform.ExperimentRun.log_classification_metrics
google.cloud.aiplatform.ExperimentRun.log_metrics
log_metrics(metrics: typing.Dict[str, typing.Union[float, int, str]])
Log single or multiple Metrics with specified key and value pairs.
google.cloud.aiplatform.ExperimentRun.log_model
log_model(
model: typing.Union[sklearn.base.BaseEstimator, xgb.Booster, tf.Module],
artifact_id: typing.Optional[str] = None,
*,
uri: typing.Optional[str] = None,
input_example: typing.Union[list, dict, pd.DataFrame, np.ndarray] = None,
display_name: typing.Optional[str] = None,
metadata_store_id: typing.Optional[str] = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel
Saves a ML model into a MLMD artifact and log it to this ExperimentRun.
google.cloud.aiplatform.ExperimentRun.log_params
log_params(params: typing.Dict[str, typing.Union[float, int, str]])
Log single or multiple parameters with specified key value pairs.
google.cloud.aiplatform.ExperimentRun.log_time_series_metrics
log_time_series_metrics(
metrics: typing.Dict[str, float],
step: typing.Optional[int] = None,
wall_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
)
Logs time series metrics to backing TensorboardRun of this Experiment Run.
See more: google.cloud.aiplatform.ExperimentRun.log_time_series_metrics
google.cloud.aiplatform.ExperimentRun.update_state
update_state(state: google.cloud.aiplatform_v1.types.execution.Execution.State)
Update the state of this experiment run.
See more: google.cloud.aiplatform.ExperimentRun.update_state
google.cloud.aiplatform.Feature
Feature(
feature_name: str,
featurestore_id: typing.Optional[str] = None,
entity_type_id: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing managed feature given a feature resource name or a feature ID.
See more: google.cloud.aiplatform.Feature
google.cloud.aiplatform.Feature.create
create(
feature_id: str,
value_type: str,
entity_type_name: str,
featurestore_id: typing.Optional[str] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.featurestore.feature.Feature
Creates a Feature resource in an EntityType.
See more: google.cloud.aiplatform.Feature.create
google.cloud.aiplatform.Feature.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.Feature.delete
google.cloud.aiplatform.Feature.get_entity_type
get_entity_type() -> google.cloud.aiplatform.featurestore.entity_type.EntityType
Retrieves the managed entityType in which this Feature is.
google.cloud.aiplatform.Feature.get_featurestore
get_featurestore() -> (
google.cloud.aiplatform.featurestore.featurestore.Featurestore
)
Retrieves the managed featurestore in which this Feature is.
google.cloud.aiplatform.Feature.list
list(
entity_type_name: str,
featurestore_id: typing.Optional[str] = None,
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.featurestore.feature.Feature]
Lists existing managed feature resources in an entityType, given an entityType resource name or an entity_type ID.
See more: google.cloud.aiplatform.Feature.list
google.cloud.aiplatform.Feature.search
search(
query: typing.Optional[str] = None,
page_size: typing.Optional[int] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.featurestore.feature.Feature]
Searches existing managed Feature resources.
See more: google.cloud.aiplatform.Feature.search
google.cloud.aiplatform.Feature.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.Feature.to_dict
google.cloud.aiplatform.Feature.update
update(
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
update_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.featurestore.feature.Feature
Updates an existing managed feature resource.
See more: google.cloud.aiplatform.Feature.update
google.cloud.aiplatform.Feature.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.Feature.wait
google.cloud.aiplatform.Featurestore
Featurestore(
featurestore_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing managed featurestore given a featurestore resource name or a featurestore ID.
See more: google.cloud.aiplatform.Featurestore
google.cloud.aiplatform.Featurestore.batch_serve_to_bq
batch_serve_to_bq(
bq_destination_output_uri: str,
serving_feature_ids: typing.Dict[str, typing.List[str]],
read_instances_uri: str,
pass_through_fields: typing.Optional[typing.List[str]] = None,
feature_destination_fields: typing.Optional[typing.Dict[str, str]] = None,
start_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
serve_request_timeout: typing.Optional[float] = None,
sync: bool = True,
) -> google.cloud.aiplatform.featurestore.featurestore.Featurestore
Batch serves feature values to BigQuery destination .
See more: google.cloud.aiplatform.Featurestore.batch_serve_to_bq
google.cloud.aiplatform.Featurestore.batch_serve_to_df
batch_serve_to_df(
serving_feature_ids: typing.Dict[str, typing.List[str]],
read_instances_df: pd.DataFrame,
pass_through_fields: typing.Optional[typing.List[str]] = None,
feature_destination_fields: typing.Optional[typing.Dict[str, str]] = None,
start_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
serve_request_timeout: typing.Optional[float] = None,
bq_dataset_id: typing.Optional[str] = None,
) -> pd.DataFrame
Batch serves feature values to pandas DataFrame.
See more: google.cloud.aiplatform.Featurestore.batch_serve_to_df
google.cloud.aiplatform.Featurestore.batch_serve_to_gcs
batch_serve_to_gcs(
gcs_destination_output_uri_prefix: str,
gcs_destination_type: str,
serving_feature_ids: typing.Dict[str, typing.List[str]],
read_instances_uri: str,
pass_through_fields: typing.Optional[typing.List[str]] = None,
feature_destination_fields: typing.Optional[typing.Dict[str, str]] = None,
start_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync: bool = True,
serve_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.featurestore.featurestore.Featurestore
Batch serves feature values to GCS destination .
See more: google.cloud.aiplatform.Featurestore.batch_serve_to_gcs
google.cloud.aiplatform.Featurestore.create
create(
featurestore_id: str,
online_store_fixed_node_count: typing.Optional[int] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
encryption_spec_key_name: typing.Optional[str] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.featurestore.featurestore.Featurestore
Creates a Featurestore resource.
google.cloud.aiplatform.Featurestore.create_entity_type
create_entity_type(
entity_type_id: str,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.featurestore.entity_type.EntityType
Creates an EntityType resource in this Featurestore.
See more: google.cloud.aiplatform.Featurestore.create_entity_type
google.cloud.aiplatform.Featurestore.delete
delete(sync: bool = True, force: bool = False) -> None
Deletes this Featurestore resource.
google.cloud.aiplatform.Featurestore.delete_entity_types
delete_entity_types(
entity_type_ids: typing.List[str], sync: bool = True, force: bool = False
) -> None
Deletes entity_type resources in this Featurestore given their entity_type IDs.
See more: google.cloud.aiplatform.Featurestore.delete_entity_types
google.cloud.aiplatform.Featurestore.get_entity_type
get_entity_type(
entity_type_id: str,
) -> google.cloud.aiplatform.featurestore.entity_type.EntityType
Retrieves an existing managed entityType in this Featurestore.
See more: google.cloud.aiplatform.Featurestore.get_entity_type
google.cloud.aiplatform.Featurestore.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
parent: typing.Optional[str] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Vertex AI Resource.
google.cloud.aiplatform.Featurestore.list_entity_types
list_entity_types(
filter: typing.Optional[str] = None, order_by: typing.Optional[str] = None
) -> typing.List[google.cloud.aiplatform.featurestore.entity_type.EntityType]
Lists existing managed entityType resources in this Featurestore.
See more: google.cloud.aiplatform.Featurestore.list_entity_types
google.cloud.aiplatform.Featurestore.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.Featurestore.update
update(
labels: typing.Optional[typing.Dict[str, str]] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
update_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.featurestore.featurestore.Featurestore
Updates an existing managed featurestore resource.
google.cloud.aiplatform.Featurestore.update_online_store
update_online_store(
fixed_node_count: int,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
update_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.featurestore.featurestore.Featurestore
Updates the online store of an existing managed featurestore resource.
See more: google.cloud.aiplatform.Featurestore.update_online_store
google.cloud.aiplatform.Featurestore.wait
wait()
Helper method that blocks until all futures are complete.
google.cloud.aiplatform.HyperparameterTuningJob
HyperparameterTuningJob(
display_name: str,
custom_job: google.cloud.aiplatform.jobs.CustomJob,
metric_spec: typing.Dict[str, str],
parameter_spec: typing.Dict[
str, google.cloud.aiplatform.hyperparameter_tuning._ParameterSpec
],
max_trial_count: int,
parallel_trial_count: int,
max_failed_trial_count: int = 0,
search_algorithm: typing.Optional[str] = None,
measurement_selection: typing.Optional[str] = "best",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
)
Configures a HyperparameterTuning Job.
google.cloud.aiplatform.HyperparameterTuningJob.cancel
cancel() -> None
Cancels this Job.
See more: google.cloud.aiplatform.HyperparameterTuningJob.cancel
google.cloud.aiplatform.HyperparameterTuningJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.HyperparameterTuningJob.delete
google.cloud.aiplatform.HyperparameterTuningJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.HyperparameterTuningJob.done
google.cloud.aiplatform.HyperparameterTuningJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.jobs._RunnableJob
Get a Vertex AI Job for the given resource_name.
See more: google.cloud.aiplatform.HyperparameterTuningJob.get
google.cloud.aiplatform.HyperparameterTuningJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Job Resource.
See more: google.cloud.aiplatform.HyperparameterTuningJob.list
google.cloud.aiplatform.HyperparameterTuningJob.run
run(
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
timeout: typing.Optional[int] = None,
restart_job_on_worker_restart: bool = False,
enable_web_access: bool = False,
tensorboard: typing.Optional[str] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
disable_retries: bool = False,
) -> None
Run this configured CustomJob.
See more: google.cloud.aiplatform.HyperparameterTuningJob.run
google.cloud.aiplatform.HyperparameterTuningJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.HyperparameterTuningJob.to_dict
google.cloud.aiplatform.HyperparameterTuningJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.HyperparameterTuningJob.wait
google.cloud.aiplatform.HyperparameterTuningJob.wait_for_completion
wait_for_completion() -> None
Waits for job to complete.
See more: google.cloud.aiplatform.HyperparameterTuningJob.wait_for_completion
google.cloud.aiplatform.HyperparameterTuningJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.HyperparameterTuningJob.wait_for_resource_creation
google.cloud.aiplatform.ImageDataset
ImageDataset(
dataset_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing managed dataset given a dataset name or ID.
See more: google.cloud.aiplatform.ImageDataset
google.cloud.aiplatform.ImageDataset.create
create(
display_name: typing.Optional[str] = None,
gcs_source: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
import_schema_uri: typing.Optional[str] = None,
data_item_labels: typing.Optional[typing.Dict] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.datasets.image_dataset.ImageDataset
Creates a new image dataset.
google.cloud.aiplatform.ImageDataset.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
google.cloud.aiplatform.ImageDataset.export_data
export_data(output_dir: str) -> typing.Sequence[str]
Exports data to output dir to GCS.
google.cloud.aiplatform.ImageDataset.export_data_for_custom_training
export_data_for_custom_training(
output_dir: str,
annotation_filter: typing.Optional[str] = None,
saved_query_id: typing.Optional[str] = None,
annotation_schema_uri: typing.Optional[str] = None,
split: typing.Optional[
typing.Union[typing.Dict[str, str], typing.Dict[str, float]]
] = None,
) -> typing.Dict[str, typing.Any]
Exports data to output dir to GCS for custom training use case.
See more: google.cloud.aiplatform.ImageDataset.export_data_for_custom_training
google.cloud.aiplatform.ImageDataset.import_data
import_data(
gcs_source: typing.Union[str, typing.Sequence[str]],
import_schema_uri: str,
data_item_labels: typing.Optional[typing.Dict] = None,
sync: bool = True,
import_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.datasets.dataset._Dataset
Upload data to existing managed dataset.
google.cloud.aiplatform.ImageDataset.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Dataset resource.
google.cloud.aiplatform.ImageDataset.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.ImageDataset.update
update(
*,
display_name: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
description: typing.Optional[str] = None,
update_request_timeout: typing.Optional[float] = None
) -> google.cloud.aiplatform.datasets.dataset._Dataset
Update the dataset.
google.cloud.aiplatform.ImageDataset.wait
wait()
Helper method that blocks until all futures are complete.
google.cloud.aiplatform.MatchingEngineIndex
MatchingEngineIndex(
index_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing index given an index name or ID.
google.cloud.aiplatform.MatchingEngineIndex.create_brute_force_index
create_brute_force_index(
display_name: str,
contents_delta_uri: typing.Optional[str] = None,
dimensions: typing.Optional[int] = None,
distance_measure_type: typing.Optional[
google.cloud.aiplatform.matching_engine.matching_engine_index_config.DistanceMeasureType
] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync: bool = True,
index_update_method: typing.Optional[str] = None,
encryption_spec_key_name: typing.Optional[str] = None,
create_request_timeout: typing.Optional[float] = None,
shard_size: typing.Optional[str] = None,
) -> google.cloud.aiplatform.matching_engine.matching_engine_index.MatchingEngineIndex
Creates a MatchingEngineIndex resource that uses the brute force algorithm.
See more: google.cloud.aiplatform.MatchingEngineIndex.create_brute_force_index
google.cloud.aiplatform.MatchingEngineIndex.create_tree_ah_index
create_tree_ah_index(
display_name: str,
contents_delta_uri: typing.Optional[str] = None,
dimensions: typing.Optional[int] = None,
approximate_neighbors_count: typing.Optional[int] = None,
leaf_node_embedding_count: typing.Optional[int] = None,
leaf_nodes_to_search_percent: typing.Optional[float] = None,
distance_measure_type: typing.Optional[
google.cloud.aiplatform.matching_engine.matching_engine_index_config.DistanceMeasureType
] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync: bool = True,
index_update_method: typing.Optional[str] = None,
encryption_spec_key_name: typing.Optional[str] = None,
create_request_timeout: typing.Optional[float] = None,
shard_size: typing.Optional[str] = None,
) -> google.cloud.aiplatform.matching_engine.matching_engine_index.MatchingEngineIndex
Creates a MatchingEngineIndex resource that uses the tree-AH algorithm.
See more: google.cloud.aiplatform.MatchingEngineIndex.create_tree_ah_index
google.cloud.aiplatform.MatchingEngineIndex.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.MatchingEngineIndex.delete
google.cloud.aiplatform.MatchingEngineIndex.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
parent: typing.Optional[str] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Vertex AI Resource.
google.cloud.aiplatform.MatchingEngineIndex.remove_datapoints
remove_datapoints(
datapoint_ids: typing.Sequence[str],
) -> google.cloud.aiplatform.matching_engine.matching_engine_index.MatchingEngineIndex
Remove datapoints for this index.
See more: google.cloud.aiplatform.MatchingEngineIndex.remove_datapoints
google.cloud.aiplatform.MatchingEngineIndex.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.MatchingEngineIndex.to_dict
google.cloud.aiplatform.MatchingEngineIndex.update_embeddings
update_embeddings(
contents_delta_uri: str,
is_complete_overwrite: typing.Optional[bool] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
update_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.matching_engine.matching_engine_index.MatchingEngineIndex
Updates the embeddings for this index.
See more: google.cloud.aiplatform.MatchingEngineIndex.update_embeddings
google.cloud.aiplatform.MatchingEngineIndex.update_metadata
update_metadata(
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
update_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.matching_engine.matching_engine_index.MatchingEngineIndex
Updates the metadata for this index.
See more: google.cloud.aiplatform.MatchingEngineIndex.update_metadata
google.cloud.aiplatform.MatchingEngineIndex.upsert_datapoints
upsert_datapoints(
datapoints: typing.Sequence[google.cloud.aiplatform_v1.types.index.IndexDatapoint],
update_mask: typing.Optional[typing.Sequence[str]] = None,
) -> google.cloud.aiplatform.matching_engine.matching_engine_index.MatchingEngineIndex
Upsert datapoints to this index.
See more: google.cloud.aiplatform.MatchingEngineIndex.upsert_datapoints
google.cloud.aiplatform.MatchingEngineIndex.wait
wait()
Helper method that blocks until all futures are complete.
google.cloud.aiplatform.MatchingEngineIndexEndpoint
MatchingEngineIndexEndpoint(
index_endpoint_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing index endpoint given a name or ID.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint
google.cloud.aiplatform.MatchingEngineIndexEndpoint.create
create(
display_name: str,
network: typing.Optional[str] = None,
public_endpoint_enabled: bool = False,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync: bool = True,
enable_private_service_connect: bool = False,
project_allowlist: typing.Optional[typing.Sequence[str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
create_request_timeout: typing.Optional[float] = None,
) -> (
google.cloud.aiplatform.matching_engine.matching_engine_index_endpoint.MatchingEngineIndexEndpoint
)
Creates a MatchingEngineIndexEndpoint resource.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.create
google.cloud.aiplatform.MatchingEngineIndexEndpoint.delete
delete(force: bool = False, sync: bool = True) -> None
Deletes this MatchingEngineIndexEndpoint resource.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.delete
google.cloud.aiplatform.MatchingEngineIndexEndpoint.deploy_index
deploy_index(
index: google.cloud.aiplatform.matching_engine.matching_engine_index.MatchingEngineIndex,
deployed_index_id: str,
display_name: typing.Optional[str] = None,
machine_type: typing.Optional[str] = None,
min_replica_count: typing.Optional[int] = None,
max_replica_count: typing.Optional[int] = None,
enable_access_logging: typing.Optional[bool] = None,
reserved_ip_ranges: typing.Optional[typing.Sequence[str]] = None,
deployment_group: typing.Optional[str] = None,
auth_config_audiences: typing.Optional[typing.Sequence[str]] = None,
auth_config_allowed_issuers: typing.Optional[typing.Sequence[str]] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
deploy_request_timeout: typing.Optional[float] = None,
) -> (
google.cloud.aiplatform.matching_engine.matching_engine_index_endpoint.MatchingEngineIndexEndpoint
)
Deploys an existing index resource to this endpoint resource.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.deploy_index
google.cloud.aiplatform.MatchingEngineIndexEndpoint.find_neighbors
find_neighbors(
*,
deployed_index_id: str,
queries: typing.Optional[typing.List[typing.List[float]]] = None,
num_neighbors: int = 10,
filter: typing.Optional[
typing.List[
google.cloud.aiplatform.matching_engine.matching_engine_index_endpoint.Namespace
]
] = None,
per_crowding_attribute_neighbor_count: typing.Optional[int] = None,
approx_num_neighbors: typing.Optional[int] = None,
fraction_leaf_nodes_to_search_override: typing.Optional[float] = None,
return_full_datapoint: bool = False,
numeric_filter: typing.Optional[
typing.List[
google.cloud.aiplatform.matching_engine.matching_engine_index_endpoint.NumericNamespace
]
] = None,
embedding_ids: typing.Optional[typing.List[str]] = None
) -> typing.List[
typing.List[
google.cloud.aiplatform.matching_engine.matching_engine_index_endpoint.MatchNeighbor
]
]
Retrieves nearest neighbors for the given embedding queries on the specified deployed index which is deployed to either public or private endpoint.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.find_neighbors
google.cloud.aiplatform.MatchingEngineIndexEndpoint.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
parent: typing.Optional[str] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Vertex AI Resource.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.list
google.cloud.aiplatform.MatchingEngineIndexEndpoint.match
match(
deployed_index_id: str,
queries: typing.Optional[typing.List[typing.List[float]]] = None,
num_neighbors: int = 1,
filter: typing.Optional[
typing.List[
google.cloud.aiplatform.matching_engine.matching_engine_index_endpoint.Namespace
]
] = None,
per_crowding_attribute_num_neighbors: typing.Optional[int] = None,
approx_num_neighbors: typing.Optional[int] = None,
fraction_leaf_nodes_to_search_override: typing.Optional[float] = None,
low_level_batch_size: int = 0,
numeric_filter: typing.Optional[
typing.List[
google.cloud.aiplatform.matching_engine.matching_engine_index_endpoint.NumericNamespace
]
] = None,
) -> typing.List[
typing.List[
google.cloud.aiplatform.matching_engine.matching_engine_index_endpoint.MatchNeighbor
]
]
Retrieves nearest neighbors for the given embedding queries on the specified deployed index for private endpoint only.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.match
google.cloud.aiplatform.MatchingEngineIndexEndpoint.mutate_deployed_index
mutate_deployed_index(
deployed_index_id: str,
min_replica_count: int = 1,
max_replica_count: int = 1,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
mutate_request_timeout: typing.Optional[float] = None,
)
Updates an existing deployed index under this endpoint resource.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.mutate_deployed_index
google.cloud.aiplatform.MatchingEngineIndexEndpoint.read_index_datapoints
read_index_datapoints(
*, deployed_index_id: str, ids: typing.List[str] = []
) -> typing.List[google.cloud.aiplatform_v1beta1.types.index.IndexDatapoint]
Reads the datapoints/vectors of the given IDs on the specified deployed index which is deployed to public or private endpoint.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.read_index_datapoints
google.cloud.aiplatform.MatchingEngineIndexEndpoint.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.to_dict
google.cloud.aiplatform.MatchingEngineIndexEndpoint.undeploy_all
undeploy_all(
sync: bool = True,
) -> (
google.cloud.aiplatform.matching_engine.matching_engine_index_endpoint.MatchingEngineIndexEndpoint
)
Undeploys every index deployed to this MatchingEngineIndexEndpoint.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.undeploy_all
google.cloud.aiplatform.MatchingEngineIndexEndpoint.undeploy_index
undeploy_index(
deployed_index_id: str,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
undeploy_request_timeout: typing.Optional[float] = None,
) -> (
google.cloud.aiplatform.matching_engine.matching_engine_index_endpoint.MatchingEngineIndexEndpoint
)
Undeploy a deployed index endpoint resource.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.undeploy_index
google.cloud.aiplatform.MatchingEngineIndexEndpoint.update
update(
display_name: str,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
update_request_timeout: typing.Optional[float] = None,
) -> (
google.cloud.aiplatform.matching_engine.matching_engine_index_endpoint.MatchingEngineIndexEndpoint
)
Updates an existing index endpoint resource.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.update
google.cloud.aiplatform.MatchingEngineIndexEndpoint.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.MatchingEngineIndexEndpoint.wait
google.cloud.aiplatform.Model.batch_predict
batch_predict(
job_display_name: typing.Optional[str] = None,
gcs_source: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
bigquery_source: typing.Optional[str] = None,
instances_format: str = "jsonl",
gcs_destination_prefix: typing.Optional[str] = None,
bigquery_destination_prefix: typing.Optional[str] = None,
predictions_format: str = "jsonl",
model_parameters: typing.Optional[typing.Dict] = None,
machine_type: typing.Optional[str] = None,
accelerator_type: typing.Optional[str] = None,
accelerator_count: typing.Optional[int] = None,
starting_replica_count: typing.Optional[int] = None,
max_replica_count: typing.Optional[int] = None,
generate_explanation: typing.Optional[bool] = False,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
encryption_spec_key_name: typing.Optional[str] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
batch_size: typing.Optional[int] = None,
service_account: typing.Optional[str] = None,
) -> google.cloud.aiplatform.jobs.BatchPredictionJob
Creates a batch prediction job using this Model and outputs
prediction results to the provided destination prefix in the specified
predictions_format
.
google.cloud.aiplatform.Model.copy
copy(
destination_location: str,
destination_model_id: typing.Optional[str] = None,
destination_parent_model: typing.Optional[str] = None,
encryption_spec_key_name: typing.Optional[str] = None,
copy_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.models.Model
Copys a model and returns a Model representing the copied Model resource.
See more: google.cloud.aiplatform.Model.copy
google.cloud.aiplatform.Model.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.Model.delete
google.cloud.aiplatform.Model.deploy
deploy(
endpoint: typing.Optional[
typing.Union[
google.cloud.aiplatform.models.Endpoint,
google.cloud.aiplatform.models.PrivateEndpoint,
]
] = None,
deployed_model_display_name: typing.Optional[str] = None,
traffic_percentage: typing.Optional[int] = 0,
traffic_split: typing.Optional[typing.Dict[str, int]] = None,
machine_type: typing.Optional[str] = None,
min_replica_count: int = 1,
max_replica_count: int = 1,
accelerator_type: typing.Optional[str] = None,
accelerator_count: typing.Optional[int] = None,
tpu_topology: typing.Optional[str] = None,
service_account: typing.Optional[str] = None,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
encryption_spec_key_name: typing.Optional[str] = None,
network: typing.Optional[str] = None,
sync=True,
deploy_request_timeout: typing.Optional[float] = None,
autoscaling_target_cpu_utilization: typing.Optional[int] = None,
autoscaling_target_accelerator_duty_cycle: typing.Optional[int] = None,
enable_access_logging=False,
disable_container_logging: bool = False,
) -> typing.Union[
google.cloud.aiplatform.models.Endpoint,
google.cloud.aiplatform.models.PrivateEndpoint,
]
Deploys model to endpoint.
See more: google.cloud.aiplatform.Model.deploy
google.cloud.aiplatform.Model.evaluate
evaluate(
prediction_type: str,
target_field_name: str,
gcs_source_uris: typing.Optional[typing.List[str]] = None,
bigquery_source_uri: typing.Optional[str] = None,
bigquery_destination_output_uri: typing.Optional[str] = None,
class_labels: typing.Optional[typing.List[str]] = None,
prediction_label_column: typing.Optional[str] = None,
prediction_score_column: typing.Optional[str] = None,
staging_bucket: typing.Optional[str] = None,
service_account: typing.Optional[str] = None,
generate_feature_attributions: bool = False,
evaluation_pipeline_display_name: typing.Optional[str] = None,
evaluation_metrics_display_name: typing.Optional[str] = None,
network: typing.Optional[str] = None,
encryption_spec_key_name: typing.Optional[str] = None,
experiment: typing.Optional[
typing.Union[
google.cloud.aiplatform.metadata.experiment_resources.Experiment, str
]
] = None,
) -> google.cloud.aiplatform.model_evaluation.model_evaluation_job._ModelEvaluationJob
Creates a model evaluation job running on Vertex Pipelines and returns the resulting ModelEvaluationJob resource.
See more: google.cloud.aiplatform.Model.evaluate
google.cloud.aiplatform.Model.export_model
export_model(
export_format_id: str,
artifact_destination: typing.Optional[str] = None,
image_destination: typing.Optional[str] = None,
sync: bool = True,
) -> typing.Dict[str, str]
Exports a trained, exportable Model to a location specified by the user.
google.cloud.aiplatform.Model.get_model_evaluation
get_model_evaluation(
evaluation_id: typing.Optional[str] = None,
) -> typing.Optional[
google.cloud.aiplatform.model_evaluation.model_evaluation.ModelEvaluation
]
Returns a ModelEvaluation resource and instantiates its representation.
See more: google.cloud.aiplatform.Model.get_model_evaluation
google.cloud.aiplatform.Model.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.models.Model]
List all Model resource instances.
See more: google.cloud.aiplatform.Model.list
google.cloud.aiplatform.Model.list_model_evaluations
list_model_evaluations() -> (
typing.List[
google.cloud.aiplatform.model_evaluation.model_evaluation.ModelEvaluation
]
)
List all Model Evaluation resources associated with this model.
See more: google.cloud.aiplatform.Model.list_model_evaluations
google.cloud.aiplatform.Model.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.Model.to_dict
google.cloud.aiplatform.Model.update
update(
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
) -> google.cloud.aiplatform.models.Model
Updates a model.
See more: google.cloud.aiplatform.Model.update
google.cloud.aiplatform.Model.upload
upload(
serving_container_image_uri: typing.Optional[str] = None,
*,
artifact_uri: typing.Optional[str] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: bool = True,
version_aliases: typing.Optional[typing.Sequence[str]] = None,
version_description: typing.Optional[str] = None,
serving_container_predict_route: typing.Optional[str] = None,
serving_container_health_route: typing.Optional[str] = None,
description: typing.Optional[str] = None,
serving_container_command: typing.Optional[typing.Sequence[str]] = None,
serving_container_args: typing.Optional[typing.Sequence[str]] = None,
serving_container_environment_variables: typing.Optional[
typing.Dict[str, str]
] = None,
serving_container_ports: typing.Optional[typing.Sequence[int]] = None,
serving_container_grpc_ports: typing.Optional[typing.Sequence[int]] = None,
local_model: typing.Optional[LocalModel] = None,
instance_schema_uri: typing.Optional[str] = None,
parameters_schema_uri: typing.Optional[str] = None,
prediction_schema_uri: typing.Optional[str] = None,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
display_name: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
staging_bucket: typing.Optional[str] = None,
sync=True,
upload_request_timeout: typing.Optional[float] = None,
serving_container_deployment_timeout: typing.Optional[int] = None,
serving_container_shared_memory_size_mb: typing.Optional[int] = None,
serving_container_startup_probe_exec: typing.Optional[typing.Sequence[str]] = None,
serving_container_startup_probe_period_seconds: typing.Optional[int] = None,
serving_container_startup_probe_timeout_seconds: typing.Optional[int] = None,
serving_container_health_probe_exec: typing.Optional[typing.Sequence[str]] = None,
serving_container_health_probe_period_seconds: typing.Optional[int] = None,
serving_container_health_probe_timeout_seconds: typing.Optional[int] = None
) -> Model
Uploads a model and returns a Model representing the uploaded Model resource.
See more: google.cloud.aiplatform.Model.upload
google.cloud.aiplatform.Model.upload_scikit_learn_model_file
upload_scikit_learn_model_file(
model_file_path: str,
sklearn_version: typing.Optional[str] = None,
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
version_aliases: typing.Optional[typing.Sequence[str]] = None,
version_description: typing.Optional[str] = None,
instance_schema_uri: typing.Optional[str] = None,
parameters_schema_uri: typing.Optional[str] = None,
prediction_schema_uri: typing.Optional[str] = None,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
staging_bucket: typing.Optional[str] = None,
sync=True,
upload_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.models.Model
Uploads a model and returns a Model representing the uploaded Model resource.
See more: google.cloud.aiplatform.Model.upload_scikit_learn_model_file
google.cloud.aiplatform.Model.upload_tensorflow_saved_model
upload_tensorflow_saved_model(
saved_model_dir: str,
tensorflow_version: typing.Optional[str] = None,
use_gpu: bool = False,
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
version_aliases: typing.Optional[typing.Sequence[str]] = None,
version_description: typing.Optional[str] = None,
instance_schema_uri: typing.Optional[str] = None,
parameters_schema_uri: typing.Optional[str] = None,
prediction_schema_uri: typing.Optional[str] = None,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
staging_bucket: typing.Optional[str] = None,
sync=True,
upload_request_timeout: typing.Optional[str] = None,
) -> google.cloud.aiplatform.models.Model
Uploads a model and returns a Model representing the uploaded Model resource.
See more: google.cloud.aiplatform.Model.upload_tensorflow_saved_model
google.cloud.aiplatform.Model.upload_xgboost_model_file
upload_xgboost_model_file(
model_file_path: str,
xgboost_version: typing.Optional[str] = None,
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
version_aliases: typing.Optional[typing.Sequence[str]] = None,
version_description: typing.Optional[str] = None,
instance_schema_uri: typing.Optional[str] = None,
parameters_schema_uri: typing.Optional[str] = None,
prediction_schema_uri: typing.Optional[str] = None,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
staging_bucket: typing.Optional[str] = None,
sync=True,
upload_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.models.Model
Uploads a model and returns a Model representing the uploaded Model resource.
See more: google.cloud.aiplatform.Model.upload_xgboost_model_file
google.cloud.aiplatform.Model.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.Model.wait
google.cloud.aiplatform.ModelDeploymentMonitoringJob
ModelDeploymentMonitoringJob(
model_deployment_monitoring_job_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Initializer for ModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform.ModelDeploymentMonitoringJob
google.cloud.aiplatform.ModelDeploymentMonitoringJob.cancel
cancel()
Cancels this Job.
See more: google.cloud.aiplatform.ModelDeploymentMonitoringJob.cancel
google.cloud.aiplatform.ModelDeploymentMonitoringJob.create
create(
endpoint: typing.Union[str, google.cloud.aiplatform.models.Endpoint],
objective_configs: typing.Optional[
typing.Union[
google.cloud.aiplatform.model_monitoring.objective.ObjectiveConfig,
typing.Dict[
str, google.cloud.aiplatform.model_monitoring.objective.ObjectiveConfig
],
]
] = None,
logging_sampling_strategy: typing.Optional[
google.cloud.aiplatform.model_monitoring.sampling.RandomSampleConfig
] = None,
schedule_config: typing.Optional[
google.cloud.aiplatform.model_monitoring.schedule.ScheduleConfig
] = None,
display_name: typing.Optional[str] = None,
deployed_model_ids: typing.Optional[typing.List[str]] = None,
alert_config: typing.Optional[
google.cloud.aiplatform.model_monitoring.alert.EmailAlertConfig
] = None,
predict_instance_schema_uri: typing.Optional[str] = None,
sample_predict_instance: typing.Optional[str] = None,
analysis_instance_schema_uri: typing.Optional[str] = None,
bigquery_tables_log_ttl: typing.Optional[int] = None,
stats_anomalies_base_directory: typing.Optional[str] = None,
enable_monitoring_pipeline_logs: typing.Optional[bool] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.jobs.ModelDeploymentMonitoringJob
Creates and launches a model monitoring job.
See more: google.cloud.aiplatform.ModelDeploymentMonitoringJob.create
google.cloud.aiplatform.ModelDeploymentMonitoringJob.delete
delete() -> None
Deletes an MDM job.
See more: google.cloud.aiplatform.ModelDeploymentMonitoringJob.delete
google.cloud.aiplatform.ModelDeploymentMonitoringJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.ModelDeploymentMonitoringJob.done
google.cloud.aiplatform.ModelDeploymentMonitoringJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Job Resource.
See more: google.cloud.aiplatform.ModelDeploymentMonitoringJob.list
google.cloud.aiplatform.ModelDeploymentMonitoringJob.pause
pause() -> google.cloud.aiplatform.jobs.ModelDeploymentMonitoringJob
Pause a running MDM job.
See more: google.cloud.aiplatform.ModelDeploymentMonitoringJob.pause
google.cloud.aiplatform.ModelDeploymentMonitoringJob.resume
resume() -> google.cloud.aiplatform.jobs.ModelDeploymentMonitoringJob
Resumes a paused MDM job.
See more: google.cloud.aiplatform.ModelDeploymentMonitoringJob.resume
google.cloud.aiplatform.ModelDeploymentMonitoringJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.ModelDeploymentMonitoringJob.to_dict
google.cloud.aiplatform.ModelDeploymentMonitoringJob.update
update(
*,
display_name: typing.Optional[str] = None,
schedule_config: typing.Optional[
google.cloud.aiplatform.model_monitoring.schedule.ScheduleConfig
] = None,
alert_config: typing.Optional[
google.cloud.aiplatform.model_monitoring.alert.EmailAlertConfig
] = None,
logging_sampling_strategy: typing.Optional[
google.cloud.aiplatform.model_monitoring.sampling.RandomSampleConfig
] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
bigquery_tables_log_ttl: typing.Optional[int] = None,
enable_monitoring_pipeline_logs: typing.Optional[bool] = None,
objective_configs: typing.Optional[
typing.Union[
google.cloud.aiplatform.model_monitoring.objective.ObjectiveConfig,
typing.Dict[
str, google.cloud.aiplatform.model_monitoring.objective.ObjectiveConfig
],
]
] = None,
deployed_model_ids: typing.Optional[typing.List[str]] = None,
update_request_timeout: typing.Optional[float] = None
) -> google.cloud.aiplatform.jobs.ModelDeploymentMonitoringJob
Updates an existing ModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform.ModelDeploymentMonitoringJob.update
google.cloud.aiplatform.ModelDeploymentMonitoringJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.ModelDeploymentMonitoringJob.wait
google.cloud.aiplatform.ModelDeploymentMonitoringJob.wait_for_completion
wait_for_completion() -> None
Waits for job to complete.
See more: google.cloud.aiplatform.ModelDeploymentMonitoringJob.wait_for_completion
google.cloud.aiplatform.ModelEvaluation.delete
delete()
Deletes this Vertex AI resource.
google.cloud.aiplatform.ModelEvaluation.list
list(
model: str,
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
enable_simple_view: bool = False,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[
google.cloud.aiplatform.model_evaluation.model_evaluation.ModelEvaluation
]
List all ModelEvaluation resources on the provided model.
google.cloud.aiplatform.ModelEvaluation.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.ModelEvaluation.wait
wait()
Helper method that blocks until all futures are complete.
google.cloud.aiplatform.PipelineJob.__init_subclass__
__init_subclass__(
*,
experiment_loggable_schemas: typing.Tuple[
google.cloud.aiplatform.metadata.experiment_resources._ExperimentLoggableSchema
],
**kwargs
)
Register the metadata_schema for the subclass so Experiment can use it to retrieve the associated types.
google.cloud.aiplatform.PipelineJob.batch_cancel
batch_cancel(
project: str, location: str, names: typing.List[str]
) -> google.api_core.operation.Operation
Example Usage: pipeline_job = aiplatform.PipelineJob( display_name='job_display_name', template_path='your_pipeline.yaml', ) pipeline_job.batch_cancel( project='your_project_id', location='your_location', names=['pipeline_job_name', 'pipeline_job_name2'] ) .
google.cloud.aiplatform.PipelineJob.batch_delete
batch_delete(
project: str, location: str, names: typing.List[str]
) -> google.cloud.aiplatform_v1.types.pipeline_service.BatchDeletePipelineJobsResponse
Example Usage: pipeline_job = aiplatform.PipelineJob( display_name='job_display_name', template_path='your_pipeline.yaml', ) pipeline_job.batch_delete( project='your_project_id', location='your_location', names=['pipeline_job_name', 'pipeline_job_name2'] ) .
google.cloud.aiplatform.PipelineJob.cancel
cancel() -> None
Starts asynchronous cancellation on the PipelineJob.
google.cloud.aiplatform.PipelineJob.clone
clone(
display_name: typing.Optional[str] = None,
job_id: typing.Optional[str] = None,
pipeline_root: typing.Optional[str] = None,
parameter_values: typing.Optional[typing.Dict[str, typing.Any]] = None,
input_artifacts: typing.Optional[typing.Dict[str, str]] = None,
enable_caching: typing.Optional[bool] = None,
encryption_spec_key_name: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
) -> google.cloud.aiplatform.pipeline_jobs.PipelineJob
Returns a new PipelineJob object with the same settings as the original one.
google.cloud.aiplatform.PipelineJob.create_schedule
create_schedule(
cron: str,
display_name: str,
start_time: typing.Optional[str] = None,
end_time: typing.Optional[str] = None,
allow_queueing: bool = False,
max_run_count: typing.Optional[int] = None,
max_concurrent_run_count: int = 1,
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.pipeline_job_schedules.PipelineJobSchedule
Creates a PipelineJobSchedule directly from a PipelineJob.
See more: google.cloud.aiplatform.PipelineJob.create_schedule
google.cloud.aiplatform.PipelineJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
google.cloud.aiplatform.PipelineJob.done
done() -> bool
Helper method that return True is PipelineJob is done.
See more: google.cloud.aiplatform.PipelineJob.done
google.cloud.aiplatform.PipelineJob.from_pipeline_func
from_pipeline_func(
pipeline_func: typing.Callable,
parameter_values: typing.Optional[typing.Dict[str, typing.Any]] = None,
input_artifacts: typing.Optional[typing.Dict[str, str]] = None,
output_artifacts_gcs_dir: typing.Optional[str] = None,
enable_caching: typing.Optional[bool] = None,
context_name: typing.Optional[str] = "pipeline",
display_name: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
job_id: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
encryption_spec_key_name: typing.Optional[str] = None,
) -> google.cloud.aiplatform.pipeline_jobs.PipelineJob
Creates PipelineJob by compiling a pipeline function.
See more: google.cloud.aiplatform.PipelineJob.from_pipeline_func
google.cloud.aiplatform.PipelineJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.pipeline_jobs.PipelineJob
Get a Vertex AI Pipeline Job for the given resource_name.
See more: google.cloud.aiplatform.PipelineJob.get
google.cloud.aiplatform.PipelineJob.get_associated_experiment
get_associated_experiment() -> (
typing.Optional[google.cloud.aiplatform.metadata.experiment_resources.Experiment]
)
Gets the aiplatform.Experiment associated with this PipelineJob, or None if this PipelineJob is not associated with an experiment.
See more: google.cloud.aiplatform.PipelineJob.get_associated_experiment
google.cloud.aiplatform.PipelineJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
enable_simple_view: bool = False,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.pipeline_jobs.PipelineJob]
List all instances of this PipelineJob resource.
See more: google.cloud.aiplatform.PipelineJob.list
google.cloud.aiplatform.PipelineJob.run
run(
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
reserved_ip_ranges: typing.Optional[typing.List[str]] = None,
sync: typing.Optional[bool] = True,
create_request_timeout: typing.Optional[float] = None,
) -> None
Run this configured PipelineJob and monitor the job until completion.
See more: google.cloud.aiplatform.PipelineJob.run
google.cloud.aiplatform.PipelineJob.submit
submit(
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
reserved_ip_ranges: typing.Optional[typing.List[str]] = None,
create_request_timeout: typing.Optional[float] = None,
*,
experiment: typing.Optional[
typing.Union[
google.cloud.aiplatform.metadata.experiment_resources.Experiment, str
]
] = None
) -> None
Run this configured PipelineJob.
google.cloud.aiplatform.PipelineJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.PipelineJob.wait
wait()
Wait for this PipelineJob to complete.
See more: google.cloud.aiplatform.PipelineJob.wait
google.cloud.aiplatform.PipelineJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.PipelineJob.wait_for_resource_creation
google.cloud.aiplatform.PipelineJobSchedule.create
create(
cron: str,
start_time: typing.Optional[str] = None,
end_time: typing.Optional[str] = None,
allow_queueing: bool = False,
max_run_count: typing.Optional[int] = None,
max_concurrent_run_count: int = 1,
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
create_request_timeout: typing.Optional[float] = None,
) -> None
Create a PipelineJobSchedule.
See more: google.cloud.aiplatform.PipelineJobSchedule.create
google.cloud.aiplatform.PipelineJobSchedule.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.PipelineJobSchedule.delete
google.cloud.aiplatform.PipelineJobSchedule.done
done() -> bool
Helper method that return True is Schedule is done.
google.cloud.aiplatform.PipelineJobSchedule.get
get(
schedule_id: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.Any
Get a Vertex AI Schedule for the given resource_name.
google.cloud.aiplatform.PipelineJobSchedule.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.pipeline_job_schedules.PipelineJobSchedule]
List all instances of this PipelineJobSchedule resource.
google.cloud.aiplatform.PipelineJobSchedule.list_jobs
list_jobs(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
enable_simple_view: bool = True,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.pipeline_jobs.PipelineJob]
List all PipelineJob 's created by this PipelineJobSchedule.
See more: google.cloud.aiplatform.PipelineJobSchedule.list_jobs
google.cloud.aiplatform.PipelineJobSchedule.pause
pause() -> None
Starts asynchronous pause on the Schedule.
google.cloud.aiplatform.PipelineJobSchedule.resume
resume(catch_up: bool = True) -> None
Starts asynchronous resume on the Schedule.
See more: google.cloud.aiplatform.PipelineJobSchedule.resume
google.cloud.aiplatform.PipelineJobSchedule.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.PipelineJobSchedule.to_dict
google.cloud.aiplatform.PipelineJobSchedule.update
update(
display_name: typing.Optional[str] = None,
cron: typing.Optional[str] = None,
start_time: typing.Optional[str] = None,
end_time: typing.Optional[str] = None,
allow_queueing: typing.Optional[bool] = None,
max_run_count: typing.Optional[int] = None,
max_concurrent_run_count: typing.Optional[int] = None,
) -> None
Update an existing PipelineJobSchedule.
See more: google.cloud.aiplatform.PipelineJobSchedule.update
google.cloud.aiplatform.PipelineJobSchedule.wait
wait() -> None
Wait for all runs scheduled by this Schedule to complete.
google.cloud.aiplatform.PrivateEndpoint
PrivateEndpoint(
endpoint_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves a PrivateEndpoint resource.
See more: google.cloud.aiplatform.PrivateEndpoint
google.cloud.aiplatform.PrivateEndpoint.create
create(
display_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
network: typing.Optional[str] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
encryption_spec_key_name: typing.Optional[str] = None,
sync=True,
) -> google.cloud.aiplatform.models.PrivateEndpoint
Creates a new PrivateEndpoint.
google.cloud.aiplatform.PrivateEndpoint.delete
delete(force: bool = False, sync: bool = True) -> None
Deletes this Vertex AI PrivateEndpoint resource.
google.cloud.aiplatform.PrivateEndpoint.deploy
deploy(
model: google.cloud.aiplatform.models.Model,
deployed_model_display_name: typing.Optional[str] = None,
machine_type: typing.Optional[str] = None,
min_replica_count: int = 1,
max_replica_count: int = 1,
accelerator_type: typing.Optional[str] = None,
accelerator_count: typing.Optional[int] = None,
tpu_topology: typing.Optional[str] = None,
service_account: typing.Optional[str] = None,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
sync=True,
disable_container_logging: bool = False,
) -> None
Deploys a Model to the PrivateEndpoint.
google.cloud.aiplatform.PrivateEndpoint.explain
explain()
Make a prediction with explanations against this Endpoint.
google.cloud.aiplatform.PrivateEndpoint.explain_async
explain_async(
instances: typing.List[typing.Dict],
*,
parameters: typing.Optional[typing.Dict] = None,
deployed_model_id: typing.Optional[str] = None,
timeout: typing.Optional[float] = None
) -> google.cloud.aiplatform.models.Prediction
Make a prediction with explanations against this Endpoint.
See more: google.cloud.aiplatform.PrivateEndpoint.explain_async
google.cloud.aiplatform.PrivateEndpoint.health_check
health_check() -> bool
Makes a request to this PrivateEndpoint's health check URI.
See more: google.cloud.aiplatform.PrivateEndpoint.health_check
google.cloud.aiplatform.PrivateEndpoint.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.models.PrivateEndpoint]
List all PrivateEndpoint resource instances.
google.cloud.aiplatform.PrivateEndpoint.list_models
list_models() -> (
typing.List[google.cloud.aiplatform_v1.types.endpoint.DeployedModel]
)
Returns a list of the models deployed to this Endpoint.
See more: google.cloud.aiplatform.PrivateEndpoint.list_models
google.cloud.aiplatform.PrivateEndpoint.predict
predict(
instances: typing.List, parameters: typing.Optional[typing.Dict] = None
) -> google.cloud.aiplatform.models.Prediction
Make a prediction against this PrivateEndpoint using a HTTP request.
google.cloud.aiplatform.PrivateEndpoint.predict_async
predict_async(
instances: typing.List,
*,
parameters: typing.Optional[typing.Dict] = None,
timeout: typing.Optional[float] = None
) -> google.cloud.aiplatform.models.Prediction
Make an asynchronous prediction against this Endpoint.
See more: google.cloud.aiplatform.PrivateEndpoint.predict_async
google.cloud.aiplatform.PrivateEndpoint.raw_predict
raw_predict(
body: bytes, headers: typing.Dict[str, str]
) -> requests.models.Response
Make a prediction request using arbitrary headers.
See more: google.cloud.aiplatform.PrivateEndpoint.raw_predict
google.cloud.aiplatform.PrivateEndpoint.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.PrivateEndpoint.undeploy
undeploy(deployed_model_id: str, sync=True) -> None
Undeploys a deployed model from the PrivateEndpoint.
google.cloud.aiplatform.PrivateEndpoint.undeploy_all
undeploy_all(sync: bool = True) -> google.cloud.aiplatform.models.Endpoint
Undeploys every model deployed to this Endpoint.
See more: google.cloud.aiplatform.PrivateEndpoint.undeploy_all
google.cloud.aiplatform.PrivateEndpoint.update
update(
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
traffic_split: typing.Optional[typing.Dict[str, int]] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
update_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.models.Endpoint
Updates an endpoint.
google.cloud.aiplatform.PrivateEndpoint.wait
wait()
Helper method that blocks until all futures are complete.
google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob
SequenceToSequencePlusForecastingTrainingJob(
display_name: typing.Optional[str] = None,
optimization_objective: typing.Optional[str] = None,
column_specs: typing.Optional[typing.Dict[str, str]] = None,
column_transformations: typing.Optional[
typing.List[typing.Dict[str, typing.Dict[str, str]]]
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
training_encryption_spec_key_name: typing.Optional[str] = None,
model_encryption_spec_key_name: typing.Optional[str] = None,
)
Constructs a Forecasting Training Job.
See more: google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob
google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.cancel
cancel() -> None
Starts asynchronous cancellation on the TrainingJob.
See more: google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.cancel
google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.delete
google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.done
google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.training_jobs._TrainingJob
Get Training Job for the given resource_name.
See more: google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.get
google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.get_model
get_model(sync=True) -> google.cloud.aiplatform.models.Model
Vertex AI Model produced by this training, if one was produced.
See more: google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.get_model
google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this TrainingJob resource.
See more: google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.list
google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.run
run(
dataset: google.cloud.aiplatform.datasets.time_series_dataset.TimeSeriesDataset,
target_column: str,
time_column: str,
time_series_identifier_column: str,
unavailable_at_forecast_columns: typing.List[str],
available_at_forecast_columns: typing.List[str],
forecast_horizon: int,
data_granularity_unit: str,
data_granularity_count: int,
training_fraction_split: typing.Optional[float] = None,
validation_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
predefined_split_column_name: typing.Optional[str] = None,
timestamp_split_column_name: typing.Optional[str] = None,
weight_column: typing.Optional[str] = None,
time_series_attribute_columns: typing.Optional[typing.List[str]] = None,
context_window: typing.Optional[int] = None,
export_evaluated_data_items: bool = False,
export_evaluated_data_items_bigquery_destination_uri: typing.Optional[str] = None,
export_evaluated_data_items_override_destination: bool = False,
quantiles: typing.Optional[typing.List[float]] = None,
validation_options: typing.Optional[str] = None,
budget_milli_node_hours: int = 1000,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
additional_experiments: typing.Optional[typing.List[str]] = None,
hierarchy_group_columns: typing.Optional[typing.List[str]] = None,
hierarchy_group_total_weight: typing.Optional[float] = None,
hierarchy_temporal_total_weight: typing.Optional[float] = None,
hierarchy_group_temporal_total_weight: typing.Optional[float] = None,
window_column: typing.Optional[str] = None,
window_stride_length: typing.Optional[int] = None,
window_max_count: typing.Optional[int] = None,
holiday_regions: typing.Optional[typing.List[str]] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
enable_probabilistic_inference: bool = False,
) -> google.cloud.aiplatform.models.Model
Runs the training job and returns a model.
See more: google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.run
google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.to_dict
google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.wait
google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.SequenceToSequencePlusForecastingTrainingJob.wait_for_resource_creation
google.cloud.aiplatform.TabularDataset
TabularDataset(
dataset_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing managed dataset given a dataset name or ID.
See more: google.cloud.aiplatform.TabularDataset
google.cloud.aiplatform.TabularDataset.create
create(
display_name: typing.Optional[str] = None,
gcs_source: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
bq_source: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.datasets.tabular_dataset.TabularDataset
Creates a tabular dataset.
google.cloud.aiplatform.TabularDataset.create_from_dataframe
create_from_dataframe(
df_source: pd.DataFrame,
staging_path: str,
bq_schema: typing.Optional[
typing.Union[str, google.cloud.bigquery.schema.SchemaField]
] = None,
display_name: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> TabularDataset
Creates a new tabular dataset from a pandas DataFrame
.
See more: google.cloud.aiplatform.TabularDataset.create_from_dataframe
google.cloud.aiplatform.TabularDataset.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
google.cloud.aiplatform.TabularDataset.export_data
export_data(output_dir: str) -> typing.Sequence[str]
Exports data to output dir to GCS.
See more: google.cloud.aiplatform.TabularDataset.export_data
google.cloud.aiplatform.TabularDataset.export_data_for_custom_training
export_data_for_custom_training(
output_dir: str,
annotation_filter: typing.Optional[str] = None,
saved_query_id: typing.Optional[str] = None,
annotation_schema_uri: typing.Optional[str] = None,
split: typing.Optional[
typing.Union[typing.Dict[str, str], typing.Dict[str, float]]
] = None,
) -> typing.Dict[str, typing.Any]
Exports data to output dir to GCS for custom training use case.
See more: google.cloud.aiplatform.TabularDataset.export_data_for_custom_training
google.cloud.aiplatform.TabularDataset.import_data
import_data()
Upload data to existing managed dataset.
See more: google.cloud.aiplatform.TabularDataset.import_data
google.cloud.aiplatform.TabularDataset.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Dataset resource.
google.cloud.aiplatform.TabularDataset.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.TabularDataset.update
update(
*,
display_name: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
description: typing.Optional[str] = None,
update_request_timeout: typing.Optional[float] = None
) -> google.cloud.aiplatform.datasets.dataset._Dataset
Update the dataset.
google.cloud.aiplatform.TabularDataset.wait
wait()
Helper method that blocks until all futures are complete.
google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob
TemporalFusionTransformerForecastingTrainingJob(
display_name: typing.Optional[str] = None,
optimization_objective: typing.Optional[str] = None,
column_specs: typing.Optional[typing.Dict[str, str]] = None,
column_transformations: typing.Optional[
typing.List[typing.Dict[str, typing.Dict[str, str]]]
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
training_encryption_spec_key_name: typing.Optional[str] = None,
model_encryption_spec_key_name: typing.Optional[str] = None,
)
Constructs a Forecasting Training Job.
See more: google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob
google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.cancel
cancel() -> None
Starts asynchronous cancellation on the TrainingJob.
See more: google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.cancel
google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.delete
google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.done
google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.training_jobs._TrainingJob
Get Training Job for the given resource_name.
See more: google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.get
google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.get_model
get_model(sync=True) -> google.cloud.aiplatform.models.Model
Vertex AI Model produced by this training, if one was produced.
See more: google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.get_model
google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this TrainingJob resource.
See more: google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.list
google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.run
run(
dataset: google.cloud.aiplatform.datasets.time_series_dataset.TimeSeriesDataset,
target_column: str,
time_column: str,
time_series_identifier_column: str,
unavailable_at_forecast_columns: typing.List[str],
available_at_forecast_columns: typing.List[str],
forecast_horizon: int,
data_granularity_unit: str,
data_granularity_count: int,
training_fraction_split: typing.Optional[float] = None,
validation_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
predefined_split_column_name: typing.Optional[str] = None,
timestamp_split_column_name: typing.Optional[str] = None,
weight_column: typing.Optional[str] = None,
time_series_attribute_columns: typing.Optional[typing.List[str]] = None,
context_window: typing.Optional[int] = None,
export_evaluated_data_items: bool = False,
export_evaluated_data_items_bigquery_destination_uri: typing.Optional[str] = None,
export_evaluated_data_items_override_destination: bool = False,
quantiles: typing.Optional[typing.List[float]] = None,
validation_options: typing.Optional[str] = None,
budget_milli_node_hours: int = 1000,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
additional_experiments: typing.Optional[typing.List[str]] = None,
hierarchy_group_columns: typing.Optional[typing.List[str]] = None,
hierarchy_group_total_weight: typing.Optional[float] = None,
hierarchy_temporal_total_weight: typing.Optional[float] = None,
hierarchy_group_temporal_total_weight: typing.Optional[float] = None,
window_column: typing.Optional[str] = None,
window_stride_length: typing.Optional[int] = None,
window_max_count: typing.Optional[int] = None,
holiday_regions: typing.Optional[typing.List[str]] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
enable_probabilistic_inference: bool = False,
) -> google.cloud.aiplatform.models.Model
Runs the training job and returns a model.
See more: google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.run
google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.to_dict
google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.wait
google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.TemporalFusionTransformerForecastingTrainingJob.wait_for_resource_creation
google.cloud.aiplatform.Tensorboard
Tensorboard(
tensorboard_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing managed tensorboard given a tensorboard name or ID.
See more: google.cloud.aiplatform.Tensorboard
google.cloud.aiplatform.Tensorboard.create
create(
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
encryption_spec_key_name: typing.Optional[str] = None,
create_request_timeout: typing.Optional[float] = None,
is_default: bool = False,
) -> google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard
Creates a new tensorboard.
google.cloud.aiplatform.Tensorboard.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
google.cloud.aiplatform.Tensorboard.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
parent: typing.Optional[str] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Vertex AI Resource.
See more: google.cloud.aiplatform.Tensorboard.list
google.cloud.aiplatform.Tensorboard.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.Tensorboard.update
update(
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
encryption_spec_key_name: typing.Optional[str] = None,
is_default: typing.Optional[bool] = None,
) -> google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard
Updates an existing tensorboard.
google.cloud.aiplatform.Tensorboard.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.Tensorboard.wait
google.cloud.aiplatform.TensorboardExperiment
TensorboardExperiment(
tensorboard_experiment_name: str,
tensorboard_id: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing tensorboard experiment given a tensorboard experiment name or ID.
google.cloud.aiplatform.TensorboardExperiment.create
create(
tensorboard_experiment_id: str,
tensorboard_name: str,
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Sequence[typing.Tuple[str, str]] = (),
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.tensorboard.tensorboard_resource.TensorboardExperiment
Creates a new TensorboardExperiment.
See more: google.cloud.aiplatform.TensorboardExperiment.create
google.cloud.aiplatform.TensorboardExperiment.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.TensorboardExperiment.delete
google.cloud.aiplatform.TensorboardExperiment.list
list(
tensorboard_name: str,
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[
google.cloud.aiplatform.tensorboard.tensorboard_resource.TensorboardExperiment
]
List TensorboardExperiemnts in a Tensorboard resource.
See more: google.cloud.aiplatform.TensorboardExperiment.list
google.cloud.aiplatform.TensorboardExperiment.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.TensorboardExperiment.to_dict
google.cloud.aiplatform.TensorboardExperiment.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.TensorboardExperiment.wait
google.cloud.aiplatform.TensorboardRun
TensorboardRun(
tensorboard_run_name: str,
tensorboard_id: typing.Optional[str] = None,
tensorboard_experiment_id: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing tensorboard run given a tensorboard run name or ID.
See more: google.cloud.aiplatform.TensorboardRun
google.cloud.aiplatform.TensorboardRun.create
create(
tensorboard_run_id: str,
tensorboard_experiment_name: str,
tensorboard_id: typing.Optional[str] = None,
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Sequence[typing.Tuple[str, str]] = (),
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.tensorboard.tensorboard_resource.TensorboardRun
Creates a new tensorboard run.
google.cloud.aiplatform.TensorboardRun.create_tensorboard_time_series
create_tensorboard_time_series(
display_name: str,
value_type: typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_time_series.TensorboardTimeSeries.ValueType,
str,
] = "SCALAR",
plugin_name: str = "scalars",
plugin_data: typing.Optional[bytes] = None,
description: typing.Optional[str] = None,
) -> google.cloud.aiplatform.tensorboard.tensorboard_resource.TensorboardTimeSeries
Creates a new tensorboard time series.
See more: google.cloud.aiplatform.TensorboardRun.create_tensorboard_time_series
google.cloud.aiplatform.TensorboardRun.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
google.cloud.aiplatform.TensorboardRun.list
list(
tensorboard_experiment_name: str,
tensorboard_id: typing.Optional[str] = None,
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[
google.cloud.aiplatform.tensorboard.tensorboard_resource.TensorboardRun
]
List all instances of TensorboardRun in TensorboardExperiment.
google.cloud.aiplatform.TensorboardRun.read_time_series_data
read_time_series_data() -> (
typing.Dict[str, google.cloud.aiplatform_v1.types.tensorboard_data.TimeSeriesData]
)
Read the time series data of this run.
See more: google.cloud.aiplatform.TensorboardRun.read_time_series_data
google.cloud.aiplatform.TensorboardRun.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.TensorboardRun.wait
wait()
Helper method that blocks until all futures are complete.
google.cloud.aiplatform.TensorboardRun.write_tensorboard_scalar_data
write_tensorboard_scalar_data(
time_series_data: typing.Dict[str, float],
step: int,
wall_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
)
Writes tensorboard scalar data to this run.
See more: google.cloud.aiplatform.TensorboardRun.write_tensorboard_scalar_data
google.cloud.aiplatform.TensorboardTimeSeries
TensorboardTimeSeries(
tensorboard_time_series_name: str,
tensorboard_id: typing.Optional[str] = None,
tensorboard_experiment_id: typing.Optional[str] = None,
tensorboard_run_id: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing tensorboard time series given a tensorboard time series name or ID.
google.cloud.aiplatform.TensorboardTimeSeries.create
create(
display_name: str,
tensorboard_run_name: str,
tensorboard_id: typing.Optional[str] = None,
tensorboard_experiment_id: typing.Optional[str] = None,
value_type: typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_time_series.TensorboardTimeSeries.ValueType,
str,
] = "SCALAR",
plugin_name: str = "scalars",
plugin_data: typing.Optional[bytes] = None,
description: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.tensorboard.tensorboard_resource.TensorboardTimeSeries
Creates a new tensorboard time series.
See more: google.cloud.aiplatform.TensorboardTimeSeries.create
google.cloud.aiplatform.TensorboardTimeSeries.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.TensorboardTimeSeries.delete
google.cloud.aiplatform.TensorboardTimeSeries.list
list(
tensorboard_run_name: str,
tensorboard_id: typing.Optional[str] = None,
tensorboard_experiment_id: typing.Optional[str] = None,
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[
google.cloud.aiplatform.tensorboard.tensorboard_resource.TensorboardTimeSeries
]
List all instances of TensorboardTimeSeries in TensorboardRun.
See more: google.cloud.aiplatform.TensorboardTimeSeries.list
google.cloud.aiplatform.TensorboardTimeSeries.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.TensorboardTimeSeries.to_dict
google.cloud.aiplatform.TensorboardTimeSeries.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.TensorboardTimeSeries.wait
google.cloud.aiplatform.TextDataset
TextDataset(
dataset_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing managed dataset given a dataset name or ID.
See more: google.cloud.aiplatform.TextDataset
google.cloud.aiplatform.TextDataset.create
create(
display_name: typing.Optional[str] = None,
gcs_source: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
import_schema_uri: typing.Optional[str] = None,
data_item_labels: typing.Optional[typing.Dict] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.datasets.text_dataset.TextDataset
Creates a new text dataset and optionally imports data into dataset when source and import_schema_uri are passed.
google.cloud.aiplatform.TextDataset.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
google.cloud.aiplatform.TextDataset.export_data
export_data(output_dir: str) -> typing.Sequence[str]
Exports data to output dir to GCS.
google.cloud.aiplatform.TextDataset.export_data_for_custom_training
export_data_for_custom_training(
output_dir: str,
annotation_filter: typing.Optional[str] = None,
saved_query_id: typing.Optional[str] = None,
annotation_schema_uri: typing.Optional[str] = None,
split: typing.Optional[
typing.Union[typing.Dict[str, str], typing.Dict[str, float]]
] = None,
) -> typing.Dict[str, typing.Any]
Exports data to output dir to GCS for custom training use case.
See more: google.cloud.aiplatform.TextDataset.export_data_for_custom_training
google.cloud.aiplatform.TextDataset.import_data
import_data(
gcs_source: typing.Union[str, typing.Sequence[str]],
import_schema_uri: str,
data_item_labels: typing.Optional[typing.Dict] = None,
sync: bool = True,
import_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.datasets.dataset._Dataset
Upload data to existing managed dataset.
google.cloud.aiplatform.TextDataset.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Dataset resource.
See more: google.cloud.aiplatform.TextDataset.list
google.cloud.aiplatform.TextDataset.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.TextDataset.update
update(
*,
display_name: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
description: typing.Optional[str] = None,
update_request_timeout: typing.Optional[float] = None
) -> google.cloud.aiplatform.datasets.dataset._Dataset
Update the dataset.
google.cloud.aiplatform.TextDataset.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.TextDataset.wait
google.cloud.aiplatform.TimeSeriesDataset
TimeSeriesDataset(
dataset_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing managed dataset given a dataset name or ID.
google.cloud.aiplatform.TimeSeriesDataset.create
create(
display_name: typing.Optional[str] = None,
gcs_source: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
bq_source: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.datasets.time_series_dataset.TimeSeriesDataset
Creates a new time series dataset.
google.cloud.aiplatform.TimeSeriesDataset.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
google.cloud.aiplatform.TimeSeriesDataset.export_data
export_data(output_dir: str) -> typing.Sequence[str]
Exports data to output dir to GCS.
See more: google.cloud.aiplatform.TimeSeriesDataset.export_data
google.cloud.aiplatform.TimeSeriesDataset.export_data_for_custom_training
export_data_for_custom_training(
output_dir: str,
annotation_filter: typing.Optional[str] = None,
saved_query_id: typing.Optional[str] = None,
annotation_schema_uri: typing.Optional[str] = None,
split: typing.Optional[
typing.Union[typing.Dict[str, str], typing.Dict[str, float]]
] = None,
) -> typing.Dict[str, typing.Any]
Exports data to output dir to GCS for custom training use case.
See more: google.cloud.aiplatform.TimeSeriesDataset.export_data_for_custom_training
google.cloud.aiplatform.TimeSeriesDataset.import_data
import_data()
Upload data to existing managed dataset.
See more: google.cloud.aiplatform.TimeSeriesDataset.import_data
google.cloud.aiplatform.TimeSeriesDataset.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Dataset resource.
google.cloud.aiplatform.TimeSeriesDataset.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.TimeSeriesDataset.update
update(
*,
display_name: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
description: typing.Optional[str] = None,
update_request_timeout: typing.Optional[float] = None
) -> google.cloud.aiplatform.datasets.dataset._Dataset
Update the dataset.
google.cloud.aiplatform.TimeSeriesDataset.wait
wait()
Helper method that blocks until all futures are complete.
google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob
TimeSeriesDenseEncoderForecastingTrainingJob(
display_name: typing.Optional[str] = None,
optimization_objective: typing.Optional[str] = None,
column_specs: typing.Optional[typing.Dict[str, str]] = None,
column_transformations: typing.Optional[
typing.List[typing.Dict[str, typing.Dict[str, str]]]
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
training_encryption_spec_key_name: typing.Optional[str] = None,
model_encryption_spec_key_name: typing.Optional[str] = None,
)
Constructs a Forecasting Training Job.
See more: google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob
google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.cancel
cancel() -> None
Starts asynchronous cancellation on the TrainingJob.
See more: google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.cancel
google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.delete
google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.done
done() -> bool
Method indicating whether a job has completed.
See more: google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.done
google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.get
get(
resource_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.training_jobs._TrainingJob
Get Training Job for the given resource_name.
See more: google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.get
google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.get_model
get_model(sync=True) -> google.cloud.aiplatform.models.Model
Vertex AI Model produced by this training, if one was produced.
See more: google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.get_model
google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this TrainingJob resource.
See more: google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.list
google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.run
run(
dataset: google.cloud.aiplatform.datasets.time_series_dataset.TimeSeriesDataset,
target_column: str,
time_column: str,
time_series_identifier_column: str,
unavailable_at_forecast_columns: typing.List[str],
available_at_forecast_columns: typing.List[str],
forecast_horizon: int,
data_granularity_unit: str,
data_granularity_count: int,
training_fraction_split: typing.Optional[float] = None,
validation_fraction_split: typing.Optional[float] = None,
test_fraction_split: typing.Optional[float] = None,
predefined_split_column_name: typing.Optional[str] = None,
timestamp_split_column_name: typing.Optional[str] = None,
weight_column: typing.Optional[str] = None,
time_series_attribute_columns: typing.Optional[typing.List[str]] = None,
context_window: typing.Optional[int] = None,
export_evaluated_data_items: bool = False,
export_evaluated_data_items_bigquery_destination_uri: typing.Optional[str] = None,
export_evaluated_data_items_override_destination: bool = False,
quantiles: typing.Optional[typing.List[float]] = None,
validation_options: typing.Optional[str] = None,
budget_milli_node_hours: int = 1000,
model_display_name: typing.Optional[str] = None,
model_labels: typing.Optional[typing.Dict[str, str]] = None,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
is_default_version: typing.Optional[bool] = True,
model_version_aliases: typing.Optional[typing.Sequence[str]] = None,
model_version_description: typing.Optional[str] = None,
additional_experiments: typing.Optional[typing.List[str]] = None,
hierarchy_group_columns: typing.Optional[typing.List[str]] = None,
hierarchy_group_total_weight: typing.Optional[float] = None,
hierarchy_temporal_total_weight: typing.Optional[float] = None,
hierarchy_group_temporal_total_weight: typing.Optional[float] = None,
window_column: typing.Optional[str] = None,
window_stride_length: typing.Optional[int] = None,
window_max_count: typing.Optional[int] = None,
holiday_regions: typing.Optional[typing.List[str]] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
enable_probabilistic_inference: bool = False,
) -> google.cloud.aiplatform.models.Model
Runs the training job and returns a model.
See more: google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.run
google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.to_dict
google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.wait
wait()
Helper method that blocks until all futures are complete.
See more: google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.wait
google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.wait_for_resource_creation
wait_for_resource_creation() -> None
Waits until resource has been created.
See more: google.cloud.aiplatform.TimeSeriesDenseEncoderForecastingTrainingJob.wait_for_resource_creation
google.cloud.aiplatform.VideoDataset
VideoDataset(
dataset_name: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing managed dataset given a dataset name or ID.
See more: google.cloud.aiplatform.VideoDataset
google.cloud.aiplatform.VideoDataset.create
create(
display_name: typing.Optional[str] = None,
gcs_source: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
import_schema_uri: typing.Optional[str] = None,
data_item_labels: typing.Optional[typing.Dict] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
labels: typing.Optional[typing.Dict[str, str]] = None,
encryption_spec_key_name: typing.Optional[str] = None,
sync: bool = True,
create_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.datasets.video_dataset.VideoDataset
Creates a new video dataset and optionally imports data into dataset when source and import_schema_uri are passed.
google.cloud.aiplatform.VideoDataset.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
google.cloud.aiplatform.VideoDataset.export_data
export_data(output_dir: str) -> typing.Sequence[str]
Exports data to output dir to GCS.
google.cloud.aiplatform.VideoDataset.export_data_for_custom_training
export_data_for_custom_training(
output_dir: str,
annotation_filter: typing.Optional[str] = None,
saved_query_id: typing.Optional[str] = None,
annotation_schema_uri: typing.Optional[str] = None,
split: typing.Optional[
typing.Union[typing.Dict[str, str], typing.Dict[str, float]]
] = None,
) -> typing.Dict[str, typing.Any]
Exports data to output dir to GCS for custom training use case.
See more: google.cloud.aiplatform.VideoDataset.export_data_for_custom_training
google.cloud.aiplatform.VideoDataset.import_data
import_data(
gcs_source: typing.Union[str, typing.Sequence[str]],
import_schema_uri: str,
data_item_labels: typing.Optional[typing.Dict] = None,
sync: bool = True,
import_request_timeout: typing.Optional[float] = None,
) -> google.cloud.aiplatform.datasets.dataset._Dataset
Upload data to existing managed dataset.
google.cloud.aiplatform.VideoDataset.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Dataset resource.
google.cloud.aiplatform.VideoDataset.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
google.cloud.aiplatform.VideoDataset.update
update(
*,
display_name: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
description: typing.Optional[str] = None,
update_request_timeout: typing.Optional[float] = None
) -> google.cloud.aiplatform.datasets.dataset._Dataset
Update the dataset.
google.cloud.aiplatform.VideoDataset.wait
wait()
Helper method that blocks until all futures are complete.
google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel
ExperimentModel(
*,
framework_name: str,
framework_version: str,
model_file: str,
uri: str,
model_class: typing.Optional[str] = None,
predict_schemata: typing.Optional[
google.cloud.aiplatform.metadata.schema.utils.PredictSchemata
] = None,
artifact_id: typing.Optional[str] = None,
display_name: typing.Optional[str] = None,
schema_version: typing.Optional[str] = None,
description: typing.Optional[str] = None,
metadata: typing.Optional[typing.Dict] = None,
state: typing.Optional[
google.cloud.aiplatform_v1.types.artifact.Artifact.State
] = State.LIVE
)
Instantiates an ExperimentModel that represents a saved ML model.
See more: google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel
google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel.get
get(
artifact_id: str,
*,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel
Retrieves an existing ExperimentModel artifact given an artifact id.
See more: google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel.get
google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel.get_model_info
get_model_info() -> typing.Dict[str, typing.Any]
Get the model's info from an experiment model artifact.
See more: google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel.get_model_info
google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel.load_model
load_model() -> typing.Union[sklearn.base.BaseEstimator, xgb.Booster, tf.Module]
Retrieves the original ML model from an ExperimentModel.
See more: google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel.load_model
google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel.register_model
register_model(
*,
model_id: typing.Optional[str] = None,
parent_model: typing.Optional[str] = None,
use_gpu: bool = False,
is_default_version: bool = True,
version_aliases: typing.Optional[typing.Sequence[str]] = None,
version_description: typing.Optional[str] = None,
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
labels: typing.Optional[typing.Dict[str, str]] = None,
serving_container_image_uri: typing.Optional[str] = None,
serving_container_predict_route: typing.Optional[str] = None,
serving_container_health_route: typing.Optional[str] = None,
serving_container_command: typing.Optional[typing.Sequence[str]] = None,
serving_container_args: typing.Optional[typing.Sequence[str]] = None,
serving_container_environment_variables: typing.Optional[
typing.Dict[str, str]
] = None,
serving_container_ports: typing.Optional[typing.Sequence[int]] = None,
instance_schema_uri: typing.Optional[str] = None,
parameters_schema_uri: typing.Optional[str] = None,
prediction_schema_uri: typing.Optional[str] = None,
explanation_metadata: typing.Optional[
google.cloud.aiplatform_v1.types.explanation_metadata.ExplanationMetadata
] = None,
explanation_parameters: typing.Optional[
google.cloud.aiplatform_v1.types.explanation.ExplanationParameters
] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
encryption_spec_key_name: typing.Optional[str] = None,
staging_bucket: typing.Optional[str] = None,
sync: typing.Optional[bool] = True,
upload_request_timeout: typing.Optional[float] = None
) -> google.cloud.aiplatform.models.Model
Register an ExperimentModel to Model Registry and returns a Model representing the registered Model resource.
See more: google.cloud.aiplatform.metadata.schema.google.artifact_schema.ExperimentModel.register_model
google.cloud.aiplatform.prediction.DefaultSerializer.deserialize
deserialize(data: typing.Any, content_type: typing.Optional[str]) -> typing.Any
Deserializes the request data.
See more: google.cloud.aiplatform.prediction.DefaultSerializer.deserialize
google.cloud.aiplatform.prediction.DefaultSerializer.serialize
serialize(prediction: typing.Any, accept: typing.Optional[str]) -> typing.Any
Serializes the prediction results.
See more: google.cloud.aiplatform.prediction.DefaultSerializer.serialize
google.cloud.aiplatform.prediction.Handler
Handler(
artifacts_uri: str,
predictor: typing.Optional[
typing.Type[google.cloud.aiplatform.prediction.predictor.Predictor]
] = None,
)
Initializes a Handler instance.
google.cloud.aiplatform.prediction.Handler.handle
handle(request: starlette.requests.Request) -> starlette.responses.Response
Handles a prediction request.
google.cloud.aiplatform.prediction.LocalEndpoint
LocalEndpoint(
serving_container_image_uri: str,
artifact_uri: typing.Optional[str] = None,
serving_container_predict_route: typing.Optional[str] = None,
serving_container_health_route: typing.Optional[str] = None,
serving_container_command: typing.Optional[typing.Sequence[str]] = None,
serving_container_args: typing.Optional[typing.Sequence[str]] = None,
serving_container_environment_variables: typing.Optional[
typing.Dict[str, str]
] = None,
serving_container_ports: typing.Optional[typing.Sequence[int]] = None,
credential_path: typing.Optional[str] = None,
host_port: typing.Optional[str] = None,
gpu_count: typing.Optional[int] = None,
gpu_device_ids: typing.Optional[typing.List[str]] = None,
gpu_capabilities: typing.Optional[typing.List[typing.List[str]]] = None,
container_ready_timeout: typing.Optional[int] = None,
container_ready_check_interval: typing.Optional[int] = None,
)
Creates a local endpoint instance.
google.cloud.aiplatform.prediction.LocalEndpoint.__del__
__del__()
Stops the container when the instance is about to be destroyed.
See more: google.cloud.aiplatform.prediction.LocalEndpoint.del
google.cloud.aiplatform.prediction.LocalEndpoint.__enter__
__enter__()
Enters the runtime context related to this object.
See more: google.cloud.aiplatform.prediction.LocalEndpoint.enter
google.cloud.aiplatform.prediction.LocalEndpoint.__exit__
__exit__(exc_type, exc_value, exc_traceback)
Exits the runtime context related to this object.
See more: google.cloud.aiplatform.prediction.LocalEndpoint.exit
google.cloud.aiplatform.prediction.LocalEndpoint.get_container_status
get_container_status() -> str
Gets the container status.
See more: google.cloud.aiplatform.prediction.LocalEndpoint.get_container_status
google.cloud.aiplatform.prediction.LocalEndpoint.predict
predict(
request: typing.Optional[typing.Any] = None,
request_file: typing.Optional[str] = None,
headers: typing.Optional[typing.Dict] = None,
verbose: bool = True,
) -> requests.models.Response
Executes a prediction.
See more: google.cloud.aiplatform.prediction.LocalEndpoint.predict
google.cloud.aiplatform.prediction.LocalEndpoint.print_container_logs
print_container_logs(
show_all: bool = False, message: typing.Optional[str] = None
) -> None
Prints container logs.
See more: google.cloud.aiplatform.prediction.LocalEndpoint.print_container_logs
google.cloud.aiplatform.prediction.LocalEndpoint.print_container_logs_if_container_is_not_running
print_container_logs_if_container_is_not_running(
show_all: bool = False, message: typing.Optional[str] = None
) -> None
Prints container logs if the container is not in "running" status.
See more: google.cloud.aiplatform.prediction.LocalEndpoint.print_container_logs_if_container_is_not_running
google.cloud.aiplatform.prediction.LocalEndpoint.run_health_check
run_health_check(verbose: bool = True) -> requests.models.Response
Runs a health check.
See more: google.cloud.aiplatform.prediction.LocalEndpoint.run_health_check
google.cloud.aiplatform.prediction.LocalEndpoint.serve
serve()
Starts running the container and serves the traffic locally.
See more: google.cloud.aiplatform.prediction.LocalEndpoint.serve
google.cloud.aiplatform.prediction.LocalEndpoint.stop
stop() -> None
Explicitly stops the container.
See more: google.cloud.aiplatform.prediction.LocalEndpoint.stop
google.cloud.aiplatform.prediction.LocalModel
LocalModel(
serving_container_spec: typing.Optional[
google.cloud.aiplatform_v1.types.model.ModelContainerSpec
] = None,
serving_container_image_uri: typing.Optional[str] = None,
serving_container_predict_route: typing.Optional[str] = None,
serving_container_health_route: typing.Optional[str] = None,
serving_container_command: typing.Optional[typing.Sequence[str]] = None,
serving_container_args: typing.Optional[typing.Sequence[str]] = None,
serving_container_environment_variables: typing.Optional[
typing.Dict[str, str]
] = None,
serving_container_ports: typing.Optional[typing.Sequence[int]] = None,
serving_container_grpc_ports: typing.Optional[typing.Sequence[int]] = None,
serving_container_deployment_timeout: typing.Optional[int] = None,
serving_container_shared_memory_size_mb: typing.Optional[int] = None,
serving_container_startup_probe_exec: typing.Optional[typing.Sequence[str]] = None,
serving_container_startup_probe_period_seconds: typing.Optional[int] = None,
serving_container_startup_probe_timeout_seconds: typing.Optional[int] = None,
serving_container_health_probe_exec: typing.Optional[typing.Sequence[str]] = None,
serving_container_health_probe_period_seconds: typing.Optional[int] = None,
serving_container_health_probe_timeout_seconds: typing.Optional[int] = None,
)
Creates a local model instance.
google.cloud.aiplatform.prediction.LocalModel.build_cpr_model
build_cpr_model(src_dir: str, output_image_uri: str, predictor: typing.Optional[typing.Type[google.cloud.aiplatform.prediction.predictor.Predictor]] = None, handler: typing.Type[google.cloud.aiplatform.prediction.handler.Handler] =
Builds a local model from a custom predictor.
See more: google.cloud.aiplatform.prediction.LocalModel.build_cpr_model
google.cloud.aiplatform.prediction.LocalModel.copy_image
copy_image(
dst_image_uri: str,
) -> google.cloud.aiplatform.prediction.local_model.LocalModel
Copies the image to another image uri.
See more: google.cloud.aiplatform.prediction.LocalModel.copy_image
google.cloud.aiplatform.prediction.LocalModel.deploy_to_local_endpoint
deploy_to_local_endpoint(
artifact_uri: typing.Optional[str] = None,
credential_path: typing.Optional[str] = None,
host_port: typing.Optional[str] = None,
gpu_count: typing.Optional[int] = None,
gpu_device_ids: typing.Optional[typing.List[str]] = None,
gpu_capabilities: typing.Optional[typing.List[typing.List[str]]] = None,
container_ready_timeout: typing.Optional[int] = None,
container_ready_check_interval: typing.Optional[int] = None,
) -> google.cloud.aiplatform.prediction.local_endpoint.LocalEndpoint
Deploys the local model instance to a local endpoint.
See more: google.cloud.aiplatform.prediction.LocalModel.deploy_to_local_endpoint
google.cloud.aiplatform.prediction.LocalModel.get_serving_container_spec
get_serving_container_spec() -> (
google.cloud.aiplatform_v1.types.model.ModelContainerSpec
)
Returns the container spec for the image.
See more: google.cloud.aiplatform.prediction.LocalModel.get_serving_container_spec
google.cloud.aiplatform.prediction.LocalModel.pull_image_if_not_exists
pull_image_if_not_exists()
Pulls the image if the image does not exist locally.
See more: google.cloud.aiplatform.prediction.LocalModel.pull_image_if_not_exists
google.cloud.aiplatform.prediction.LocalModel.push_image
push_image() -> None
Pushes the image to a registry.
See more: google.cloud.aiplatform.prediction.LocalModel.push_image
google.cloud.aiplatform.prediction.PredictionHandler
PredictionHandler(
artifacts_uri: str,
predictor: typing.Optional[
typing.Type[google.cloud.aiplatform.prediction.predictor.Predictor]
] = None,
)
Initializes a Handler instance.
See more: google.cloud.aiplatform.prediction.PredictionHandler
google.cloud.aiplatform.prediction.PredictionHandler.handle
handle(request: starlette.requests.Request) -> starlette.responses.Response
Handles a prediction request.
See more: google.cloud.aiplatform.prediction.PredictionHandler.handle
google.cloud.aiplatform.prediction.Predictor.load
load(artifacts_uri: str) -> None
Loads the model artifact.
google.cloud.aiplatform.prediction.Predictor.postprocess
postprocess(prediction_results: typing.Any) -> typing.Any
Postprocesses the prediction results.
See more: google.cloud.aiplatform.prediction.Predictor.postprocess
google.cloud.aiplatform.prediction.Predictor.predict
predict(instances: typing.Any) -> typing.Any
Performs prediction.
See more: google.cloud.aiplatform.prediction.Predictor.predict
google.cloud.aiplatform.prediction.Predictor.preprocess
preprocess(prediction_input: typing.Any) -> typing.Any
Preprocesses the prediction input before doing the prediction.
See more: google.cloud.aiplatform.prediction.Predictor.preprocess
google.cloud.aiplatform.prediction.Serializer.deserialize
deserialize(data: typing.Any, content_type: typing.Optional[str]) -> typing.Any
Deserializes the request data.
See more: google.cloud.aiplatform.prediction.Serializer.deserialize
google.cloud.aiplatform.prediction.Serializer.serialize
serialize(prediction: typing.Any, accept: typing.Optional[str]) -> typing.Any
Serializes the prediction results.
See more: google.cloud.aiplatform.prediction.Serializer.serialize
google.cloud.aiplatform.v1.schema.predict.instance_v1.types.ImageClassificationPredictionInstance
ImageClassificationPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Image Classification.
See more: google.cloud.aiplatform.v1.schema.predict.instance_v1.types.ImageClassificationPredictionInstance
google.cloud.aiplatform.v1.schema.predict.instance_v1.types.ImageObjectDetectionPredictionInstance
ImageObjectDetectionPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Image Object Detection.
See more: google.cloud.aiplatform.v1.schema.predict.instance_v1.types.ImageObjectDetectionPredictionInstance
google.cloud.aiplatform.v1.schema.predict.instance_v1.types.ImageSegmentationPredictionInstance
ImageSegmentationPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Image Segmentation.
See more: google.cloud.aiplatform.v1.schema.predict.instance_v1.types.ImageSegmentationPredictionInstance
google.cloud.aiplatform.v1.schema.predict.instance_v1.types.TextClassificationPredictionInstance
TextClassificationPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Text Classification.
See more: google.cloud.aiplatform.v1.schema.predict.instance_v1.types.TextClassificationPredictionInstance
google.cloud.aiplatform.v1.schema.predict.instance_v1.types.TextExtractionPredictionInstance
TextExtractionPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Text Extraction.
See more: google.cloud.aiplatform.v1.schema.predict.instance_v1.types.TextExtractionPredictionInstance
google.cloud.aiplatform.v1.schema.predict.instance_v1.types.TextSentimentPredictionInstance
TextSentimentPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Text Sentiment.
See more: google.cloud.aiplatform.v1.schema.predict.instance_v1.types.TextSentimentPredictionInstance
google.cloud.aiplatform.v1.schema.predict.instance_v1.types.VideoActionRecognitionPredictionInstance
VideoActionRecognitionPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Video Action Recognition.
See more: google.cloud.aiplatform.v1.schema.predict.instance_v1.types.VideoActionRecognitionPredictionInstance
google.cloud.aiplatform.v1.schema.predict.instance_v1.types.VideoClassificationPredictionInstance
VideoClassificationPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Video Classification.
See more: google.cloud.aiplatform.v1.schema.predict.instance_v1.types.VideoClassificationPredictionInstance
google.cloud.aiplatform.v1.schema.predict.instance_v1.types.VideoObjectTrackingPredictionInstance
VideoObjectTrackingPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Video Object Tracking.
See more: google.cloud.aiplatform.v1.schema.predict.instance_v1.types.VideoObjectTrackingPredictionInstance
google.cloud.aiplatform.v1.schema.predict.params_v1.types.ImageClassificationPredictionParams
ImageClassificationPredictionParams(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction model parameters for Image Classification.
See more: google.cloud.aiplatform.v1.schema.predict.params_v1.types.ImageClassificationPredictionParams
google.cloud.aiplatform.v1.schema.predict.params_v1.types.ImageObjectDetectionPredictionParams
ImageObjectDetectionPredictionParams(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction model parameters for Image Object Detection.
See more: google.cloud.aiplatform.v1.schema.predict.params_v1.types.ImageObjectDetectionPredictionParams
google.cloud.aiplatform.v1.schema.predict.params_v1.types.ImageSegmentationPredictionParams
ImageSegmentationPredictionParams(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction model parameters for Image Segmentation.
See more: google.cloud.aiplatform.v1.schema.predict.params_v1.types.ImageSegmentationPredictionParams
google.cloud.aiplatform.v1.schema.predict.params_v1.types.VideoActionRecognitionPredictionParams
VideoActionRecognitionPredictionParams(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction model parameters for Video Action Recognition.
See more: google.cloud.aiplatform.v1.schema.predict.params_v1.types.VideoActionRecognitionPredictionParams
google.cloud.aiplatform.v1.schema.predict.params_v1.types.VideoClassificationPredictionParams
VideoClassificationPredictionParams(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction model parameters for Video Classification.
See more: google.cloud.aiplatform.v1.schema.predict.params_v1.types.VideoClassificationPredictionParams
google.cloud.aiplatform.v1.schema.predict.params_v1.types.VideoObjectTrackingPredictionParams
VideoObjectTrackingPredictionParams(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction model parameters for Video Object Tracking.
See more: google.cloud.aiplatform.v1.schema.predict.params_v1.types.VideoObjectTrackingPredictionParams
google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.ClassificationPredictionResult
ClassificationPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Image and Text Classification.
See more: google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.ClassificationPredictionResult
google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.ImageObjectDetectionPredictionResult
ImageObjectDetectionPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Image Object Detection.
See more: google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.ImageObjectDetectionPredictionResult
google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.ImageSegmentationPredictionResult
ImageSegmentationPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Image Segmentation.
See more: google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.ImageSegmentationPredictionResult
google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.TabularClassificationPredictionResult
TabularClassificationPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Tabular Classification.
See more: google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.TabularClassificationPredictionResult
google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.TabularRegressionPredictionResult
TabularRegressionPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Tabular Regression.
See more: google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.TabularRegressionPredictionResult
google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.TextExtractionPredictionResult
TextExtractionPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Text Extraction.
See more: google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.TextExtractionPredictionResult
google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.TextSentimentPredictionResult
TextSentimentPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Text Sentiment .
See more: google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.TextSentimentPredictionResult
google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.VideoActionRecognitionPredictionResult
VideoActionRecognitionPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Video Action Recognition.
See more: google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.VideoActionRecognitionPredictionResult
google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.VideoClassificationPredictionResult
VideoClassificationPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Video Classification.
See more: google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.VideoClassificationPredictionResult
google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.VideoObjectTrackingPredictionResult
VideoObjectTrackingPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Video Object Tracking.
See more: google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.VideoObjectTrackingPredictionResult
google.cloud.aiplatform.v1.schema.predict.prediction_v1.types.VideoObjectTrackingPredictionResult.Frame
Frame(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The fields xMin
, xMax
, yMin
, and yMax
refer to a
bounding box, i.e.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageClassification
AutoMlImageClassification(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Image Classification Model.
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageClassification
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageClassificationInputs
AutoMlImageClassificationInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageClassificationInputs
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageClassificationInputs.ModelType
ModelType(value)
Values: MODEL_TYPE_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageClassificationMetadata
AutoMlImageClassificationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageClassificationMetadata
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageClassificationMetadata.SuccessfulStopReason
SuccessfulStopReason(value)
Values: SUCCESSFUL_STOP_REASON_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageObjectDetection
AutoMlImageObjectDetection(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Image Object Detection Model.
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageObjectDetection
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageObjectDetectionInputs
AutoMlImageObjectDetectionInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageObjectDetectionInputs
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageObjectDetectionInputs.ModelType
ModelType(value)
Values: MODEL_TYPE_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageObjectDetectionMetadata
AutoMlImageObjectDetectionMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageObjectDetectionMetadata
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageObjectDetectionMetadata.SuccessfulStopReason
SuccessfulStopReason(value)
Values: SUCCESSFUL_STOP_REASON_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageSegmentation
AutoMlImageSegmentation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Image Segmentation Model.
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageSegmentation
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageSegmentationInputs
AutoMlImageSegmentationInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageSegmentationInputs
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageSegmentationInputs.ModelType
ModelType(value)
Values: MODEL_TYPE_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageSegmentationMetadata
AutoMlImageSegmentationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageSegmentationMetadata
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlImageSegmentationMetadata.SuccessfulStopReason
SuccessfulStopReason(value)
Values: SUCCESSFUL_STOP_REASON_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTables
AutoMlTables(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Tables Model.
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTables
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesInputs
AutoMlTablesInputs(mapping=None, *, ignore_unknown_fields=False, **kwargs)
This message has oneof
_ fields (mutually exclusive fields).
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesInputs
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesInputs.Transformation
Transformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
This message has oneof
_ fields (mutually exclusive fields).
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesInputs.Transformation
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesInputs.Transformation.AutoTransformation
AutoTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will infer the proper transformation based on the statistic of dataset.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesInputs.Transformation.CategoricalArrayTransformation
CategoricalArrayTransformation(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Treats the column as categorical array and performs following transformation functions.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesInputs.Transformation.CategoricalTransformation
CategoricalTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will perform following transformation functions.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesInputs.Transformation.NumericArrayTransformation
NumericArrayTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Treats the column as numerical array and performs following transformation functions.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesInputs.Transformation.NumericTransformation
NumericTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will perform following transformation functions.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesInputs.Transformation.TextArrayTransformation
TextArrayTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Treats the column as text array and performs following transformation functions.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesInputs.Transformation.TextTransformation
TextTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will perform following transformation functions.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesInputs.Transformation.TimestampTransformation
TimestampTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will perform following transformation functions.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesMetadata
AutoMlTablesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Model metadata specific to AutoML Tables.
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTablesMetadata
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTextClassification
AutoMlTextClassification(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Text Classification Model.
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTextClassification
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTextClassificationInputs
AutoMlTextClassificationInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTextClassificationInputs
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTextExtraction
AutoMlTextExtraction(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Text Extraction Model.
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTextExtraction
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTextSentiment
AutoMlTextSentiment(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Text Sentiment Model.
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTextSentiment
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTextSentimentInputs
AutoMlTextSentimentInputs(mapping=None, *, ignore_unknown_fields=False, **kwargs)
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlTextSentimentInputs
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoActionRecognition
AutoMlVideoActionRecognition(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
A TrainingJob that trains and uploads an AutoML Video Action Recognition Model.
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoActionRecognition
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoActionRecognitionInputs
AutoMlVideoActionRecognitionInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoActionRecognitionInputs
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoActionRecognitionInputs.ModelType
ModelType(value)
Values: MODEL_TYPE_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoClassification
AutoMlVideoClassification(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Video Classification Model.
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoClassification
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoClassificationInputs
AutoMlVideoClassificationInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoClassificationInputs
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoClassificationInputs.ModelType
ModelType(value)
Values: MODEL_TYPE_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoObjectTracking
AutoMlVideoObjectTracking(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Video ObjectTracking Model.
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoObjectTracking
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoObjectTrackingInputs
AutoMlVideoObjectTrackingInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoObjectTrackingInputs
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.AutoMlVideoObjectTrackingInputs.ModelType
ModelType(value)
Values: MODEL_TYPE_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.ExportEvaluatedDataItemsConfig
ExportEvaluatedDataItemsConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Configuration for exporting test set predictions to a BigQuery table.
See more: google.cloud.aiplatform.v1.schema.trainingjob.definition_v1.types.ExportEvaluatedDataItemsConfig
google.cloud.aiplatform.v1beta1.schema.predict.instance_v1beta1.types.ImageClassificationPredictionInstance
ImageClassificationPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Image Classification.
google.cloud.aiplatform.v1beta1.schema.predict.instance_v1beta1.types.ImageObjectDetectionPredictionInstance
ImageObjectDetectionPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Image Object Detection.
google.cloud.aiplatform.v1beta1.schema.predict.instance_v1beta1.types.ImageSegmentationPredictionInstance
ImageSegmentationPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Image Segmentation.
google.cloud.aiplatform.v1beta1.schema.predict.instance_v1beta1.types.TextClassificationPredictionInstance
TextClassificationPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Text Classification.
google.cloud.aiplatform.v1beta1.schema.predict.instance_v1beta1.types.TextExtractionPredictionInstance
TextExtractionPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Text Extraction.
google.cloud.aiplatform.v1beta1.schema.predict.instance_v1beta1.types.TextSentimentPredictionInstance
TextSentimentPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Text Sentiment.
google.cloud.aiplatform.v1beta1.schema.predict.instance_v1beta1.types.VideoActionRecognitionPredictionInstance
VideoActionRecognitionPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Video Action Recognition.
google.cloud.aiplatform.v1beta1.schema.predict.instance_v1beta1.types.VideoClassificationPredictionInstance
VideoClassificationPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Video Classification.
google.cloud.aiplatform.v1beta1.schema.predict.instance_v1beta1.types.VideoObjectTrackingPredictionInstance
VideoObjectTrackingPredictionInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction input format for Video Object Tracking.
google.cloud.aiplatform.v1beta1.schema.predict.params_v1beta1.types.ImageClassificationPredictionParams
ImageClassificationPredictionParams(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction model parameters for Image Classification.
google.cloud.aiplatform.v1beta1.schema.predict.params_v1beta1.types.ImageObjectDetectionPredictionParams
ImageObjectDetectionPredictionParams(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction model parameters for Image Object Detection.
google.cloud.aiplatform.v1beta1.schema.predict.params_v1beta1.types.ImageSegmentationPredictionParams
ImageSegmentationPredictionParams(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction model parameters for Image Segmentation.
google.cloud.aiplatform.v1beta1.schema.predict.params_v1beta1.types.VideoActionRecognitionPredictionParams
VideoActionRecognitionPredictionParams(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction model parameters for Video Action Recognition.
google.cloud.aiplatform.v1beta1.schema.predict.params_v1beta1.types.VideoClassificationPredictionParams
VideoClassificationPredictionParams(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction model parameters for Video Classification.
google.cloud.aiplatform.v1beta1.schema.predict.params_v1beta1.types.VideoObjectTrackingPredictionParams
VideoObjectTrackingPredictionParams(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction model parameters for Video Object Tracking.
google.cloud.aiplatform.v1beta1.schema.predict.prediction_v1beta1.types.ClassificationPredictionResult
ClassificationPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Image and Text Classification.
google.cloud.aiplatform.v1beta1.schema.predict.prediction_v1beta1.types.ImageObjectDetectionPredictionResult
ImageObjectDetectionPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Image Object Detection.
google.cloud.aiplatform.v1beta1.schema.predict.prediction_v1beta1.types.ImageSegmentationPredictionResult
ImageSegmentationPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Image Segmentation.
google.cloud.aiplatform.v1beta1.schema.predict.prediction_v1beta1.types.TabularClassificationPredictionResult
TabularClassificationPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Tabular Classification.
google.cloud.aiplatform.v1beta1.schema.predict.prediction_v1beta1.types.TabularRegressionPredictionResult
TabularRegressionPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Tabular Regression.
google.cloud.aiplatform.v1beta1.schema.predict.prediction_v1beta1.types.TextExtractionPredictionResult
TextExtractionPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Text Extraction.
google.cloud.aiplatform.v1beta1.schema.predict.prediction_v1beta1.types.TextSentimentPredictionResult
TextSentimentPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Text Sentiment .
google.cloud.aiplatform.v1beta1.schema.predict.prediction_v1beta1.types.TimeSeriesForecastingPredictionResult
TimeSeriesForecastingPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Time Series Forecasting.
google.cloud.aiplatform.v1beta1.schema.predict.prediction_v1beta1.types.VideoActionRecognitionPredictionResult
VideoActionRecognitionPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Video Action Recognition.
google.cloud.aiplatform.v1beta1.schema.predict.prediction_v1beta1.types.VideoClassificationPredictionResult
VideoClassificationPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Video Classification.
google.cloud.aiplatform.v1beta1.schema.predict.prediction_v1beta1.types.VideoObjectTrackingPredictionResult
VideoObjectTrackingPredictionResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Prediction output format for Video Object Tracking.
google.cloud.aiplatform.v1beta1.schema.predict.prediction_v1beta1.types.VideoObjectTrackingPredictionResult.Frame
Frame(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The fields xMin
, xMax
, yMin
, and yMax
refer to a
bounding box, i.e.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlForecasting
AutoMlForecasting(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Forecasting Model.
See more: google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlForecasting
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlForecastingInputs
AutoMlForecastingInputs(mapping=None, *, ignore_unknown_fields=False, **kwargs)
See more: google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlForecastingInputs
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlForecastingInputs.Granularity
Granularity(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A duration of time expressed in time granularity units.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlForecastingInputs.Transformation
Transformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
This message has oneof
_ fields (mutually exclusive fields).
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlForecastingInputs.Transformation.AutoTransformation
AutoTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will infer the proper transformation based on the statistic of dataset.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlForecastingInputs.Transformation.CategoricalTransformation
CategoricalTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will perform following transformation functions.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlForecastingInputs.Transformation.NumericTransformation
NumericTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will perform following transformation functions.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlForecastingInputs.Transformation.TextTransformation
TextTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will perform following transformation functions.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlForecastingInputs.Transformation.TimestampTransformation
TimestampTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will perform following transformation functions.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlForecastingMetadata
AutoMlForecastingMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Model metadata specific to AutoML Forecasting.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageClassification
AutoMlImageClassification(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Image Classification Model.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageClassificationInputs
AutoMlImageClassificationInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageClassificationInputs.ModelType
ModelType(value)
Values: MODEL_TYPE_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageClassificationMetadata
AutoMlImageClassificationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageClassificationMetadata.SuccessfulStopReason
SuccessfulStopReason(value)
Values: SUCCESSFUL_STOP_REASON_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageObjectDetection
AutoMlImageObjectDetection(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Image Object Detection Model.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageObjectDetectionInputs
AutoMlImageObjectDetectionInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageObjectDetectionInputs.ModelType
ModelType(value)
Values: MODEL_TYPE_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageObjectDetectionMetadata
AutoMlImageObjectDetectionMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageObjectDetectionMetadata.SuccessfulStopReason
SuccessfulStopReason(value)
Values: SUCCESSFUL_STOP_REASON_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageSegmentation
AutoMlImageSegmentation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Image Segmentation Model.
See more: google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageSegmentation
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageSegmentationInputs
AutoMlImageSegmentationInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageSegmentationInputs.ModelType
ModelType(value)
Values: MODEL_TYPE_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageSegmentationMetadata
AutoMlImageSegmentationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlImageSegmentationMetadata.SuccessfulStopReason
SuccessfulStopReason(value)
Values: SUCCESSFUL_STOP_REASON_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTables
AutoMlTables(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Tables Model.
See more: google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTables
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesInputs
AutoMlTablesInputs(mapping=None, *, ignore_unknown_fields=False, **kwargs)
This message has oneof
_ fields (mutually exclusive fields).
See more: google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesInputs
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesInputs.Transformation
Transformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
This message has oneof
_ fields (mutually exclusive fields).
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesInputs.Transformation.AutoTransformation
AutoTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will infer the proper transformation based on the statistic of dataset.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesInputs.Transformation.CategoricalArrayTransformation
CategoricalArrayTransformation(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Treats the column as categorical array and performs following transformation functions.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesInputs.Transformation.CategoricalTransformation
CategoricalTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will perform following transformation functions.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesInputs.Transformation.NumericArrayTransformation
NumericArrayTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Treats the column as numerical array and performs following transformation functions.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesInputs.Transformation.NumericTransformation
NumericTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will perform following transformation functions.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesInputs.Transformation.TextArrayTransformation
TextArrayTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Treats the column as text array and performs following transformation functions.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesInputs.Transformation.TextTransformation
TextTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will perform following transformation functions.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesInputs.Transformation.TimestampTransformation
TimestampTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training pipeline will perform following transformation functions.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesMetadata
AutoMlTablesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Model metadata specific to AutoML Tables.
See more: google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTablesMetadata
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTextClassification
AutoMlTextClassification(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Text Classification Model.
See more: google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTextClassification
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTextClassificationInputs
AutoMlTextClassificationInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTextExtraction
AutoMlTextExtraction(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Text Extraction Model.
See more: google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTextExtraction
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTextSentiment
AutoMlTextSentiment(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Text Sentiment Model.
See more: google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTextSentiment
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlTextSentimentInputs
AutoMlTextSentimentInputs(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlVideoActionRecognition
AutoMlVideoActionRecognition(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
A TrainingJob that trains and uploads an AutoML Video Action Recognition Model.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlVideoActionRecognitionInputs
AutoMlVideoActionRecognitionInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlVideoActionRecognitionInputs.ModelType
ModelType(value)
Values: MODEL_TYPE_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlVideoClassification
AutoMlVideoClassification(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Video Classification Model.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlVideoClassificationInputs
AutoMlVideoClassificationInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlVideoClassificationInputs.ModelType
ModelType(value)
Values: MODEL_TYPE_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlVideoObjectTracking
AutoMlVideoObjectTracking(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TrainingJob that trains and uploads an AutoML Video ObjectTracking Model.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlVideoObjectTrackingInputs
AutoMlVideoObjectTrackingInputs(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.AutoMlVideoObjectTrackingInputs.ModelType
ModelType(value)
Values: MODEL_TYPE_UNSPECIFIED (0): Should not be set.
google.cloud.aiplatform.v1beta1.schema.trainingjob.definition_v1beta1.types.ExportEvaluatedDataItemsConfig
ExportEvaluatedDataItemsConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Configuration for exporting test set predictions to a BigQuery table.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient
DatasetServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.dataset_service.transports.base.DatasetServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the dataset service async client.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.annotation_path
annotation_path(
project: str, location: str, dataset: str, data_item: str, annotation: str
) -> str
Returns a fully-qualified annotation string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.annotation_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.annotation_spec_path
annotation_spec_path(
project: str, location: str, dataset: str, annotation_spec: str
) -> str
Returns a fully-qualified annotation_spec string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.annotation_spec_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.create_dataset
create_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.CreateDatasetRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
dataset: typing.Optional[google.cloud.aiplatform_v1.types.dataset.Dataset] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.create_dataset
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.create_dataset_version
create_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.CreateDatasetVersionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
dataset_version: typing.Optional[
google.cloud.aiplatform_v1.types.dataset_version.DatasetVersion
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Create a version from a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.create_dataset_version
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.data_item_path
data_item_path(project: str, location: str, dataset: str, data_item: str) -> str
Returns a fully-qualified data_item string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.data_item_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.dataset_path
dataset_path(project: str, location: str, dataset: str) -> str
Returns a fully-qualified dataset string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.dataset_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.dataset_version_path
dataset_version_path(
project: str, location: str, dataset: str, dataset_version: str
) -> str
Returns a fully-qualified dataset_version string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.dataset_version_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.delete_dataset
delete_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.DeleteDatasetRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.delete_dataset
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.delete_dataset_version
delete_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.DeleteDatasetVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a Dataset version.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.delete_dataset_version
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.delete_saved_query
delete_saved_query(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.DeleteSavedQueryRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a SavedQuery.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.delete_saved_query
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.export_data
export_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ExportDataRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
export_config: typing.Optional[
google.cloud.aiplatform_v1.types.dataset.ExportDataConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Exports data from a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.export_data
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_annotation_spec
get_annotation_spec(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.GetAnnotationSpecRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.annotation_spec.AnnotationSpec
Gets an AnnotationSpec.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_annotation_spec
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_dataset
get_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.GetDatasetRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.dataset.Dataset
Gets a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_dataset
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_dataset_version
get_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.GetDatasetVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.dataset_version.DatasetVersion
Gets a Dataset version.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_dataset_version
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.dataset_service.transports.base.DatasetServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.import_data
import_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ImportDataRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
import_configs: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.dataset.ImportDataConfig
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports data into a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.import_data
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_annotations
list_annotations(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ListAnnotationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListAnnotationsAsyncPager
)
Lists Annotations belongs to a dataitem.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_annotations
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_data_items
list_data_items(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ListDataItemsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDataItemsAsyncPager
Lists DataItems in a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_data_items
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_dataset_versions
list_dataset_versions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ListDatasetVersionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetVersionsAsyncPager
)
Lists DatasetVersions in a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_dataset_versions
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_datasets
list_datasets(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ListDatasetsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetsAsyncPager
Lists Datasets in a Location.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_datasets
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_saved_queries
list_saved_queries(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ListSavedQueriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListSavedQueriesAsyncPager
)
Lists SavedQueries in a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.list_saved_queries
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_annotation_path
parse_annotation_path(path: str) -> typing.Dict[str, str]
Parses a annotation path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_annotation_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_annotation_spec_path
parse_annotation_spec_path(path: str) -> typing.Dict[str, str]
Parses a annotation_spec path into its component segments.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_data_item_path
parse_data_item_path(path: str) -> typing.Dict[str, str]
Parses a data_item path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_data_item_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_dataset_path
parse_dataset_path(path: str) -> typing.Dict[str, str]
Parses a dataset path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_dataset_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_dataset_version_path
parse_dataset_version_path(path: str) -> typing.Dict[str, str]
Parses a dataset_version path into its component segments.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_saved_query_path
parse_saved_query_path(path: str) -> typing.Dict[str, str]
Parses a saved_query path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.parse_saved_query_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.restore_dataset_version
restore_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.RestoreDatasetVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Restores a dataset version.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.saved_query_path
saved_query_path(
project: str, location: str, dataset: str, saved_query: str
) -> str
Returns a fully-qualified saved_query string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.saved_query_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.search_data_items
search_data_items(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.SearchDataItemsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.dataset_service.pagers.SearchDataItemsAsyncPager
)
Searches DataItems in a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.search_data_items
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.update_dataset
update_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.UpdateDatasetRequest, dict
]
] = None,
*,
dataset: typing.Optional[google.cloud.aiplatform_v1.types.dataset.Dataset] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.dataset.Dataset
Updates a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.update_dataset
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient
DatasetServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.dataset_service.transports.base.DatasetServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the dataset service client.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.exit
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.annotation_path
annotation_path(
project: str, location: str, dataset: str, data_item: str, annotation: str
) -> str
Returns a fully-qualified annotation string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.annotation_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.annotation_spec_path
annotation_spec_path(
project: str, location: str, dataset: str, annotation_spec: str
) -> str
Returns a fully-qualified annotation_spec string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.annotation_spec_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.common_billing_account_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.common_location_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.common_organization_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.common_project_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.create_dataset
create_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.CreateDatasetRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
dataset: typing.Optional[google.cloud.aiplatform_v1.types.dataset.Dataset] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.create_dataset
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.create_dataset_version
create_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.CreateDatasetVersionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
dataset_version: typing.Optional[
google.cloud.aiplatform_v1.types.dataset_version.DatasetVersion
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Create a version from a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.create_dataset_version
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.data_item_path
data_item_path(project: str, location: str, dataset: str, data_item: str) -> str
Returns a fully-qualified data_item string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.data_item_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.dataset_path
dataset_path(project: str, location: str, dataset: str) -> str
Returns a fully-qualified dataset string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.dataset_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.dataset_version_path
dataset_version_path(
project: str, location: str, dataset: str, dataset_version: str
) -> str
Returns a fully-qualified dataset_version string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.dataset_version_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.delete_dataset
delete_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.DeleteDatasetRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.delete_dataset
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.delete_dataset_version
delete_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.DeleteDatasetVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a Dataset version.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.delete_dataset_version
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.delete_operation
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.delete_saved_query
delete_saved_query(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.DeleteSavedQueryRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a SavedQuery.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.delete_saved_query
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.export_data
export_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ExportDataRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
export_config: typing.Optional[
google.cloud.aiplatform_v1.types.dataset.ExportDataConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Exports data from a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.export_data
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.from_service_account_file
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.from_service_account_info
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.from_service_account_json
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_annotation_spec
get_annotation_spec(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.GetAnnotationSpecRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.annotation_spec.AnnotationSpec
Gets an AnnotationSpec.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_annotation_spec
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_dataset
get_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.GetDatasetRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.dataset.Dataset
Gets a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_dataset
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_dataset_version
get_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.GetDatasetVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.dataset_version.DatasetVersion
Gets a Dataset version.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_dataset_version
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_location
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.get_operation
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.import_data
import_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ImportDataRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
import_configs: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.dataset.ImportDataConfig
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Imports data into a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.import_data
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_annotations
list_annotations(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ListAnnotationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.dataset_service.pagers.ListAnnotationsPager
Lists Annotations belongs to a dataitem.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_annotations
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_data_items
list_data_items(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ListDataItemsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDataItemsPager
Lists DataItems in a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_data_items
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_dataset_versions
list_dataset_versions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ListDatasetVersionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetVersionsPager
)
Lists DatasetVersions in a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_dataset_versions
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_datasets
list_datasets(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ListDatasetsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetsPager
Lists Datasets in a Location.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_datasets
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_locations
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_operations
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_saved_queries
list_saved_queries(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.ListSavedQueriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.dataset_service.pagers.ListSavedQueriesPager
Lists SavedQueries in a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.list_saved_queries
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_annotation_path
parse_annotation_path(path: str) -> typing.Dict[str, str]
Parses a annotation path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_annotation_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_annotation_spec_path
parse_annotation_spec_path(path: str) -> typing.Dict[str, str]
Parses a annotation_spec path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_annotation_spec_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_common_location_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_common_project_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_data_item_path
parse_data_item_path(path: str) -> typing.Dict[str, str]
Parses a data_item path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_data_item_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_dataset_path
parse_dataset_path(path: str) -> typing.Dict[str, str]
Parses a dataset path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_dataset_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_dataset_version_path
parse_dataset_version_path(path: str) -> typing.Dict[str, str]
Parses a dataset_version path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_dataset_version_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_saved_query_path
parse_saved_query_path(path: str) -> typing.Dict[str, str]
Parses a saved_query path into its component segments.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.parse_saved_query_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.restore_dataset_version
restore_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.RestoreDatasetVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Restores a dataset version.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.restore_dataset_version
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.saved_query_path
saved_query_path(
project: str, location: str, dataset: str, saved_query: str
) -> str
Returns a fully-qualified saved_query string.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.saved_query_path
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.search_data_items
search_data_items(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.SearchDataItemsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.dataset_service.pagers.SearchDataItemsPager
Searches DataItems in a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.search_data_items
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.update_dataset
update_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.dataset_service.UpdateDatasetRequest, dict
]
] = None,
*,
dataset: typing.Optional[google.cloud.aiplatform_v1.types.dataset.Dataset] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.dataset.Dataset
Updates a Dataset.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.update_dataset
google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.dataset_service.DatasetServiceClient.wait_operation
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListAnnotationsAsyncPager
ListAnnotationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.dataset_service.ListAnnotationsResponse
],
],
request: google.cloud.aiplatform_v1.types.dataset_service.ListAnnotationsRequest,
response: google.cloud.aiplatform_v1.types.dataset_service.ListAnnotationsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.dataset_service.pagers.ListAnnotationsAsyncPager
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListAnnotationsPager
ListAnnotationsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.dataset_service.ListAnnotationsResponse
],
request: google.cloud.aiplatform_v1.types.dataset_service.ListAnnotationsRequest,
response: google.cloud.aiplatform_v1.types.dataset_service.ListAnnotationsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.dataset_service.pagers.ListAnnotationsPager
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDataItemsAsyncPager
ListDataItemsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.dataset_service.ListDataItemsResponse
],
],
request: google.cloud.aiplatform_v1.types.dataset_service.ListDataItemsRequest,
response: google.cloud.aiplatform_v1.types.dataset_service.ListDataItemsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDataItemsAsyncPager
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDataItemsPager
ListDataItemsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.dataset_service.ListDataItemsResponse
],
request: google.cloud.aiplatform_v1.types.dataset_service.ListDataItemsRequest,
response: google.cloud.aiplatform_v1.types.dataset_service.ListDataItemsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDataItemsPager
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetVersionsAsyncPager
ListDatasetVersionsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.dataset_service.ListDatasetVersionsResponse
],
],
request: google.cloud.aiplatform_v1.types.dataset_service.ListDatasetVersionsRequest,
response: google.cloud.aiplatform_v1.types.dataset_service.ListDatasetVersionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetVersionsAsyncPager
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetVersionsPager
ListDatasetVersionsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.dataset_service.ListDatasetVersionsResponse,
],
request: google.cloud.aiplatform_v1.types.dataset_service.ListDatasetVersionsRequest,
response: google.cloud.aiplatform_v1.types.dataset_service.ListDatasetVersionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetVersionsPager
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetsAsyncPager
ListDatasetsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.dataset_service.ListDatasetsResponse
],
],
request: google.cloud.aiplatform_v1.types.dataset_service.ListDatasetsRequest,
response: google.cloud.aiplatform_v1.types.dataset_service.ListDatasetsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetsAsyncPager
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetsPager
ListDatasetsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.dataset_service.ListDatasetsResponse
],
request: google.cloud.aiplatform_v1.types.dataset_service.ListDatasetsRequest,
response: google.cloud.aiplatform_v1.types.dataset_service.ListDatasetsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetsPager
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListSavedQueriesAsyncPager
ListSavedQueriesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.dataset_service.ListSavedQueriesResponse
],
],
request: google.cloud.aiplatform_v1.types.dataset_service.ListSavedQueriesRequest,
response: google.cloud.aiplatform_v1.types.dataset_service.ListSavedQueriesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.dataset_service.pagers.ListSavedQueriesAsyncPager
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListSavedQueriesPager
ListSavedQueriesPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.dataset_service.ListSavedQueriesResponse
],
request: google.cloud.aiplatform_v1.types.dataset_service.ListSavedQueriesRequest,
response: google.cloud.aiplatform_v1.types.dataset_service.ListSavedQueriesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.dataset_service.pagers.ListSavedQueriesPager
google.cloud.aiplatform_v1.services.dataset_service.pagers.SearchDataItemsAsyncPager
SearchDataItemsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.dataset_service.SearchDataItemsResponse
],
],
request: google.cloud.aiplatform_v1.types.dataset_service.SearchDataItemsRequest,
response: google.cloud.aiplatform_v1.types.dataset_service.SearchDataItemsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.dataset_service.pagers.SearchDataItemsAsyncPager
google.cloud.aiplatform_v1.services.dataset_service.pagers.SearchDataItemsPager
SearchDataItemsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.dataset_service.SearchDataItemsResponse
],
request: google.cloud.aiplatform_v1.types.dataset_service.SearchDataItemsRequest,
response: google.cloud.aiplatform_v1.types.dataset_service.SearchDataItemsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.dataset_service.pagers.SearchDataItemsPager
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient
DeploymentResourcePoolServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.deployment_resource_pool_service.transports.base.DeploymentResourcePoolServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the deployment resource pool service async client.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.create_deployment_resource_pool
create_deployment_resource_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.CreateDeploymentResourcePoolRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
deployment_resource_pool: typing.Optional[
google.cloud.aiplatform_v1.types.deployment_resource_pool.DeploymentResourcePool
] = None,
deployment_resource_pool_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Create a DeploymentResourcePool.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.delete_deployment_resource_pool
delete_deployment_resource_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.DeleteDeploymentResourcePoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Delete a DeploymentResourcePool.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.deployment_resource_pool_path
deployment_resource_pool_path(
project: str, location: str, deployment_resource_pool: str
) -> str
Returns a fully-qualified deployment_resource_pool string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.get_deployment_resource_pool
get_deployment_resource_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.GetDeploymentResourcePoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.deployment_resource_pool.DeploymentResourcePool
Get a DeploymentResourcePool.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.transports.base.DeploymentResourcePoolServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.list_deployment_resource_pools
list_deployment_resource_pools(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.pagers.ListDeploymentResourcePoolsAsyncPager
)
List DeploymentResourcePools in a location.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_deployment_resource_pool_path
parse_deployment_resource_pool_path(path: str) -> typing.Dict[str, str]
Parses a deployment_resource_pool path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.query_deployed_models
query_deployed_models(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.QueryDeployedModelsRequest,
dict,
]
] = None,
*,
deployment_resource_pool: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.pagers.QueryDeployedModelsAsyncPager
)
List DeployedModels that have been deployed on this DeploymentResourcePool.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient
DeploymentResourcePoolServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.deployment_resource_pool_service.transports.base.DeploymentResourcePoolServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the deployment resource pool service client.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.create_deployment_resource_pool
create_deployment_resource_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.CreateDeploymentResourcePoolRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
deployment_resource_pool: typing.Optional[
google.cloud.aiplatform_v1.types.deployment_resource_pool.DeploymentResourcePool
] = None,
deployment_resource_pool_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Create a DeploymentResourcePool.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.delete_deployment_resource_pool
delete_deployment_resource_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.DeleteDeploymentResourcePoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Delete a DeploymentResourcePool.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.deployment_resource_pool_path
deployment_resource_pool_path(
project: str, location: str, deployment_resource_pool: str
) -> str
Returns a fully-qualified deployment_resource_pool string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.get_deployment_resource_pool
get_deployment_resource_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.GetDeploymentResourcePoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.deployment_resource_pool.DeploymentResourcePool
Get a DeploymentResourcePool.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.list_deployment_resource_pools
list_deployment_resource_pools(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.pagers.ListDeploymentResourcePoolsPager
)
List DeploymentResourcePools in a location.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_deployment_resource_pool_path
parse_deployment_resource_pool_path(path: str) -> typing.Dict[str, str]
Parses a deployment_resource_pool path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.query_deployed_models
query_deployed_models(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.QueryDeployedModelsRequest,
dict,
]
] = None,
*,
deployment_resource_pool: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.pagers.QueryDeployedModelsPager
)
List DeployedModels that have been deployed on this DeploymentResourcePool.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.pagers.ListDeploymentResourcePoolsAsyncPager
ListDeploymentResourcePoolsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsResponse
],
],
request: google.cloud.aiplatform_v1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsRequest,
response: google.cloud.aiplatform_v1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.pagers.ListDeploymentResourcePoolsPager
ListDeploymentResourcePoolsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsResponse,
],
request: google.cloud.aiplatform_v1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsRequest,
response: google.cloud.aiplatform_v1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.pagers.QueryDeployedModelsAsyncPager
QueryDeployedModelsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.QueryDeployedModelsResponse
],
],
request: google.cloud.aiplatform_v1.types.deployment_resource_pool_service.QueryDeployedModelsRequest,
response: google.cloud.aiplatform_v1.types.deployment_resource_pool_service.QueryDeployedModelsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1.services.deployment_resource_pool_service.pagers.QueryDeployedModelsPager
QueryDeployedModelsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.deployment_resource_pool_service.QueryDeployedModelsResponse,
],
request: google.cloud.aiplatform_v1.types.deployment_resource_pool_service.QueryDeployedModelsRequest,
response: google.cloud.aiplatform_v1.types.deployment_resource_pool_service.QueryDeployedModelsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.deployment_resource_pool_service.pagers.QueryDeployedModelsPager
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient
EndpointServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.endpoint_service.transports.base.EndpointServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the endpoint service async client.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.create_endpoint
create_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.CreateEndpointRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
endpoint: typing.Optional[
google.cloud.aiplatform_v1.types.endpoint.Endpoint
] = None,
endpoint_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates an Endpoint.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.create_endpoint
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.delete_endpoint
delete_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.DeleteEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes an Endpoint.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.delete_endpoint
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.deploy_model
deploy_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.DeployModelRequest, dict
]
] = None,
*,
endpoint: typing.Optional[str] = None,
deployed_model: typing.Optional[
google.cloud.aiplatform_v1.types.endpoint.DeployedModel
] = None,
traffic_split: typing.Optional[typing.MutableMapping[str, int]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deploys a Model into this Endpoint, creating a DeployedModel within it.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.deploy_model
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.deployment_resource_pool_path
deployment_resource_pool_path(
project: str, location: str, deployment_resource_pool: str
) -> str
Returns a fully-qualified deployment_resource_pool string.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.endpoint_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.get_endpoint
get_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.GetEndpointRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.endpoint.Endpoint
Gets an Endpoint.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.get_endpoint
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.endpoint_service.transports.base.EndpointServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.list_endpoints
list_endpoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.ListEndpointsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.endpoint_service.pagers.ListEndpointsAsyncPager
)
Lists Endpoints in a Location.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.list_endpoints
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.model_deployment_monitoring_job_path
model_deployment_monitoring_job_path(
project: str, location: str, model_deployment_monitoring_job: str
) -> str
Returns a fully-qualified model_deployment_monitoring_job string.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.model_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.mutate_deployed_model
mutate_deployed_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.MutateDeployedModelRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
deployed_model: typing.Optional[
google.cloud.aiplatform_v1.types.endpoint.DeployedModel
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an existing deployed model.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.network_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_deployment_resource_pool_path
parse_deployment_resource_pool_path(path: str) -> typing.Dict[str, str]
Parses a deployment_resource_pool path into its component segments.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_endpoint_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_model_deployment_monitoring_job_path
parse_model_deployment_monitoring_job_path(path: str) -> typing.Dict[str, str]
Parses a model_deployment_monitoring_job path into its component segments.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_model_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.parse_network_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.undeploy_model
undeploy_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.UndeployModelRequest, dict
]
] = None,
*,
endpoint: typing.Optional[str] = None,
deployed_model_id: typing.Optional[str] = None,
traffic_split: typing.Optional[typing.MutableMapping[str, int]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.undeploy_model
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.update_endpoint
update_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.UpdateEndpointRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[
google.cloud.aiplatform_v1.types.endpoint.Endpoint
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.endpoint.Endpoint
Updates an Endpoint.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.update_endpoint
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient
EndpointServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.endpoint_service.transports.base.EndpointServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the endpoint service client.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.exit
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.common_location_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.common_organization_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.common_project_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.create_endpoint
create_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.CreateEndpointRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
endpoint: typing.Optional[
google.cloud.aiplatform_v1.types.endpoint.Endpoint
] = None,
endpoint_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates an Endpoint.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.create_endpoint
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.delete_endpoint
delete_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.DeleteEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes an Endpoint.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.delete_endpoint
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.delete_operation
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.deploy_model
deploy_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.DeployModelRequest, dict
]
] = None,
*,
endpoint: typing.Optional[str] = None,
deployed_model: typing.Optional[
google.cloud.aiplatform_v1.types.endpoint.DeployedModel
] = None,
traffic_split: typing.Optional[typing.MutableMapping[str, int]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deploys a Model into this Endpoint, creating a DeployedModel within it.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.deploy_model
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.deployment_resource_pool_path
deployment_resource_pool_path(
project: str, location: str, deployment_resource_pool: str
) -> str
Returns a fully-qualified deployment_resource_pool string.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.endpoint_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.from_service_account_file
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.from_service_account_info
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.from_service_account_json
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.get_endpoint
get_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.GetEndpointRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.endpoint.Endpoint
Gets an Endpoint.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.get_endpoint
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.get_location
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.get_operation
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.list_endpoints
list_endpoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.ListEndpointsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.endpoint_service.pagers.ListEndpointsPager
Lists Endpoints in a Location.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.list_endpoints
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.list_locations
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.list_operations
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.model_deployment_monitoring_job_path
model_deployment_monitoring_job_path(
project: str, location: str, model_deployment_monitoring_job: str
) -> str
Returns a fully-qualified model_deployment_monitoring_job string.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.model_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.mutate_deployed_model
mutate_deployed_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.MutateDeployedModelRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
deployed_model: typing.Optional[
google.cloud.aiplatform_v1.types.endpoint.DeployedModel
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates an existing deployed model.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.mutate_deployed_model
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.network_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_common_project_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_deployment_resource_pool_path
parse_deployment_resource_pool_path(path: str) -> typing.Dict[str, str]
Parses a deployment_resource_pool path into its component segments.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_endpoint_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_model_deployment_monitoring_job_path
parse_model_deployment_monitoring_job_path(path: str) -> typing.Dict[str, str]
Parses a model_deployment_monitoring_job path into its component segments.
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_model_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.parse_network_path
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.undeploy_model
undeploy_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.UndeployModelRequest, dict
]
] = None,
*,
endpoint: typing.Optional[str] = None,
deployed_model_id: typing.Optional[str] = None,
traffic_split: typing.Optional[typing.MutableMapping[str, int]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.undeploy_model
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.update_endpoint
update_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.endpoint_service.UpdateEndpointRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[
google.cloud.aiplatform_v1.types.endpoint.Endpoint
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.endpoint.Endpoint
Updates an Endpoint.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.update_endpoint
google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.endpoint_service.EndpointServiceClient.wait_operation
google.cloud.aiplatform_v1.services.endpoint_service.pagers.ListEndpointsAsyncPager
ListEndpointsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.endpoint_service.ListEndpointsResponse
],
],
request: google.cloud.aiplatform_v1.types.endpoint_service.ListEndpointsRequest,
response: google.cloud.aiplatform_v1.types.endpoint_service.ListEndpointsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.endpoint_service.pagers.ListEndpointsAsyncPager
google.cloud.aiplatform_v1.services.endpoint_service.pagers.ListEndpointsPager
ListEndpointsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.endpoint_service.ListEndpointsResponse
],
request: google.cloud.aiplatform_v1.types.endpoint_service.ListEndpointsRequest,
response: google.cloud.aiplatform_v1.types.endpoint_service.ListEndpointsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.endpoint_service.pagers.ListEndpointsPager
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient
FeatureOnlineStoreAdminServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.feature_online_store_admin_service.transports.base.FeatureOnlineStoreAdminServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the feature online store admin service async client.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.create_feature_online_store
create_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.CreateFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature_online_store: typing.Optional[
google.cloud.aiplatform_v1.types.feature_online_store.FeatureOnlineStore
] = None,
feature_online_store_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new FeatureOnlineStore in a given project and location.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.create_feature_view
create_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.CreateFeatureViewRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature_view: typing.Optional[
google.cloud.aiplatform_v1.types.feature_view.FeatureView
] = None,
feature_view_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new FeatureView in a given FeatureOnlineStore.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.delete_feature_online_store
delete_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.DeleteFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single FeatureOnlineStore.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.delete_feature_view
delete_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.DeleteFeatureViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.feature_online_store_path
feature_online_store_path(
project: str, location: str, feature_online_store: str
) -> str
Returns a fully-qualified feature_online_store string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.feature_view_path
feature_view_path(
project: str, location: str, feature_online_store: str, feature_view: str
) -> str
Returns a fully-qualified feature_view string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.feature_view_sync_path
feature_view_sync_path(
project: str, location: str, feature_online_store: str, feature_view: str
) -> str
Returns a fully-qualified feature_view_sync string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_feature_online_store
get_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.GetFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature_online_store.FeatureOnlineStore
Gets details of a single FeatureOnlineStore.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_feature_view
get_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.GetFeatureViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature_view.FeatureView
Gets details of a single FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_feature_view_sync
get_feature_view_sync(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.GetFeatureViewSyncRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature_view_sync.FeatureViewSync
Gets details of a single FeatureViewSync.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.transports.base.FeatureOnlineStoreAdminServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.list_feature_online_stores
list_feature_online_stores(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureOnlineStoresRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureOnlineStoresAsyncPager
)
Lists FeatureOnlineStores in a given project and location.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.list_feature_view_syncs
list_feature_view_syncs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewSyncsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureViewSyncsAsyncPager
)
Lists FeatureViewSyncs in a given FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.list_feature_views
list_feature_views(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureViewsAsyncPager
)
Lists FeatureViews in a given FeatureOnlineStore.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_feature_online_store_path
parse_feature_online_store_path(path: str) -> typing.Dict[str, str]
Parses a feature_online_store path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_feature_view_path
parse_feature_view_path(path: str) -> typing.Dict[str, str]
Parses a feature_view path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_feature_view_sync_path
parse_feature_view_sync_path(path: str) -> typing.Dict[str, str]
Parses a feature_view_sync path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.sync_feature_view
sync_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.SyncFeatureViewRequest,
dict,
]
] = None,
*,
feature_view: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.SyncFeatureViewResponse
)
Triggers on-demand sync for the FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.update_feature_online_store
update_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.UpdateFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
feature_online_store: typing.Optional[
google.cloud.aiplatform_v1.types.feature_online_store.FeatureOnlineStore
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single FeatureOnlineStore.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.update_feature_view
update_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.UpdateFeatureViewRequest,
dict,
]
] = None,
*,
feature_view: typing.Optional[
google.cloud.aiplatform_v1.types.feature_view.FeatureView
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient
FeatureOnlineStoreAdminServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.feature_online_store_admin_service.transports.base.FeatureOnlineStoreAdminServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the feature online store admin service client.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.create_feature_online_store
create_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.CreateFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature_online_store: typing.Optional[
google.cloud.aiplatform_v1.types.feature_online_store.FeatureOnlineStore
] = None,
feature_online_store_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new FeatureOnlineStore in a given project and location.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.create_feature_view
create_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.CreateFeatureViewRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature_view: typing.Optional[
google.cloud.aiplatform_v1.types.feature_view.FeatureView
] = None,
feature_view_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new FeatureView in a given FeatureOnlineStore.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.delete_feature_online_store
delete_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.DeleteFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single FeatureOnlineStore.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.delete_feature_view
delete_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.DeleteFeatureViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.feature_online_store_path
feature_online_store_path(
project: str, location: str, feature_online_store: str
) -> str
Returns a fully-qualified feature_online_store string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.feature_view_path
feature_view_path(
project: str, location: str, feature_online_store: str, feature_view: str
) -> str
Returns a fully-qualified feature_view string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.feature_view_sync_path
feature_view_sync_path(
project: str, location: str, feature_online_store: str, feature_view: str
) -> str
Returns a fully-qualified feature_view_sync string.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_feature_online_store
get_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.GetFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature_online_store.FeatureOnlineStore
Gets details of a single FeatureOnlineStore.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_feature_view
get_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.GetFeatureViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature_view.FeatureView
Gets details of a single FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_feature_view_sync
get_feature_view_sync(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.GetFeatureViewSyncRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature_view_sync.FeatureViewSync
Gets details of a single FeatureViewSync.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.list_feature_online_stores
list_feature_online_stores(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureOnlineStoresRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureOnlineStoresPager
)
Lists FeatureOnlineStores in a given project and location.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.list_feature_view_syncs
list_feature_view_syncs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewSyncsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureViewSyncsPager
)
Lists FeatureViewSyncs in a given FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.list_feature_views
list_feature_views(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureViewsPager
)
Lists FeatureViews in a given FeatureOnlineStore.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_feature_online_store_path
parse_feature_online_store_path(path: str) -> typing.Dict[str, str]
Parses a feature_online_store path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_feature_view_path
parse_feature_view_path(path: str) -> typing.Dict[str, str]
Parses a feature_view path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_feature_view_sync_path
parse_feature_view_sync_path(path: str) -> typing.Dict[str, str]
Parses a feature_view_sync path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.sync_feature_view
sync_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.SyncFeatureViewRequest,
dict,
]
] = None,
*,
feature_view: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.SyncFeatureViewResponse
)
Triggers on-demand sync for the FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.update_feature_online_store
update_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.UpdateFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
feature_online_store: typing.Optional[
google.cloud.aiplatform_v1.types.feature_online_store.FeatureOnlineStore
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single FeatureOnlineStore.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.update_feature_view
update_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.UpdateFeatureViewRequest,
dict,
]
] = None,
*,
feature_view: typing.Optional[
google.cloud.aiplatform_v1.types.feature_view.FeatureView
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureOnlineStoresAsyncPager
ListFeatureOnlineStoresAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureOnlineStoresResponse
],
],
request: google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureOnlineStoresRequest,
response: google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureOnlineStoresResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureOnlineStoresPager
ListFeatureOnlineStoresPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureOnlineStoresResponse,
],
request: google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureOnlineStoresRequest,
response: google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureOnlineStoresResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureViewSyncsAsyncPager
ListFeatureViewSyncsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewSyncsResponse
],
],
request: google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewSyncsRequest,
response: google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewSyncsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureViewSyncsPager
ListFeatureViewSyncsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewSyncsResponse,
],
request: google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewSyncsRequest,
response: google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewSyncsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureViewsAsyncPager
ListFeatureViewsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewsResponse
],
],
request: google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewsRequest,
response: google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureViewsPager
ListFeatureViewsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewsResponse,
],
request: google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewsRequest,
response: google.cloud.aiplatform_v1.types.feature_online_store_admin_service.ListFeatureViewsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.feature_online_store_admin_service.pagers.ListFeatureViewsPager
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient
FeatureOnlineStoreServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.feature_online_store_service.transports.base.FeatureOnlineStoreServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the feature online store service async client.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.feature_view_path
feature_view_path(
project: str, location: str, feature_online_store: str, feature_view: str
) -> str
Returns a fully-qualified feature_view string.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.fetch_feature_values
fetch_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_service.FetchFeatureValuesRequest,
dict,
]
] = None,
*,
feature_view: typing.Optional[str] = None,
data_key: typing.Optional[
google.cloud.aiplatform_v1.types.feature_online_store_service.FeatureViewDataKey
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.feature_online_store_service.FetchFeatureValuesResponse
)
Fetch feature values under a FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.feature_online_store_service.transports.base.FeatureOnlineStoreServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.parse_feature_view_path
parse_feature_view_path(path: str) -> typing.Dict[str, str]
Parses a feature_view path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.search_nearest_entities
search_nearest_entities(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_service.SearchNearestEntitiesRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.feature_online_store_service.SearchNearestEntitiesResponse
)
Search the nearest entities under a FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient
FeatureOnlineStoreServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.feature_online_store_service.transports.base.FeatureOnlineStoreServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the feature online store service client.
See more: google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.feature_view_path
feature_view_path(
project: str, location: str, feature_online_store: str, feature_view: str
) -> str
Returns a fully-qualified feature_view string.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.fetch_feature_values
fetch_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_service.FetchFeatureValuesRequest,
dict,
]
] = None,
*,
feature_view: typing.Optional[str] = None,
data_key: typing.Optional[
google.cloud.aiplatform_v1.types.feature_online_store_service.FeatureViewDataKey
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.feature_online_store_service.FetchFeatureValuesResponse
)
Fetch feature values under a FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.parse_feature_view_path
parse_feature_view_path(path: str) -> typing.Dict[str, str]
Parses a feature_view path into its component segments.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.search_nearest_entities
search_nearest_entities(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_online_store_service.SearchNearestEntitiesRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.feature_online_store_service.SearchNearestEntitiesResponse
)
Search the nearest entities under a FeatureView.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient
FeatureRegistryServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.feature_registry_service.transports.base.FeatureRegistryServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the feature registry service async client.
See more: google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.create_feature
create_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.CreateFeatureRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature: typing.Optional[google.cloud.aiplatform_v1.types.feature.Feature] = None,
feature_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Feature in a given FeatureGroup.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.create_feature_group
create_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_registry_service.CreateFeatureGroupRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature_group: typing.Optional[
google.cloud.aiplatform_v1.types.feature_group.FeatureGroup
] = None,
feature_group_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new FeatureGroup in a given project and location.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.delete_feature
delete_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.DeleteFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Feature.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.delete_feature_group
delete_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_registry_service.DeleteFeatureGroupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single FeatureGroup.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.feature_group_path
feature_group_path(project: str, location: str, feature_group: str) -> str
Returns a fully-qualified feature_group string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.feature_path
feature_path(
project: str, location: str, featurestore: str, entity_type: str, feature: str
) -> str
Returns a fully-qualified feature string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_feature
get_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.GetFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature.Feature
Gets details of a single Feature.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_feature_group
get_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_registry_service.GetFeatureGroupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature_group.FeatureGroup
Gets details of a single FeatureGroup.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.feature_registry_service.transports.base.FeatureRegistryServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.list_feature_groups
list_feature_groups(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_registry_service.ListFeatureGroupsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.feature_registry_service.pagers.ListFeatureGroupsAsyncPager
)
Lists FeatureGroups in a given project and location.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.list_features
list_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.feature_registry_service.pagers.ListFeaturesAsyncPager
)
Lists Features in a given FeatureGroup.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_feature_group_path
parse_feature_group_path(path: str) -> typing.Dict[str, str]
Parses a feature_group path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_feature_path
parse_feature_path(path: str) -> typing.Dict[str, str]
Parses a feature path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.update_feature
update_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.UpdateFeatureRequest,
dict,
]
] = None,
*,
feature: typing.Optional[google.cloud.aiplatform_v1.types.feature.Feature] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Feature.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.update_feature_group
update_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_registry_service.UpdateFeatureGroupRequest,
dict,
]
] = None,
*,
feature_group: typing.Optional[
google.cloud.aiplatform_v1.types.feature_group.FeatureGroup
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single FeatureGroup.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient
FeatureRegistryServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.feature_registry_service.transports.base.FeatureRegistryServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the feature registry service client.
See more: google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.exit
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.create_feature
create_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.CreateFeatureRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature: typing.Optional[google.cloud.aiplatform_v1.types.feature.Feature] = None,
feature_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Feature in a given FeatureGroup.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.create_feature_group
create_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_registry_service.CreateFeatureGroupRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature_group: typing.Optional[
google.cloud.aiplatform_v1.types.feature_group.FeatureGroup
] = None,
feature_group_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new FeatureGroup in a given project and location.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.delete_feature
delete_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.DeleteFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single Feature.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.delete_feature_group
delete_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_registry_service.DeleteFeatureGroupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single FeatureGroup.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.feature_group_path
feature_group_path(project: str, location: str, feature_group: str) -> str
Returns a fully-qualified feature_group string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.feature_path
feature_path(
project: str, location: str, featurestore: str, entity_type: str, feature: str
) -> str
Returns a fully-qualified feature string.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.get_feature
get_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.GetFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature.Feature
Gets details of a single Feature.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.get_feature_group
get_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_registry_service.GetFeatureGroupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature_group.FeatureGroup
Gets details of a single FeatureGroup.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.list_feature_groups
list_feature_groups(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_registry_service.ListFeatureGroupsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.feature_registry_service.pagers.ListFeatureGroupsPager
)
Lists FeatureGroups in a given project and location.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.list_features
list_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.feature_registry_service.pagers.ListFeaturesPager
)
Lists Features in a given FeatureGroup.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.parse_feature_group_path
parse_feature_group_path(path: str) -> typing.Dict[str, str]
Parses a feature_group path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.parse_feature_path
parse_feature_path(path: str) -> typing.Dict[str, str]
Parses a feature path into its component segments.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.update_feature
update_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.UpdateFeatureRequest,
dict,
]
] = None,
*,
feature: typing.Optional[google.cloud.aiplatform_v1.types.feature.Feature] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Feature.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.update_feature_group
update_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.feature_registry_service.UpdateFeatureGroupRequest,
dict,
]
] = None,
*,
feature_group: typing.Optional[
google.cloud.aiplatform_v1.types.feature_group.FeatureGroup
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single FeatureGroup.
google.cloud.aiplatform_v1.services.feature_registry_service.FeatureRegistryServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.feature_registry_service.pagers.ListFeatureGroupsAsyncPager
ListFeatureGroupsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.feature_registry_service.ListFeatureGroupsResponse
],
],
request: google.cloud.aiplatform_v1.types.feature_registry_service.ListFeatureGroupsRequest,
response: google.cloud.aiplatform_v1.types.feature_registry_service.ListFeatureGroupsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.feature_registry_service.pagers.ListFeatureGroupsAsyncPager
google.cloud.aiplatform_v1.services.feature_registry_service.pagers.ListFeatureGroupsPager
ListFeatureGroupsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.feature_registry_service.ListFeatureGroupsResponse,
],
request: google.cloud.aiplatform_v1.types.feature_registry_service.ListFeatureGroupsRequest,
response: google.cloud.aiplatform_v1.types.feature_registry_service.ListFeatureGroupsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.feature_registry_service.pagers.ListFeatureGroupsPager
google.cloud.aiplatform_v1.services.feature_registry_service.pagers.ListFeaturesAsyncPager
ListFeaturesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesResponse
],
],
request: google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesRequest,
response: google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.feature_registry_service.pagers.ListFeaturesAsyncPager
google.cloud.aiplatform_v1.services.feature_registry_service.pagers.ListFeaturesPager
ListFeaturesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesResponse,
],
request: google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesRequest,
response: google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.feature_registry_service.pagers.ListFeaturesPager
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient
FeaturestoreOnlineServingServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.featurestore_online_serving_service.transports.base.FeaturestoreOnlineServingServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the featurestore online serving service async client.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.entity_type_path
entity_type_path(
project: str, location: str, featurestore: str, entity_type: str
) -> str
Returns a fully-qualified entity_type string.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.transports.base.FeaturestoreOnlineServingServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.parse_entity_type_path
parse_entity_type_path(path: str) -> typing.Dict[str, str]
Parses a entity_type path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.read_feature_values
read_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_online_service.ReadFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.featurestore_online_service.ReadFeatureValuesResponse
)
Reads Feature values of a specific entity of an EntityType.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.streaming_read_feature_values
streaming_read_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_online_service.StreamingReadFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1.types.featurestore_online_service.ReadFeatureValuesResponse
]
]
Reads Feature values for multiple entities.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.write_feature_values
write_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_online_service.WriteFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
payloads: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.featurestore_online_service.WriteFeatureValuesPayload
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.featurestore_online_service.WriteFeatureValuesResponse
)
Writes Feature values of one or more entities of an EntityType.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient
FeaturestoreOnlineServingServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.featurestore_online_serving_service.transports.base.FeaturestoreOnlineServingServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the featurestore online serving service client.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.entity_type_path
entity_type_path(
project: str, location: str, featurestore: str, entity_type: str
) -> str
Returns a fully-qualified entity_type string.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.parse_entity_type_path
parse_entity_type_path(path: str) -> typing.Dict[str, str]
Parses a entity_type path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.read_feature_values
read_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_online_service.ReadFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.featurestore_online_service.ReadFeatureValuesResponse
)
Reads Feature values of a specific entity of an EntityType.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.streaming_read_feature_values
streaming_read_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_online_service.StreamingReadFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1.types.featurestore_online_service.ReadFeatureValuesResponse
]
Reads Feature values for multiple entities.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.write_feature_values
write_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_online_service.WriteFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
payloads: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.featurestore_online_service.WriteFeatureValuesPayload
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.featurestore_online_service.WriteFeatureValuesResponse
)
Writes Feature values of one or more entities of an EntityType.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient
FeaturestoreServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.featurestore_service.transports.base.FeaturestoreServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the featurestore service async client.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.batch_create_features
batch_create_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.BatchCreateFeaturesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.featurestore_service.CreateFeatureRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a batch of Features in a given EntityType.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.batch_read_feature_values
batch_read_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.BatchReadFeatureValuesRequest,
dict,
]
] = None,
*,
featurestore: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Batch reads Feature values from a Featurestore.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.create_entity_type
create_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.CreateEntityTypeRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
entity_type: typing.Optional[
google.cloud.aiplatform_v1.types.entity_type.EntityType
] = None,
entity_type_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new EntityType in a given Featurestore.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.create_feature
create_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.CreateFeatureRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature: typing.Optional[google.cloud.aiplatform_v1.types.feature.Feature] = None,
feature_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Feature in a given EntityType.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.create_featurestore
create_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.CreateFeaturestoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
featurestore: typing.Optional[
google.cloud.aiplatform_v1.types.featurestore.Featurestore
] = None,
featurestore_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Featurestore in a given project and location.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.delete_entity_type
delete_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.DeleteEntityTypeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single EntityType.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.delete_feature
delete_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.DeleteFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Feature.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.delete_feature_values
delete_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.DeleteFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Delete Feature values from Featurestore.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.delete_featurestore
delete_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.DeleteFeaturestoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Featurestore.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.entity_type_path
entity_type_path(
project: str, location: str, featurestore: str, entity_type: str
) -> str
Returns a fully-qualified entity_type string.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.export_feature_values
export_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.ExportFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Exports Feature values from all the entities of a target EntityType.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.feature_path
feature_path(
project: str, location: str, featurestore: str, entity_type: str, feature: str
) -> str
Returns a fully-qualified feature string.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.feature_path
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.featurestore_path
featurestore_path(project: str, location: str, featurestore: str) -> str
Returns a fully-qualified featurestore string.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_entity_type
get_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.GetEntityTypeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.entity_type.EntityType
Gets details of a single EntityType.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_feature
get_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.GetFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature.Feature
Gets details of a single Feature.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_feature
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_featurestore
get_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.GetFeaturestoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.featurestore.Featurestore
Gets details of a single Featurestore.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.featurestore_service.transports.base.FeaturestoreServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.import_feature_values
import_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.ImportFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports Feature values into the Featurestore from a source storage.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.list_entity_types
list_entity_types(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.ListEntityTypesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListEntityTypesAsyncPager
)
Lists EntityTypes in a given Featurestore.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.list_features
list_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListFeaturesAsyncPager
)
Lists Features in a given EntityType.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.list_featurestores
list_featurestores(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturestoresRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListFeaturestoresAsyncPager
)
Lists Featurestores in a given project and location.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_entity_type_path
parse_entity_type_path(path: str) -> typing.Dict[str, str]
Parses a entity_type path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_feature_path
parse_feature_path(path: str) -> typing.Dict[str, str]
Parses a feature path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_featurestore_path
parse_featurestore_path(path: str) -> typing.Dict[str, str]
Parses a featurestore path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.search_features
search_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.SearchFeaturesRequest,
dict,
]
] = None,
*,
location: typing.Optional[str] = None,
query: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.featurestore_service.pagers.SearchFeaturesAsyncPager
)
Searches Features matching a query in a given project.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.update_entity_type
update_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.UpdateEntityTypeRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[
google.cloud.aiplatform_v1.types.entity_type.EntityType
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.entity_type.EntityType
Updates the parameters of a single EntityType.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.update_feature
update_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.UpdateFeatureRequest,
dict,
]
] = None,
*,
feature: typing.Optional[google.cloud.aiplatform_v1.types.feature.Feature] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature.Feature
Updates the parameters of a single Feature.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.update_featurestore
update_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.UpdateFeaturestoreRequest,
dict,
]
] = None,
*,
featurestore: typing.Optional[
google.cloud.aiplatform_v1.types.featurestore.Featurestore
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Featurestore.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient
FeaturestoreServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.featurestore_service.transports.base.FeaturestoreServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the featurestore service client.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.exit
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.batch_create_features
batch_create_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.BatchCreateFeaturesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.featurestore_service.CreateFeatureRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a batch of Features in a given EntityType.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.batch_read_feature_values
batch_read_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.BatchReadFeatureValuesRequest,
dict,
]
] = None,
*,
featurestore: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Batch reads Feature values from a Featurestore.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.create_entity_type
create_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.CreateEntityTypeRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
entity_type: typing.Optional[
google.cloud.aiplatform_v1.types.entity_type.EntityType
] = None,
entity_type_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new EntityType in a given Featurestore.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.create_feature
create_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.CreateFeatureRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature: typing.Optional[google.cloud.aiplatform_v1.types.feature.Feature] = None,
feature_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Feature in a given EntityType.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.create_feature
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.create_featurestore
create_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.CreateFeaturestoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
featurestore: typing.Optional[
google.cloud.aiplatform_v1.types.featurestore.Featurestore
] = None,
featurestore_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Featurestore in a given project and location.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.delete_entity_type
delete_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.DeleteEntityTypeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single EntityType.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.delete_feature
delete_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.DeleteFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single Feature.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.delete_feature
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.delete_feature_values
delete_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.DeleteFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Delete Feature values from Featurestore.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.delete_featurestore
delete_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.DeleteFeaturestoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single Featurestore.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.delete_operation
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.entity_type_path
entity_type_path(
project: str, location: str, featurestore: str, entity_type: str
) -> str
Returns a fully-qualified entity_type string.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.entity_type_path
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.export_feature_values
export_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.ExportFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Exports Feature values from all the entities of a target EntityType.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.feature_path
feature_path(
project: str, location: str, featurestore: str, entity_type: str, feature: str
) -> str
Returns a fully-qualified feature string.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.feature_path
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.featurestore_path
featurestore_path(project: str, location: str, featurestore: str) -> str
Returns a fully-qualified featurestore string.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.featurestore_path
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_entity_type
get_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.GetEntityTypeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.entity_type.EntityType
Gets details of a single EntityType.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_entity_type
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_feature
get_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.GetFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature.Feature
Gets details of a single Feature.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_feature
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_featurestore
get_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.GetFeaturestoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.featurestore.Featurestore
Gets details of a single Featurestore.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_featurestore
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_location
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.get_operation
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.import_feature_values
import_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.ImportFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Imports Feature values into the Featurestore from a source storage.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.list_entity_types
list_entity_types(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.ListEntityTypesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListEntityTypesPager
)
Lists EntityTypes in a given Featurestore.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.list_entity_types
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.list_features
list_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListFeaturesPager
Lists Features in a given EntityType.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.list_features
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.list_featurestores
list_featurestores(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturestoresRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListFeaturestoresPager
)
Lists Featurestores in a given project and location.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.list_locations
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.list_operations
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.parse_entity_type_path
parse_entity_type_path(path: str) -> typing.Dict[str, str]
Parses a entity_type path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.parse_feature_path
parse_feature_path(path: str) -> typing.Dict[str, str]
Parses a feature path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.parse_featurestore_path
parse_featurestore_path(path: str) -> typing.Dict[str, str]
Parses a featurestore path into its component segments.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.search_features
search_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.SearchFeaturesRequest,
dict,
]
] = None,
*,
location: typing.Optional[str] = None,
query: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.featurestore_service.pagers.SearchFeaturesPager
)
Searches Features matching a query in a given project.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.search_features
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.update_entity_type
update_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.UpdateEntityTypeRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[
google.cloud.aiplatform_v1.types.entity_type.EntityType
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.entity_type.EntityType
Updates the parameters of a single EntityType.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.update_feature
update_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.UpdateFeatureRequest,
dict,
]
] = None,
*,
feature: typing.Optional[google.cloud.aiplatform_v1.types.feature.Feature] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.feature.Feature
Updates the parameters of a single Feature.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.update_feature
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.update_featurestore
update_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.featurestore_service.UpdateFeaturestoreRequest,
dict,
]
] = None,
*,
featurestore: typing.Optional[
google.cloud.aiplatform_v1.types.featurestore.Featurestore
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Featurestore.
google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.featurestore_service.FeaturestoreServiceClient.wait_operation
google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListEntityTypesAsyncPager
ListEntityTypesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.featurestore_service.ListEntityTypesResponse
],
],
request: google.cloud.aiplatform_v1.types.featurestore_service.ListEntityTypesRequest,
response: google.cloud.aiplatform_v1.types.featurestore_service.ListEntityTypesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListEntityTypesAsyncPager
google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListEntityTypesPager
ListEntityTypesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.featurestore_service.ListEntityTypesResponse,
],
request: google.cloud.aiplatform_v1.types.featurestore_service.ListEntityTypesRequest,
response: google.cloud.aiplatform_v1.types.featurestore_service.ListEntityTypesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListEntityTypesPager
google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListFeaturesAsyncPager
ListFeaturesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesResponse
],
],
request: google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesRequest,
response: google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListFeaturesAsyncPager
google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListFeaturesPager
ListFeaturesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesResponse,
],
request: google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesRequest,
response: google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListFeaturesPager
google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListFeaturestoresAsyncPager
ListFeaturestoresAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturestoresResponse
],
],
request: google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturestoresRequest,
response: google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturestoresResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListFeaturestoresAsyncPager
google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListFeaturestoresPager
ListFeaturestoresPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturestoresResponse,
],
request: google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturestoresRequest,
response: google.cloud.aiplatform_v1.types.featurestore_service.ListFeaturestoresResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.featurestore_service.pagers.ListFeaturestoresPager
google.cloud.aiplatform_v1.services.featurestore_service.pagers.SearchFeaturesAsyncPager
SearchFeaturesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.featurestore_service.SearchFeaturesResponse
],
],
request: google.cloud.aiplatform_v1.types.featurestore_service.SearchFeaturesRequest,
response: google.cloud.aiplatform_v1.types.featurestore_service.SearchFeaturesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.featurestore_service.pagers.SearchFeaturesAsyncPager
google.cloud.aiplatform_v1.services.featurestore_service.pagers.SearchFeaturesPager
SearchFeaturesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.featurestore_service.SearchFeaturesResponse,
],
request: google.cloud.aiplatform_v1.types.featurestore_service.SearchFeaturesRequest,
response: google.cloud.aiplatform_v1.types.featurestore_service.SearchFeaturesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.featurestore_service.pagers.SearchFeaturesPager
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient
GenAiTuningServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.gen_ai_tuning_service.transports.base.GenAiTuningServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the gen ai tuning service async client.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.cancel_tuning_job
cancel_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.genai_tuning_service.CancelTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a TuningJob.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.context_path
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.create_tuning_job
create_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.genai_tuning_service.CreateTuningJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tuning_job: typing.Optional[
google.cloud.aiplatform_v1.types.tuning_job.TuningJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tuning_job.TuningJob
Creates a TuningJob.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.transports.base.GenAiTuningServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.get_tuning_job
get_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.genai_tuning_service.GetTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tuning_job.TuningJob
Gets a TuningJob.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.list_tuning_jobs
list_tuning_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.genai_tuning_service.ListTuningJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.pagers.ListTuningJobsAsyncPager
)
Lists TuningJobs in a Location.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.model_path
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.parse_tuning_job_path
parse_tuning_job_path(path: str) -> typing.Dict[str, str]
Parses a tuning_job path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.tuning_job_path
tuning_job_path(project: str, location: str, tuning_job: str) -> str
Returns a fully-qualified tuning_job string.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient
GenAiTuningServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.gen_ai_tuning_service.transports.base.GenAiTuningServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the gen ai tuning service client.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.exit
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.cancel_tuning_job
cancel_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.genai_tuning_service.CancelTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a TuningJob.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.cancel_tuning_job
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.context_path
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.create_tuning_job
create_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.genai_tuning_service.CreateTuningJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tuning_job: typing.Optional[
google.cloud.aiplatform_v1.types.tuning_job.TuningJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tuning_job.TuningJob
Creates a TuningJob.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.create_tuning_job
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.delete_operation
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.endpoint_path
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.get_location
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.get_operation
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.get_tuning_job
get_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.genai_tuning_service.GetTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tuning_job.TuningJob
Gets a TuningJob.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.get_tuning_job
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.list_locations
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.list_operations
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.list_tuning_jobs
list_tuning_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.genai_tuning_service.ListTuningJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.pagers.ListTuningJobsPager
)
Lists TuningJobs in a Location.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.list_tuning_jobs
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.model_path
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.parse_model_path
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.parse_tuning_job_path
parse_tuning_job_path(path: str) -> typing.Dict[str, str]
Parses a tuning_job path into its component segments.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.tuning_job_path
tuning_job_path(project: str, location: str, tuning_job: str) -> str
Returns a fully-qualified tuning_job string.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.tuning_job_path
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.GenAiTuningServiceClient.wait_operation
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.pagers.ListTuningJobsAsyncPager
ListTuningJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.genai_tuning_service.ListTuningJobsResponse
],
],
request: google.cloud.aiplatform_v1.types.genai_tuning_service.ListTuningJobsRequest,
response: google.cloud.aiplatform_v1.types.genai_tuning_service.ListTuningJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.pagers.ListTuningJobsAsyncPager
google.cloud.aiplatform_v1.services.gen_ai_tuning_service.pagers.ListTuningJobsPager
ListTuningJobsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.genai_tuning_service.ListTuningJobsResponse,
],
request: google.cloud.aiplatform_v1.types.genai_tuning_service.ListTuningJobsRequest,
response: google.cloud.aiplatform_v1.types.genai_tuning_service.ListTuningJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.gen_ai_tuning_service.pagers.ListTuningJobsPager
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient
IndexEndpointServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.index_endpoint_service.transports.base.IndexEndpointServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the index endpoint service async client.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.create_index_endpoint
create_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.CreateIndexEndpointRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
index_endpoint: typing.Optional[
google.cloud.aiplatform_v1.types.index_endpoint.IndexEndpoint
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates an IndexEndpoint.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.delete_index_endpoint
delete_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.DeleteIndexEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes an IndexEndpoint.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.deploy_index
deploy_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.DeployIndexRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[str] = None,
deployed_index: typing.Optional[
google.cloud.aiplatform_v1.types.index_endpoint.DeployedIndex
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.get_index_endpoint
get_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.GetIndexEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.index_endpoint.IndexEndpoint
Gets an IndexEndpoint.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.index_endpoint_service.transports.base.IndexEndpointServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.index_endpoint_path
index_endpoint_path(project: str, location: str, index_endpoint: str) -> str
Returns a fully-qualified index_endpoint string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.index_path
index_path(project: str, location: str, index: str) -> str
Returns a fully-qualified index string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.list_index_endpoints
list_index_endpoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.ListIndexEndpointsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.index_endpoint_service.pagers.ListIndexEndpointsAsyncPager
)
Lists IndexEndpoints in a Location.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.mutate_deployed_index
mutate_deployed_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.MutateDeployedIndexRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[str] = None,
deployed_index: typing.Optional[
google.cloud.aiplatform_v1.types.index_endpoint.DeployedIndex
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Update an existing DeployedIndex under an IndexEndpoint.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_index_endpoint_path
parse_index_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a index_endpoint path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_index_path
parse_index_path(path: str) -> typing.Dict[str, str]
Parses a index path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.undeploy_index
undeploy_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.UndeployIndexRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[str] = None,
deployed_index_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.update_index_endpoint
update_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.UpdateIndexEndpointRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[
google.cloud.aiplatform_v1.types.index_endpoint.IndexEndpoint
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.index_endpoint.IndexEndpoint
Updates an IndexEndpoint.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient
IndexEndpointServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.index_endpoint_service.transports.base.IndexEndpointServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the index endpoint service client.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.exit
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.create_index_endpoint
create_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.CreateIndexEndpointRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
index_endpoint: typing.Optional[
google.cloud.aiplatform_v1.types.index_endpoint.IndexEndpoint
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates an IndexEndpoint.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.delete_index_endpoint
delete_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.DeleteIndexEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes an IndexEndpoint.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.deploy_index
deploy_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.DeployIndexRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[str] = None,
deployed_index: typing.Optional[
google.cloud.aiplatform_v1.types.index_endpoint.DeployedIndex
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.deploy_index
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.get_index_endpoint
get_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.GetIndexEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.index_endpoint.IndexEndpoint
Gets an IndexEndpoint.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.get_location
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.get_operation
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.index_endpoint_path
index_endpoint_path(project: str, location: str, index_endpoint: str) -> str
Returns a fully-qualified index_endpoint string.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.index_path
index_path(project: str, location: str, index: str) -> str
Returns a fully-qualified index string.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.index_path
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.list_index_endpoints
list_index_endpoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.ListIndexEndpointsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.index_endpoint_service.pagers.ListIndexEndpointsPager
)
Lists IndexEndpoints in a Location.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.list_locations
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.mutate_deployed_index
mutate_deployed_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.MutateDeployedIndexRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[str] = None,
deployed_index: typing.Optional[
google.cloud.aiplatform_v1.types.index_endpoint.DeployedIndex
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Update an existing DeployedIndex under an IndexEndpoint.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.parse_index_endpoint_path
parse_index_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a index_endpoint path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.parse_index_path
parse_index_path(path: str) -> typing.Dict[str, str]
Parses a index path into its component segments.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.undeploy_index
undeploy_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.UndeployIndexRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[str] = None,
deployed_index_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.undeploy_index
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.update_index_endpoint
update_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_endpoint_service.UpdateIndexEndpointRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[
google.cloud.aiplatform_v1.types.index_endpoint.IndexEndpoint
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.index_endpoint.IndexEndpoint
Updates an IndexEndpoint.
google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient.wait_operation
google.cloud.aiplatform_v1.services.index_endpoint_service.pagers.ListIndexEndpointsAsyncPager
ListIndexEndpointsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.index_endpoint_service.ListIndexEndpointsResponse
],
],
request: google.cloud.aiplatform_v1.types.index_endpoint_service.ListIndexEndpointsRequest,
response: google.cloud.aiplatform_v1.types.index_endpoint_service.ListIndexEndpointsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.pagers.ListIndexEndpointsAsyncPager
google.cloud.aiplatform_v1.services.index_endpoint_service.pagers.ListIndexEndpointsPager
ListIndexEndpointsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.index_endpoint_service.ListIndexEndpointsResponse,
],
request: google.cloud.aiplatform_v1.types.index_endpoint_service.ListIndexEndpointsRequest,
response: google.cloud.aiplatform_v1.types.index_endpoint_service.ListIndexEndpointsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.index_endpoint_service.pagers.ListIndexEndpointsPager
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient
IndexServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.index_service.transports.base.IndexServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the index service async client.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.common_organization_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.create_index
create_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.CreateIndexRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
index: typing.Optional[google.cloud.aiplatform_v1.types.index.Index] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates an Index.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.create_index
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.delete_index
delete_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.DeleteIndexRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes an Index.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.delete_index
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.from_service_account_file
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.from_service_account_info
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.from_service_account_json
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.get_index
get_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.GetIndexRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.index.Index
Gets an Index.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.get_index
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.index_service.transports.base.IndexServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.index_endpoint_path
index_endpoint_path(project: str, location: str, index_endpoint: str) -> str
Returns a fully-qualified index_endpoint string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.index_endpoint_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.index_path
index_path(project: str, location: str, index: str) -> str
Returns a fully-qualified index string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.index_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.list_indexes
list_indexes(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.ListIndexesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.index_service.pagers.ListIndexesAsyncPager
Lists Indexes in a Location.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.list_indexes
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.parse_common_location_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.parse_common_project_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.parse_index_endpoint_path
parse_index_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a index_endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.parse_index_endpoint_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.parse_index_path
parse_index_path(path: str) -> typing.Dict[str, str]
Parses a index path into its component segments.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.parse_index_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.remove_datapoints
remove_datapoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.RemoveDatapointsRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.index_service.RemoveDatapointsResponse
Remove Datapoints from an Index.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.remove_datapoints
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.update_index
update_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.UpdateIndexRequest, dict
]
] = None,
*,
index: typing.Optional[google.cloud.aiplatform_v1.types.index.Index] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an Index.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.update_index
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.upsert_datapoints
upsert_datapoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.UpsertDatapointsRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.index_service.UpsertDatapointsResponse
Add/update Datapoints into an Index.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.upsert_datapoints
google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient
IndexServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.index_service.transports.base.IndexServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the index service client.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.exit
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.common_billing_account_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.common_location_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.common_organization_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.common_project_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.create_index
create_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.CreateIndexRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
index: typing.Optional[google.cloud.aiplatform_v1.types.index.Index] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates an Index.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.create_index
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.delete_index
delete_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.DeleteIndexRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes an Index.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.delete_index
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.delete_operation
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.from_service_account_file
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.from_service_account_info
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.from_service_account_json
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.get_index
get_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.GetIndexRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.index.Index
Gets an Index.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.get_index
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.get_location
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.get_operation
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.index_endpoint_path
index_endpoint_path(project: str, location: str, index_endpoint: str) -> str
Returns a fully-qualified index_endpoint string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.index_endpoint_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.index_path
index_path(project: str, location: str, index: str) -> str
Returns a fully-qualified index string.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.index_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.list_indexes
list_indexes(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.ListIndexesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.index_service.pagers.ListIndexesPager
Lists Indexes in a Location.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.list_indexes
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.list_locations
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.list_operations
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_common_location_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_common_organization_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_common_project_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_index_endpoint_path
parse_index_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a index_endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_index_endpoint_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_index_path
parse_index_path(path: str) -> typing.Dict[str, str]
Parses a index path into its component segments.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.parse_index_path
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.remove_datapoints
remove_datapoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.RemoveDatapointsRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.index_service.RemoveDatapointsResponse
Remove Datapoints from an Index.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.remove_datapoints
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.update_index
update_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.UpdateIndexRequest, dict
]
] = None,
*,
index: typing.Optional[google.cloud.aiplatform_v1.types.index.Index] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates an Index.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.update_index
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.upsert_datapoints
upsert_datapoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.index_service.UpsertDatapointsRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.index_service.UpsertDatapointsResponse
Add/update Datapoints into an Index.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.upsert_datapoints
google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.index_service.IndexServiceClient.wait_operation
google.cloud.aiplatform_v1.services.index_service.pagers.ListIndexesAsyncPager
ListIndexesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.index_service.ListIndexesResponse
],
],
request: google.cloud.aiplatform_v1.types.index_service.ListIndexesRequest,
response: google.cloud.aiplatform_v1.types.index_service.ListIndexesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.index_service.pagers.ListIndexesAsyncPager
google.cloud.aiplatform_v1.services.index_service.pagers.ListIndexesPager
ListIndexesPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.index_service.ListIndexesResponse
],
request: google.cloud.aiplatform_v1.types.index_service.ListIndexesRequest,
response: google.cloud.aiplatform_v1.types.index_service.ListIndexesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.index_service.pagers.ListIndexesPager
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient
JobServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.job_service.transports.base.JobServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the job service async client.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.batch_prediction_job_path
batch_prediction_job_path(
project: str, location: str, batch_prediction_job: str
) -> str
Returns a fully-qualified batch_prediction_job string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.batch_prediction_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.cancel_batch_prediction_job
cancel_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CancelBatchPredictionJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a BatchPredictionJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.cancel_batch_prediction_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.cancel_custom_job
cancel_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CancelCustomJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a CustomJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.cancel_custom_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.cancel_data_labeling_job
cancel_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CancelDataLabelingJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a DataLabelingJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.cancel_data_labeling_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.cancel_hyperparameter_tuning_job
cancel_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CancelHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a HyperparameterTuningJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.cancel_nas_job
cancel_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CancelNasJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a NasJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.cancel_nas_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.common_billing_account_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.common_organization_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.context_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.create_batch_prediction_job
create_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CreateBatchPredictionJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
batch_prediction_job: typing.Optional[
google.cloud.aiplatform_v1.types.batch_prediction_job.BatchPredictionJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.batch_prediction_job.BatchPredictionJob
Creates a BatchPredictionJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.create_batch_prediction_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.create_custom_job
create_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CreateCustomJobRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
custom_job: typing.Optional[
google.cloud.aiplatform_v1.types.custom_job.CustomJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.custom_job.CustomJob
Creates a CustomJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.create_custom_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.create_data_labeling_job
create_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CreateDataLabelingJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
data_labeling_job: typing.Optional[
google.cloud.aiplatform_v1.types.data_labeling_job.DataLabelingJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.data_labeling_job.DataLabelingJob
Creates a DataLabelingJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.create_data_labeling_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.create_hyperparameter_tuning_job
create_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CreateHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
hyperparameter_tuning_job: typing.Optional[
google.cloud.aiplatform_v1.types.hyperparameter_tuning_job.HyperparameterTuningJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.hyperparameter_tuning_job.HyperparameterTuningJob
Creates a HyperparameterTuningJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.create_model_deployment_monitoring_job
create_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CreateModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
model_deployment_monitoring_job: typing.Optional[
google.cloud.aiplatform_v1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
)
Creates a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.create_nas_job
create_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CreateNasJobRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
nas_job: typing.Optional[google.cloud.aiplatform_v1.types.nas_job.NasJob] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.nas_job.NasJob
Creates a NasJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.create_nas_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.custom_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.data_labeling_job_path
data_labeling_job_path(project: str, location: str, data_labeling_job: str) -> str
Returns a fully-qualified data_labeling_job string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.data_labeling_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.dataset_path
dataset_path(project: str, location: str, dataset: str) -> str
Returns a fully-qualified dataset string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.dataset_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.delete_batch_prediction_job
delete_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.DeleteBatchPredictionJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a BatchPredictionJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.delete_batch_prediction_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.delete_custom_job
delete_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.DeleteCustomJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a CustomJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.delete_custom_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.delete_data_labeling_job
delete_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.DeleteDataLabelingJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a DataLabelingJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.delete_data_labeling_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.delete_hyperparameter_tuning_job
delete_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.DeleteHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a HyperparameterTuningJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.delete_model_deployment_monitoring_job
delete_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.DeleteModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.delete_nas_job
delete_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.DeleteNasJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a NasJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.delete_nas_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.endpoint_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.from_service_account_file
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.from_service_account_info
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.from_service_account_json
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_batch_prediction_job
get_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetBatchPredictionJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.batch_prediction_job.BatchPredictionJob
Gets a BatchPredictionJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_batch_prediction_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_custom_job
get_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetCustomJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.custom_job.CustomJob
Gets a CustomJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_custom_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_data_labeling_job
get_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetDataLabelingJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.data_labeling_job.DataLabelingJob
Gets a DataLabelingJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_data_labeling_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_hyperparameter_tuning_job
get_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.hyperparameter_tuning_job.HyperparameterTuningJob
Gets a HyperparameterTuningJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_hyperparameter_tuning_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_model_deployment_monitoring_job
get_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
)
Gets a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_nas_job
get_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetNasJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.nas_job.NasJob
Gets a NasJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_nas_job
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_nas_trial_detail
get_nas_trial_detail(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetNasTrialDetailRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.nas_job.NasTrialDetail
Gets a NasTrialDetail.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_nas_trial_detail
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.job_service.transports.base.JobServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.hyperparameter_tuning_job_path
hyperparameter_tuning_job_path(
project: str, location: str, hyperparameter_tuning_job: str
) -> str
Returns a fully-qualified hyperparameter_tuning_job string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.hyperparameter_tuning_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_batch_prediction_jobs
list_batch_prediction_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListBatchPredictionJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.job_service.pagers.ListBatchPredictionJobsAsyncPager
)
Lists BatchPredictionJobs in a Location.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_batch_prediction_jobs
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_custom_jobs
list_custom_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListCustomJobsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.job_service.pagers.ListCustomJobsAsyncPager
Lists CustomJobs in a Location.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_custom_jobs
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_data_labeling_jobs
list_data_labeling_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListDataLabelingJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.job_service.pagers.ListDataLabelingJobsAsyncPager
)
Lists DataLabelingJobs in a Location.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_data_labeling_jobs
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_hyperparameter_tuning_jobs
list_hyperparameter_tuning_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.job_service.pagers.ListHyperparameterTuningJobsAsyncPager
)
Lists HyperparameterTuningJobs in a Location.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_model_deployment_monitoring_jobs
list_model_deployment_monitoring_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListModelDeploymentMonitoringJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.job_service.pagers.ListModelDeploymentMonitoringJobsAsyncPager
)
Lists ModelDeploymentMonitoringJobs in a Location.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_nas_jobs
list_nas_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListNasJobsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.job_service.pagers.ListNasJobsAsyncPager
Lists NasJobs in a Location.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_nas_jobs
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_nas_trial_details
list_nas_trial_details(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListNasTrialDetailsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.job_service.pagers.ListNasTrialDetailsAsyncPager
)
List top NasTrialDetails of a NasJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_nas_trial_details
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.model_deployment_monitoring_job_path
model_deployment_monitoring_job_path(
project: str, location: str, model_deployment_monitoring_job: str
) -> str
Returns a fully-qualified model_deployment_monitoring_job string.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.model_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.nas_job_path
nas_job_path(project: str, location: str, nas_job: str) -> str
Returns a fully-qualified nas_job string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.nas_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.nas_trial_detail_path
nas_trial_detail_path(
project: str, location: str, nas_job: str, nas_trial_detail: str
) -> str
Returns a fully-qualified nas_trial_detail string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.nas_trial_detail_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.network_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.notification_channel_path
notification_channel_path(project: str, notification_channel: str) -> str
Returns a fully-qualified notification_channel string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.notification_channel_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_batch_prediction_job_path
parse_batch_prediction_job_path(path: str) -> typing.Dict[str, str]
Parses a batch_prediction_job path into its component segments.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_common_location_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_common_organization_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_common_project_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_context_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_custom_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_data_labeling_job_path
parse_data_labeling_job_path(path: str) -> typing.Dict[str, str]
Parses a data_labeling_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_data_labeling_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_dataset_path
parse_dataset_path(path: str) -> typing.Dict[str, str]
Parses a dataset path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_dataset_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_endpoint_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_hyperparameter_tuning_job_path
parse_hyperparameter_tuning_job_path(path: str) -> typing.Dict[str, str]
Parses a hyperparameter_tuning_job path into its component segments.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_model_deployment_monitoring_job_path
parse_model_deployment_monitoring_job_path(path: str) -> typing.Dict[str, str]
Parses a model_deployment_monitoring_job path into its component segments.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_model_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_nas_job_path
parse_nas_job_path(path: str) -> typing.Dict[str, str]
Parses a nas_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_nas_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_nas_trial_detail_path
parse_nas_trial_detail_path(path: str) -> typing.Dict[str, str]
Parses a nas_trial_detail path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_nas_trial_detail_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_network_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_notification_channel_path
parse_notification_channel_path(path: str) -> typing.Dict[str, str]
Parses a notification_channel path into its component segments.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_persistent_resource_path
parse_persistent_resource_path(path: str) -> typing.Dict[str, str]
Parses a persistent_resource path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_persistent_resource_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_tensorboard_path
parse_tensorboard_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_tensorboard_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_trial_path
parse_trial_path(path: str) -> typing.Dict[str, str]
Parses a trial path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.parse_trial_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.pause_model_deployment_monitoring_job
pause_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.PauseModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Pauses a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.persistent_resource_path
persistent_resource_path(
project: str, location: str, persistent_resource: str
) -> str
Returns a fully-qualified persistent_resource string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.persistent_resource_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.resume_model_deployment_monitoring_job
resume_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ResumeModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Resumes a paused ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.search_model_deployment_monitoring_stats_anomalies
search_model_deployment_monitoring_stats_anomalies(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesRequest,
dict,
]
] = None,
*,
model_deployment_monitoring_job: typing.Optional[str] = None,
deployed_model_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.job_service.pagers.SearchModelDeploymentMonitoringStatsAnomaliesAsyncPager
)
Searches Model Monitoring Statistics generated within a given time window.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.tensorboard_path
tensorboard_path(project: str, location: str, tensorboard: str) -> str
Returns a fully-qualified tensorboard string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.tensorboard_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.trial_path
trial_path(project: str, location: str, study: str, trial: str) -> str
Returns a fully-qualified trial string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.trial_path
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.update_model_deployment_monitoring_job
update_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.UpdateModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
model_deployment_monitoring_job: typing.Optional[
google.cloud.aiplatform_v1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.job_service.JobServiceClient
JobServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.job_service.transports.base.JobServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the job service client.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.exit
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.batch_prediction_job_path
batch_prediction_job_path(
project: str, location: str, batch_prediction_job: str
) -> str
Returns a fully-qualified batch_prediction_job string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.batch_prediction_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.cancel_batch_prediction_job
cancel_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CancelBatchPredictionJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a BatchPredictionJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.cancel_batch_prediction_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.cancel_custom_job
cancel_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CancelCustomJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a CustomJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.cancel_custom_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.cancel_data_labeling_job
cancel_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CancelDataLabelingJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a DataLabelingJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.cancel_data_labeling_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.cancel_hyperparameter_tuning_job
cancel_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CancelHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a HyperparameterTuningJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.cancel_hyperparameter_tuning_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.cancel_nas_job
cancel_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CancelNasJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a NasJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.cancel_nas_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.common_billing_account_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.common_location_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.common_organization_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.common_project_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.context_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.create_batch_prediction_job
create_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CreateBatchPredictionJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
batch_prediction_job: typing.Optional[
google.cloud.aiplatform_v1.types.batch_prediction_job.BatchPredictionJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.batch_prediction_job.BatchPredictionJob
Creates a BatchPredictionJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.create_batch_prediction_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.create_custom_job
create_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CreateCustomJobRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
custom_job: typing.Optional[
google.cloud.aiplatform_v1.types.custom_job.CustomJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.custom_job.CustomJob
Creates a CustomJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.create_custom_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.create_data_labeling_job
create_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CreateDataLabelingJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
data_labeling_job: typing.Optional[
google.cloud.aiplatform_v1.types.data_labeling_job.DataLabelingJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.data_labeling_job.DataLabelingJob
Creates a DataLabelingJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.create_data_labeling_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.create_hyperparameter_tuning_job
create_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CreateHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
hyperparameter_tuning_job: typing.Optional[
google.cloud.aiplatform_v1.types.hyperparameter_tuning_job.HyperparameterTuningJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.hyperparameter_tuning_job.HyperparameterTuningJob
Creates a HyperparameterTuningJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.create_hyperparameter_tuning_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.create_model_deployment_monitoring_job
create_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CreateModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
model_deployment_monitoring_job: typing.Optional[
google.cloud.aiplatform_v1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
)
Creates a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.create_nas_job
create_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.CreateNasJobRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
nas_job: typing.Optional[google.cloud.aiplatform_v1.types.nas_job.NasJob] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.nas_job.NasJob
Creates a NasJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.create_nas_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.custom_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.data_labeling_job_path
data_labeling_job_path(project: str, location: str, data_labeling_job: str) -> str
Returns a fully-qualified data_labeling_job string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.data_labeling_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.dataset_path
dataset_path(project: str, location: str, dataset: str) -> str
Returns a fully-qualified dataset string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.dataset_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_batch_prediction_job
delete_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.DeleteBatchPredictionJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a BatchPredictionJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_batch_prediction_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_custom_job
delete_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.DeleteCustomJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a CustomJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_custom_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_data_labeling_job
delete_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.DeleteDataLabelingJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a DataLabelingJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_data_labeling_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_hyperparameter_tuning_job
delete_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.DeleteHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a HyperparameterTuningJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_hyperparameter_tuning_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_model_deployment_monitoring_job
delete_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.DeleteModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_nas_job
delete_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.DeleteNasJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a NasJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_nas_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.delete_operation
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.endpoint_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.from_service_account_file
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.from_service_account_info
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.from_service_account_json
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_batch_prediction_job
get_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetBatchPredictionJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.batch_prediction_job.BatchPredictionJob
Gets a BatchPredictionJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_batch_prediction_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_custom_job
get_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetCustomJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.custom_job.CustomJob
Gets a CustomJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_custom_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_data_labeling_job
get_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetDataLabelingJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.data_labeling_job.DataLabelingJob
Gets a DataLabelingJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_data_labeling_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_hyperparameter_tuning_job
get_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.hyperparameter_tuning_job.HyperparameterTuningJob
Gets a HyperparameterTuningJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_hyperparameter_tuning_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_location
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_model_deployment_monitoring_job
get_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
)
Gets a ModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_model_deployment_monitoring_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_mtls_endpoint_and_cert_source
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_nas_job
get_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetNasJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.nas_job.NasJob
Gets a NasJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_nas_job
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_nas_trial_detail
get_nas_trial_detail(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.GetNasTrialDetailRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.nas_job.NasTrialDetail
Gets a NasTrialDetail.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_nas_trial_detail
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.get_operation
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.hyperparameter_tuning_job_path
hyperparameter_tuning_job_path(
project: str, location: str, hyperparameter_tuning_job: str
) -> str
Returns a fully-qualified hyperparameter_tuning_job string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.hyperparameter_tuning_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_batch_prediction_jobs
list_batch_prediction_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListBatchPredictionJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.job_service.pagers.ListBatchPredictionJobsPager
)
Lists BatchPredictionJobs in a Location.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_batch_prediction_jobs
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_custom_jobs
list_custom_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListCustomJobsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.job_service.pagers.ListCustomJobsPager
Lists CustomJobs in a Location.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_custom_jobs
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_data_labeling_jobs
list_data_labeling_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListDataLabelingJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.job_service.pagers.ListDataLabelingJobsPager
Lists DataLabelingJobs in a Location.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_data_labeling_jobs
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_hyperparameter_tuning_jobs
list_hyperparameter_tuning_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.job_service.pagers.ListHyperparameterTuningJobsPager
)
Lists HyperparameterTuningJobs in a Location.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_hyperparameter_tuning_jobs
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_locations
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_model_deployment_monitoring_jobs
list_model_deployment_monitoring_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListModelDeploymentMonitoringJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.job_service.pagers.ListModelDeploymentMonitoringJobsPager
)
Lists ModelDeploymentMonitoringJobs in a Location.
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_nas_jobs
list_nas_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListNasJobsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.job_service.pagers.ListNasJobsPager
Lists NasJobs in a Location.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_nas_jobs
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_nas_trial_details
list_nas_trial_details(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ListNasTrialDetailsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.job_service.pagers.ListNasTrialDetailsPager
List top NasTrialDetails of a NasJob.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_nas_trial_details
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.list_operations
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.model_deployment_monitoring_job_path
model_deployment_monitoring_job_path(
project: str, location: str, model_deployment_monitoring_job: str
) -> str
Returns a fully-qualified model_deployment_monitoring_job string.
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.model_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.nas_job_path
nas_job_path(project: str, location: str, nas_job: str) -> str
Returns a fully-qualified nas_job string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.nas_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.nas_trial_detail_path
nas_trial_detail_path(
project: str, location: str, nas_job: str, nas_trial_detail: str
) -> str
Returns a fully-qualified nas_trial_detail string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.nas_trial_detail_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.network_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.notification_channel_path
notification_channel_path(project: str, notification_channel: str) -> str
Returns a fully-qualified notification_channel string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.notification_channel_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_batch_prediction_job_path
parse_batch_prediction_job_path(path: str) -> typing.Dict[str, str]
Parses a batch_prediction_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_batch_prediction_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_common_billing_account_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_common_location_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_common_organization_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_common_project_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_context_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_custom_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_data_labeling_job_path
parse_data_labeling_job_path(path: str) -> typing.Dict[str, str]
Parses a data_labeling_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_data_labeling_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_dataset_path
parse_dataset_path(path: str) -> typing.Dict[str, str]
Parses a dataset path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_dataset_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_endpoint_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_hyperparameter_tuning_job_path
parse_hyperparameter_tuning_job_path(path: str) -> typing.Dict[str, str]
Parses a hyperparameter_tuning_job path into its component segments.
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_model_deployment_monitoring_job_path
parse_model_deployment_monitoring_job_path(path: str) -> typing.Dict[str, str]
Parses a model_deployment_monitoring_job path into its component segments.
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_model_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_nas_job_path
parse_nas_job_path(path: str) -> typing.Dict[str, str]
Parses a nas_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_nas_job_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_nas_trial_detail_path
parse_nas_trial_detail_path(path: str) -> typing.Dict[str, str]
Parses a nas_trial_detail path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_nas_trial_detail_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_network_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_notification_channel_path
parse_notification_channel_path(path: str) -> typing.Dict[str, str]
Parses a notification_channel path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_notification_channel_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_persistent_resource_path
parse_persistent_resource_path(path: str) -> typing.Dict[str, str]
Parses a persistent_resource path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_persistent_resource_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_tensorboard_path
parse_tensorboard_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_tensorboard_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_trial_path
parse_trial_path(path: str) -> typing.Dict[str, str]
Parses a trial path into its component segments.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.parse_trial_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.pause_model_deployment_monitoring_job
pause_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.PauseModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Pauses a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.persistent_resource_path
persistent_resource_path(
project: str, location: str, persistent_resource: str
) -> str
Returns a fully-qualified persistent_resource string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.persistent_resource_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.resume_model_deployment_monitoring_job
resume_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.ResumeModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Resumes a paused ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.search_model_deployment_monitoring_stats_anomalies
search_model_deployment_monitoring_stats_anomalies(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesRequest,
dict,
]
] = None,
*,
model_deployment_monitoring_job: typing.Optional[str] = None,
deployed_model_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.job_service.pagers.SearchModelDeploymentMonitoringStatsAnomaliesPager
)
Searches Model Monitoring Statistics generated within a given time window.
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.tensorboard_path
tensorboard_path(project: str, location: str, tensorboard: str) -> str
Returns a fully-qualified tensorboard string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.tensorboard_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.trial_path
trial_path(project: str, location: str, study: str, trial: str) -> str
Returns a fully-qualified trial string.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.trial_path
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.update_model_deployment_monitoring_job
update_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.job_service.UpdateModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
model_deployment_monitoring_job: typing.Optional[
google.cloud.aiplatform_v1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1.services.job_service.JobServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.job_service.JobServiceClient.wait_operation
google.cloud.aiplatform_v1.services.job_service.pagers.ListBatchPredictionJobsAsyncPager
ListBatchPredictionJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.job_service.ListBatchPredictionJobsResponse
],
],
request: google.cloud.aiplatform_v1.types.job_service.ListBatchPredictionJobsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListBatchPredictionJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListBatchPredictionJobsAsyncPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListBatchPredictionJobsPager
ListBatchPredictionJobsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.job_service.ListBatchPredictionJobsResponse,
],
request: google.cloud.aiplatform_v1.types.job_service.ListBatchPredictionJobsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListBatchPredictionJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListBatchPredictionJobsPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListCustomJobsAsyncPager
ListCustomJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.job_service.ListCustomJobsResponse
],
],
request: google.cloud.aiplatform_v1.types.job_service.ListCustomJobsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListCustomJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListCustomJobsAsyncPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListCustomJobsPager
ListCustomJobsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.job_service.ListCustomJobsResponse
],
request: google.cloud.aiplatform_v1.types.job_service.ListCustomJobsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListCustomJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListCustomJobsPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListDataLabelingJobsAsyncPager
ListDataLabelingJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.job_service.ListDataLabelingJobsResponse
],
],
request: google.cloud.aiplatform_v1.types.job_service.ListDataLabelingJobsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListDataLabelingJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListDataLabelingJobsAsyncPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListDataLabelingJobsPager
ListDataLabelingJobsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.job_service.ListDataLabelingJobsResponse
],
request: google.cloud.aiplatform_v1.types.job_service.ListDataLabelingJobsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListDataLabelingJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListDataLabelingJobsPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListHyperparameterTuningJobsAsyncPager
ListHyperparameterTuningJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsResponse
],
],
request: google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListHyperparameterTuningJobsAsyncPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListHyperparameterTuningJobsPager
ListHyperparameterTuningJobsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsResponse,
],
request: google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListHyperparameterTuningJobsPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListModelDeploymentMonitoringJobsAsyncPager
ListModelDeploymentMonitoringJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.job_service.ListModelDeploymentMonitoringJobsResponse
],
],
request: google.cloud.aiplatform_v1.types.job_service.ListModelDeploymentMonitoringJobsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListModelDeploymentMonitoringJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListModelDeploymentMonitoringJobsAsyncPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListModelDeploymentMonitoringJobsPager
ListModelDeploymentMonitoringJobsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.job_service.ListModelDeploymentMonitoringJobsResponse,
],
request: google.cloud.aiplatform_v1.types.job_service.ListModelDeploymentMonitoringJobsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListModelDeploymentMonitoringJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListModelDeploymentMonitoringJobsPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListNasJobsAsyncPager
ListNasJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.job_service.ListNasJobsResponse
],
],
request: google.cloud.aiplatform_v1.types.job_service.ListNasJobsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListNasJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListNasJobsAsyncPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListNasJobsPager
ListNasJobsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.job_service.ListNasJobsResponse
],
request: google.cloud.aiplatform_v1.types.job_service.ListNasJobsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListNasJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListNasJobsPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListNasTrialDetailsAsyncPager
ListNasTrialDetailsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.job_service.ListNasTrialDetailsResponse
],
],
request: google.cloud.aiplatform_v1.types.job_service.ListNasTrialDetailsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListNasTrialDetailsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListNasTrialDetailsAsyncPager
google.cloud.aiplatform_v1.services.job_service.pagers.ListNasTrialDetailsPager
ListNasTrialDetailsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.job_service.ListNasTrialDetailsResponse
],
request: google.cloud.aiplatform_v1.types.job_service.ListNasTrialDetailsRequest,
response: google.cloud.aiplatform_v1.types.job_service.ListNasTrialDetailsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.job_service.pagers.ListNasTrialDetailsPager
google.cloud.aiplatform_v1.services.job_service.pagers.SearchModelDeploymentMonitoringStatsAnomaliesAsyncPager
SearchModelDeploymentMonitoringStatsAnomaliesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesResponse
],
],
request: google.cloud.aiplatform_v1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesRequest,
response: google.cloud.aiplatform_v1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1.services.job_service.pagers.SearchModelDeploymentMonitoringStatsAnomaliesPager
SearchModelDeploymentMonitoringStatsAnomaliesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesResponse,
],
request: google.cloud.aiplatform_v1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesRequest,
response: google.cloud.aiplatform_v1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient
LlmUtilityServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.llm_utility_service.transports.base.LlmUtilityServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the llm utility service async client.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.compute_tokens
compute_tokens(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.llm_utility_service.ComputeTokensRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.llm_utility_service.ComputeTokensResponse
Return a list of tokens based on the input text.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.compute_tokens
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.count_tokens
count_tokens(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.CountTokensRequest, dict
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.prediction_service.CountTokensResponse
Perform a token counting.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.count_tokens
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.endpoint_path
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.llm_utility_service.transports.base.LlmUtilityServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient
LlmUtilityServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.llm_utility_service.transports.base.LlmUtilityServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the llm utility service client.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.exit
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.common_location_path
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.common_project_path
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.compute_tokens
compute_tokens(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.llm_utility_service.ComputeTokensRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.llm_utility_service.ComputeTokensResponse
Return a list of tokens based on the input text.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.compute_tokens
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.count_tokens
count_tokens(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.CountTokensRequest, dict
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.prediction_service.CountTokensResponse
Perform a token counting.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.count_tokens
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.delete_operation
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.endpoint_path
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.get_location
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.get_operation
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.list_locations
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.list_operations
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.parse_endpoint_path
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.llm_utility_service.LlmUtilityServiceClient.wait_operation
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient
MatchServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.match_service.transports.base.MatchServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the match service async client.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.common_organization_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.find_neighbors
find_neighbors(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.match_service.FindNeighborsRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.match_service.FindNeighborsResponse
Finds the nearest neighbors of each vector within the request.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.find_neighbors
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.from_service_account_file
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.from_service_account_info
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.from_service_account_json
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.match_service.transports.base.MatchServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.index_endpoint_path
index_endpoint_path(project: str, location: str, index_endpoint: str) -> str
Returns a fully-qualified index_endpoint string.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.index_endpoint_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.parse_common_location_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.parse_common_project_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.parse_index_endpoint_path
parse_index_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a index_endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.parse_index_endpoint_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.read_index_datapoints
read_index_datapoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.match_service.ReadIndexDatapointsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.match_service.ReadIndexDatapointsResponse
Reads the datapoints/vectors of the given IDs.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.read_index_datapoints
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient
MatchServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.match_service.transports.base.MatchServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the match service client.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.exit
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.common_billing_account_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.common_location_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.common_organization_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.common_project_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.delete_operation
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.find_neighbors
find_neighbors(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.match_service.FindNeighborsRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.match_service.FindNeighborsResponse
Finds the nearest neighbors of each vector within the request.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.find_neighbors
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.from_service_account_file
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.from_service_account_info
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.from_service_account_json
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.get_location
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.get_operation
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.index_endpoint_path
index_endpoint_path(project: str, location: str, index_endpoint: str) -> str
Returns a fully-qualified index_endpoint string.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.index_endpoint_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.list_locations
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.list_operations
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.parse_common_location_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.parse_common_organization_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.parse_common_project_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.parse_index_endpoint_path
parse_index_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a index_endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.parse_index_endpoint_path
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.read_index_datapoints
read_index_datapoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.match_service.ReadIndexDatapointsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.match_service.ReadIndexDatapointsResponse
Reads the datapoints/vectors of the given IDs.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.read_index_datapoints
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.match_service.MatchServiceClient.wait_operation
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient
MetadataServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.metadata_service.transports.base.MetadataServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the metadata service async client.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.add_context_artifacts_and_executions
add_context_artifacts_and_executions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.AddContextArtifactsAndExecutionsRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
artifacts: typing.Optional[typing.MutableSequence[str]] = None,
executions: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.metadata_service.AddContextArtifactsAndExecutionsResponse
)
Adds a set of Artifacts and Executions to a Context.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.add_context_children
add_context_children(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.AddContextChildrenRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
child_contexts: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.metadata_service.AddContextChildrenResponse
Adds a set of Contexts as children to a parent Context.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.add_context_children
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.add_execution_events
add_execution_events(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.AddExecutionEventsRequest,
dict,
]
] = None,
*,
execution: typing.Optional[str] = None,
events: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1.types.event.Event]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.metadata_service.AddExecutionEventsResponse
Adds Events to the specified Execution.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.add_execution_events
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.artifact_path
artifact_path(
project: str, location: str, metadata_store: str, artifact: str
) -> str
Returns a fully-qualified artifact string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.artifact_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.context_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.create_artifact
create_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.CreateArtifactRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
artifact: typing.Optional[
google.cloud.aiplatform_v1.types.artifact.Artifact
] = None,
artifact_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.artifact.Artifact
Creates an Artifact associated with a MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.create_artifact
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.create_context
create_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.CreateContextRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
context: typing.Optional[google.cloud.aiplatform_v1.types.context.Context] = None,
context_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.context.Context
Creates a Context associated with a MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.create_context
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.create_execution
create_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.CreateExecutionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
execution: typing.Optional[
google.cloud.aiplatform_v1.types.execution.Execution
] = None,
execution_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.execution.Execution
Creates an Execution associated with a MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.create_execution
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.create_metadata_schema
create_metadata_schema(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.CreateMetadataSchemaRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
metadata_schema: typing.Optional[
google.cloud.aiplatform_v1.types.metadata_schema.MetadataSchema
] = None,
metadata_schema_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.metadata_schema.MetadataSchema
Creates a MetadataSchema.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.create_metadata_store
create_metadata_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.CreateMetadataStoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
metadata_store: typing.Optional[
google.cloud.aiplatform_v1.types.metadata_store.MetadataStore
] = None,
metadata_store_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Initializes a MetadataStore, including allocation of resources.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.delete_artifact
delete_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.DeleteArtifactRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes an Artifact.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.delete_artifact
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.delete_context
delete_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.DeleteContextRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a stored Context.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.delete_context
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.delete_execution
delete_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.DeleteExecutionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes an Execution.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.delete_execution
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.delete_metadata_store
delete_metadata_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.DeleteMetadataStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.execution_path
execution_path(
project: str, location: str, metadata_store: str, execution: str
) -> str
Returns a fully-qualified execution string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.execution_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_artifact
get_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.GetArtifactRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.artifact.Artifact
Retrieves a specific Artifact.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_artifact
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_context
get_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.GetContextRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.context.Context
Retrieves a specific Context.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_context
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_execution
get_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.GetExecutionRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.execution.Execution
Retrieves a specific Execution.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_execution
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_metadata_schema
get_metadata_schema(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.GetMetadataSchemaRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.metadata_schema.MetadataSchema
Retrieves a specific MetadataSchema.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_metadata_schema
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_metadata_store
get_metadata_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.GetMetadataStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.metadata_store.MetadataStore
Retrieves a specific MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_metadata_store
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.metadata_service.transports.base.MetadataServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_artifacts
list_artifacts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.ListArtifactsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListArtifactsAsyncPager
)
Lists Artifacts in the MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_artifacts
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_contexts
list_contexts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.ListContextsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.metadata_service.pagers.ListContextsAsyncPager
Lists Contexts on the MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_contexts
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_executions
list_executions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.ListExecutionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListExecutionsAsyncPager
)
Lists Executions in the MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_executions
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_metadata_schemas
list_metadata_schemas(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.ListMetadataSchemasRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListMetadataSchemasAsyncPager
)
Lists MetadataSchemas.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_metadata_stores
list_metadata_stores(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.ListMetadataStoresRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListMetadataStoresAsyncPager
)
Lists MetadataStores for a Location.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_metadata_stores
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.metadata_schema_path
metadata_schema_path(
project: str, location: str, metadata_store: str, metadata_schema: str
) -> str
Returns a fully-qualified metadata_schema string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.metadata_schema_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.metadata_store_path
metadata_store_path(project: str, location: str, metadata_store: str) -> str
Returns a fully-qualified metadata_store string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.metadata_store_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_artifact_path
parse_artifact_path(path: str) -> typing.Dict[str, str]
Parses a artifact path into its component segments.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_artifact_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_context_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_execution_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_metadata_schema_path
parse_metadata_schema_path(path: str) -> typing.Dict[str, str]
Parses a metadata_schema path into its component segments.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.parse_metadata_store_path
parse_metadata_store_path(path: str) -> typing.Dict[str, str]
Parses a metadata_store path into its component segments.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.purge_artifacts
purge_artifacts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.PurgeArtifactsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Purges Artifacts.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.purge_artifacts
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.purge_contexts
purge_contexts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.PurgeContextsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Purges Contexts.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.purge_contexts
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.purge_executions
purge_executions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.PurgeExecutionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Purges Executions.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.purge_executions
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.query_artifact_lineage_subgraph
query_artifact_lineage_subgraph(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.QueryArtifactLineageSubgraphRequest,
dict,
]
] = None,
*,
artifact: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.lineage_subgraph.LineageSubgraph
Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.query_context_lineage_subgraph
query_context_lineage_subgraph(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.QueryContextLineageSubgraphRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.lineage_subgraph.LineageSubgraph
Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.query_execution_inputs_and_outputs
query_execution_inputs_and_outputs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.QueryExecutionInputsAndOutputsRequest,
dict,
]
] = None,
*,
execution: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.lineage_subgraph.LineageSubgraph
Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.remove_context_children
remove_context_children(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.RemoveContextChildrenRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
child_contexts: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.metadata_service.RemoveContextChildrenResponse
Remove a set of children contexts from a parent Context.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.update_artifact
update_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.UpdateArtifactRequest,
dict,
]
] = None,
*,
artifact: typing.Optional[
google.cloud.aiplatform_v1.types.artifact.Artifact
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.artifact.Artifact
Updates a stored Artifact.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.update_artifact
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.update_context
update_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.UpdateContextRequest, dict
]
] = None,
*,
context: typing.Optional[google.cloud.aiplatform_v1.types.context.Context] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.context.Context
Updates a stored Context.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.update_context
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.update_execution
update_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.UpdateExecutionRequest,
dict,
]
] = None,
*,
execution: typing.Optional[
google.cloud.aiplatform_v1.types.execution.Execution
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.execution.Execution
Updates a stored Execution.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.update_execution
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient
MetadataServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.metadata_service.transports.base.MetadataServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the metadata service client.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.exit
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.add_context_artifacts_and_executions
add_context_artifacts_and_executions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.AddContextArtifactsAndExecutionsRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
artifacts: typing.Optional[typing.MutableSequence[str]] = None,
executions: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.metadata_service.AddContextArtifactsAndExecutionsResponse
)
Adds a set of Artifacts and Executions to a Context.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.add_context_children
add_context_children(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.AddContextChildrenRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
child_contexts: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.metadata_service.AddContextChildrenResponse
Adds a set of Contexts as children to a parent Context.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.add_context_children
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.add_execution_events
add_execution_events(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.AddExecutionEventsRequest,
dict,
]
] = None,
*,
execution: typing.Optional[str] = None,
events: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1.types.event.Event]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.metadata_service.AddExecutionEventsResponse
Adds Events to the specified Execution.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.add_execution_events
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.artifact_path
artifact_path(
project: str, location: str, metadata_store: str, artifact: str
) -> str
Returns a fully-qualified artifact string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.artifact_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.common_location_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.common_organization_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.common_project_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.context_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.create_artifact
create_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.CreateArtifactRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
artifact: typing.Optional[
google.cloud.aiplatform_v1.types.artifact.Artifact
] = None,
artifact_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.artifact.Artifact
Creates an Artifact associated with a MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.create_artifact
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.create_context
create_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.CreateContextRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
context: typing.Optional[google.cloud.aiplatform_v1.types.context.Context] = None,
context_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.context.Context
Creates a Context associated with a MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.create_context
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.create_execution
create_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.CreateExecutionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
execution: typing.Optional[
google.cloud.aiplatform_v1.types.execution.Execution
] = None,
execution_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.execution.Execution
Creates an Execution associated with a MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.create_execution
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.create_metadata_schema
create_metadata_schema(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.CreateMetadataSchemaRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
metadata_schema: typing.Optional[
google.cloud.aiplatform_v1.types.metadata_schema.MetadataSchema
] = None,
metadata_schema_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.metadata_schema.MetadataSchema
Creates a MetadataSchema.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.create_metadata_schema
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.create_metadata_store
create_metadata_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.CreateMetadataStoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
metadata_store: typing.Optional[
google.cloud.aiplatform_v1.types.metadata_store.MetadataStore
] = None,
metadata_store_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Initializes a MetadataStore, including allocation of resources.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.create_metadata_store
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.delete_artifact
delete_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.DeleteArtifactRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes an Artifact.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.delete_artifact
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.delete_context
delete_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.DeleteContextRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a stored Context.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.delete_context
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.delete_execution
delete_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.DeleteExecutionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes an Execution.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.delete_execution
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.delete_metadata_store
delete_metadata_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.DeleteMetadataStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.delete_metadata_store
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.delete_operation
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.execution_path
execution_path(
project: str, location: str, metadata_store: str, execution: str
) -> str
Returns a fully-qualified execution string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.execution_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.from_service_account_file
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.from_service_account_info
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.from_service_account_json
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_artifact
get_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.GetArtifactRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.artifact.Artifact
Retrieves a specific Artifact.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_artifact
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_context
get_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.GetContextRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.context.Context
Retrieves a specific Context.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_context
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_execution
get_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.GetExecutionRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.execution.Execution
Retrieves a specific Execution.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_execution
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_location
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_metadata_schema
get_metadata_schema(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.GetMetadataSchemaRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.metadata_schema.MetadataSchema
Retrieves a specific MetadataSchema.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_metadata_schema
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_metadata_store
get_metadata_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.GetMetadataStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.metadata_store.MetadataStore
Retrieves a specific MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_metadata_store
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.get_operation
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_artifacts
list_artifacts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.ListArtifactsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.metadata_service.pagers.ListArtifactsPager
Lists Artifacts in the MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_artifacts
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_contexts
list_contexts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.ListContextsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.metadata_service.pagers.ListContextsPager
Lists Contexts on the MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_contexts
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_executions
list_executions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.ListExecutionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.metadata_service.pagers.ListExecutionsPager
Lists Executions in the MetadataStore.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_executions
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_locations
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_metadata_schemas
list_metadata_schemas(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.ListMetadataSchemasRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListMetadataSchemasPager
)
Lists MetadataSchemas.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_metadata_schemas
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_metadata_stores
list_metadata_stores(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.ListMetadataStoresRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListMetadataStoresPager
)
Lists MetadataStores for a Location.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_metadata_stores
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.list_operations
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.metadata_schema_path
metadata_schema_path(
project: str, location: str, metadata_store: str, metadata_schema: str
) -> str
Returns a fully-qualified metadata_schema string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.metadata_schema_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.metadata_store_path
metadata_store_path(project: str, location: str, metadata_store: str) -> str
Returns a fully-qualified metadata_store string.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.metadata_store_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_artifact_path
parse_artifact_path(path: str) -> typing.Dict[str, str]
Parses a artifact path into its component segments.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_artifact_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_common_project_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_context_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_execution_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_metadata_schema_path
parse_metadata_schema_path(path: str) -> typing.Dict[str, str]
Parses a metadata_schema path into its component segments.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_metadata_store_path
parse_metadata_store_path(path: str) -> typing.Dict[str, str]
Parses a metadata_store path into its component segments.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.parse_metadata_store_path
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.purge_artifacts
purge_artifacts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.PurgeArtifactsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Purges Artifacts.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.purge_artifacts
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.purge_contexts
purge_contexts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.PurgeContextsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Purges Contexts.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.purge_contexts
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.purge_executions
purge_executions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.PurgeExecutionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Purges Executions.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.purge_executions
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.query_artifact_lineage_subgraph
query_artifact_lineage_subgraph(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.QueryArtifactLineageSubgraphRequest,
dict,
]
] = None,
*,
artifact: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.lineage_subgraph.LineageSubgraph
Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.query_context_lineage_subgraph
query_context_lineage_subgraph(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.QueryContextLineageSubgraphRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.lineage_subgraph.LineageSubgraph
Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.query_execution_inputs_and_outputs
query_execution_inputs_and_outputs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.QueryExecutionInputsAndOutputsRequest,
dict,
]
] = None,
*,
execution: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.lineage_subgraph.LineageSubgraph
Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.remove_context_children
remove_context_children(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.RemoveContextChildrenRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
child_contexts: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.metadata_service.RemoveContextChildrenResponse
Remove a set of children contexts from a parent Context.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.remove_context_children
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.update_artifact
update_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.UpdateArtifactRequest,
dict,
]
] = None,
*,
artifact: typing.Optional[
google.cloud.aiplatform_v1.types.artifact.Artifact
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.artifact.Artifact
Updates a stored Artifact.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.update_artifact
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.update_context
update_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.UpdateContextRequest, dict
]
] = None,
*,
context: typing.Optional[google.cloud.aiplatform_v1.types.context.Context] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.context.Context
Updates a stored Context.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.update_context
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.update_execution
update_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.metadata_service.UpdateExecutionRequest,
dict,
]
] = None,
*,
execution: typing.Optional[
google.cloud.aiplatform_v1.types.execution.Execution
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.execution.Execution
Updates a stored Execution.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.update_execution
google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.metadata_service.MetadataServiceClient.wait_operation
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListArtifactsAsyncPager
ListArtifactsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.metadata_service.ListArtifactsResponse
],
],
request: google.cloud.aiplatform_v1.types.metadata_service.ListArtifactsRequest,
response: google.cloud.aiplatform_v1.types.metadata_service.ListArtifactsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.metadata_service.pagers.ListArtifactsAsyncPager
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListArtifactsPager
ListArtifactsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.metadata_service.ListArtifactsResponse
],
request: google.cloud.aiplatform_v1.types.metadata_service.ListArtifactsRequest,
response: google.cloud.aiplatform_v1.types.metadata_service.ListArtifactsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.metadata_service.pagers.ListArtifactsPager
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListContextsAsyncPager
ListContextsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.metadata_service.ListContextsResponse
],
],
request: google.cloud.aiplatform_v1.types.metadata_service.ListContextsRequest,
response: google.cloud.aiplatform_v1.types.metadata_service.ListContextsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.metadata_service.pagers.ListContextsAsyncPager
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListContextsPager
ListContextsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.metadata_service.ListContextsResponse
],
request: google.cloud.aiplatform_v1.types.metadata_service.ListContextsRequest,
response: google.cloud.aiplatform_v1.types.metadata_service.ListContextsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.metadata_service.pagers.ListContextsPager
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListExecutionsAsyncPager
ListExecutionsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.metadata_service.ListExecutionsResponse
],
],
request: google.cloud.aiplatform_v1.types.metadata_service.ListExecutionsRequest,
response: google.cloud.aiplatform_v1.types.metadata_service.ListExecutionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.metadata_service.pagers.ListExecutionsAsyncPager
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListExecutionsPager
ListExecutionsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.metadata_service.ListExecutionsResponse
],
request: google.cloud.aiplatform_v1.types.metadata_service.ListExecutionsRequest,
response: google.cloud.aiplatform_v1.types.metadata_service.ListExecutionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.metadata_service.pagers.ListExecutionsPager
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListMetadataSchemasAsyncPager
ListMetadataSchemasAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.metadata_service.ListMetadataSchemasResponse
],
],
request: google.cloud.aiplatform_v1.types.metadata_service.ListMetadataSchemasRequest,
response: google.cloud.aiplatform_v1.types.metadata_service.ListMetadataSchemasResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.metadata_service.pagers.ListMetadataSchemasAsyncPager
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListMetadataSchemasPager
ListMetadataSchemasPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.metadata_service.ListMetadataSchemasResponse,
],
request: google.cloud.aiplatform_v1.types.metadata_service.ListMetadataSchemasRequest,
response: google.cloud.aiplatform_v1.types.metadata_service.ListMetadataSchemasResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.metadata_service.pagers.ListMetadataSchemasPager
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListMetadataStoresAsyncPager
ListMetadataStoresAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.metadata_service.ListMetadataStoresResponse
],
],
request: google.cloud.aiplatform_v1.types.metadata_service.ListMetadataStoresRequest,
response: google.cloud.aiplatform_v1.types.metadata_service.ListMetadataStoresResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.metadata_service.pagers.ListMetadataStoresAsyncPager
google.cloud.aiplatform_v1.services.metadata_service.pagers.ListMetadataStoresPager
ListMetadataStoresPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.metadata_service.ListMetadataStoresResponse,
],
request: google.cloud.aiplatform_v1.types.metadata_service.ListMetadataStoresRequest,
response: google.cloud.aiplatform_v1.types.metadata_service.ListMetadataStoresResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.metadata_service.pagers.ListMetadataStoresPager
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient
MigrationServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.migration_service.transports.base.MigrationServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the migration service async client.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.annotated_dataset_path
annotated_dataset_path(project: str, dataset: str, annotated_dataset: str) -> str
Returns a fully-qualified annotated_dataset string.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.batch_migrate_resources
batch_migrate_resources(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.migration_service.BatchMigrateResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
migrate_resource_requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.migration_service.MigrateResourceRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.dataset_path
dataset_path(project: str, location: str, dataset: str) -> str
Returns a fully-qualified dataset string.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.dataset_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.migration_service.transports.base.MigrationServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.model_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.parse_annotated_dataset_path
parse_annotated_dataset_path(path: str) -> typing.Dict[str, str]
Parses a annotated_dataset path into its component segments.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.parse_dataset_path
parse_dataset_path(path: str) -> typing.Dict[str, str]
Parses a dataset path into its component segments.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.parse_dataset_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.parse_model_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.parse_version_path
parse_version_path(path: str) -> typing.Dict[str, str]
Parses a version path into its component segments.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.parse_version_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.search_migratable_resources
search_migratable_resources(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.migration_service.SearchMigratableResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.migration_service.pagers.SearchMigratableResourcesAsyncPager
)
Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.version_path
version_path(project: str, model: str, version: str) -> str
Returns a fully-qualified version string.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.version_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient
MigrationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.migration_service.transports.base.MigrationServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the migration service client.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.exit
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.annotated_dataset_path
annotated_dataset_path(project: str, dataset: str, annotated_dataset: str) -> str
Returns a fully-qualified annotated_dataset string.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.annotated_dataset_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.batch_migrate_resources
batch_migrate_resources(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.migration_service.BatchMigrateResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
migrate_resource_requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.migration_service.MigrateResourceRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.batch_migrate_resources
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.common_location_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.common_project_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.dataset_path
dataset_path(project: str, location: str, dataset: str) -> str
Returns a fully-qualified dataset string.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.dataset_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.delete_operation
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.get_location
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.get_operation
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.list_locations
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.list_operations
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.model_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.parse_annotated_dataset_path
parse_annotated_dataset_path(path: str) -> typing.Dict[str, str]
Parses a annotated_dataset path into its component segments.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.parse_dataset_path
parse_dataset_path(path: str) -> typing.Dict[str, str]
Parses a dataset path into its component segments.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.parse_dataset_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.parse_model_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.parse_version_path
parse_version_path(path: str) -> typing.Dict[str, str]
Parses a version path into its component segments.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.parse_version_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.search_migratable_resources
search_migratable_resources(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.migration_service.SearchMigratableResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.migration_service.pagers.SearchMigratableResourcesPager
)
Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.version_path
version_path(project: str, model: str, version: str) -> str
Returns a fully-qualified version string.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.version_path
google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.migration_service.MigrationServiceClient.wait_operation
google.cloud.aiplatform_v1.services.migration_service.pagers.SearchMigratableResourcesAsyncPager
SearchMigratableResourcesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.migration_service.SearchMigratableResourcesResponse
],
],
request: google.cloud.aiplatform_v1.types.migration_service.SearchMigratableResourcesRequest,
response: google.cloud.aiplatform_v1.types.migration_service.SearchMigratableResourcesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.migration_service.pagers.SearchMigratableResourcesAsyncPager
google.cloud.aiplatform_v1.services.migration_service.pagers.SearchMigratableResourcesPager
SearchMigratableResourcesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.migration_service.SearchMigratableResourcesResponse,
],
request: google.cloud.aiplatform_v1.types.migration_service.SearchMigratableResourcesRequest,
response: google.cloud.aiplatform_v1.types.migration_service.SearchMigratableResourcesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.migration_service.pagers.SearchMigratableResourcesPager
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient
ModelGardenServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.model_garden_service.transports.base.ModelGardenServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the model garden service async client.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.get_publisher_model
get_publisher_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_garden_service.GetPublisherModelRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.publisher_model.PublisherModel
Gets a Model Garden publisher model.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.model_garden_service.transports.base.ModelGardenServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.parse_publisher_model_path
parse_publisher_model_path(path: str) -> typing.Dict[str, str]
Parses a publisher_model path into its component segments.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.publisher_model_path
publisher_model_path(publisher: str, model: str) -> str
Returns a fully-qualified publisher_model string.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient
ModelGardenServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.model_garden_service.transports.base.ModelGardenServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the model garden service client.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.exit
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.delete_operation
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.get_location
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.get_operation
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.get_publisher_model
get_publisher_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_garden_service.GetPublisherModelRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.publisher_model.PublisherModel
Gets a Model Garden publisher model.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.list_locations
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.list_operations
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.parse_publisher_model_path
parse_publisher_model_path(path: str) -> typing.Dict[str, str]
Parses a publisher_model path into its component segments.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.publisher_model_path
publisher_model_path(publisher: str, model: str) -> str
Returns a fully-qualified publisher_model string.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.model_garden_service.ModelGardenServiceClient.wait_operation
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient
ModelServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.model_service.transports.base.ModelServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the model service async client.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.batch_import_evaluated_annotations
batch_import_evaluated_annotations(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.BatchImportEvaluatedAnnotationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
evaluated_annotations: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.evaluated_annotation.EvaluatedAnnotation
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.model_service.BatchImportEvaluatedAnnotationsResponse
)
Imports a list of externally generated EvaluatedAnnotations.
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.batch_import_model_evaluation_slices
batch_import_model_evaluation_slices(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.BatchImportModelEvaluationSlicesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
model_evaluation_slices: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.model_evaluation_slice.ModelEvaluationSlice
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.model_service.BatchImportModelEvaluationSlicesResponse
)
Imports a list of externally generated ModelEvaluationSlice.
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.common_organization_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.copy_model
copy_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.CopyModelRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
source_model: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Copies an already existing Vertex AI Model into the specified Location.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.copy_model
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.delete_model
delete_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.DeleteModelRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a Model.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.delete_model
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.delete_model_version
delete_model_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.DeleteModelVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a Model version.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.delete_model_version
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.endpoint_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.export_model
export_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.ExportModelRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
output_config: typing.Optional[
google.cloud.aiplatform_v1.types.model_service.ExportModelRequest.OutputConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Exports a trained, exportable Model to a location specified by the user.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.export_model
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.from_service_account_file
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.from_service_account_info
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.from_service_account_json
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_model
get_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.GetModelRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.model.Model
Gets a Model.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_model
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_model_evaluation
get_model_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.GetModelEvaluationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.model_evaluation.ModelEvaluation
Gets a ModelEvaluation.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_model_evaluation
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_model_evaluation_slice
get_model_evaluation_slice(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.GetModelEvaluationSliceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.model_evaluation_slice.ModelEvaluationSlice
Gets a ModelEvaluationSlice.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_model_evaluation_slice
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.model_service.transports.base.ModelServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.import_model_evaluation
import_model_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.ImportModelEvaluationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
model_evaluation: typing.Optional[
google.cloud.aiplatform_v1.types.model_evaluation.ModelEvaluation
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.model_evaluation.ModelEvaluation
Imports an externally generated ModelEvaluation.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.import_model_evaluation
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.list_model_evaluation_slices
list_model_evaluation_slices(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationSlicesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.model_service.pagers.ListModelEvaluationSlicesAsyncPager
)
Lists ModelEvaluationSlices in a ModelEvaluation.
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.list_model_evaluations
list_model_evaluations(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.model_service.pagers.ListModelEvaluationsAsyncPager
)
Lists ModelEvaluations in a Model.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.list_model_evaluations
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.list_model_versions
list_model_versions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.ListModelVersionsRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.model_service.pagers.ListModelVersionsAsyncPager
)
Lists versions of the specified model.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.list_model_versions
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.list_models
list_models(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.ListModelsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.model_service.pagers.ListModelsAsyncPager
Lists Models in a Location.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.list_models
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.merge_version_aliases
merge_version_aliases(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.MergeVersionAliasesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
version_aliases: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.model.Model
Merges a set of aliases for a Model version.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.merge_version_aliases
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.model_evaluation_path
model_evaluation_path(
project: str, location: str, model: str, evaluation: str
) -> str
Returns a fully-qualified model_evaluation string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.model_evaluation_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.model_evaluation_slice_path
model_evaluation_slice_path(
project: str, location: str, model: str, evaluation: str, slice: str
) -> str
Returns a fully-qualified model_evaluation_slice string.
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.model_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_common_location_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_common_project_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_endpoint_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_model_evaluation_path
parse_model_evaluation_path(path: str) -> typing.Dict[str, str]
Parses a model_evaluation path into its component segments.
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_model_evaluation_slice_path
parse_model_evaluation_slice_path(path: str) -> typing.Dict[str, str]
Parses a model_evaluation_slice path into its component segments.
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_model_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_pipeline_job_path
parse_pipeline_job_path(path: str) -> typing.Dict[str, str]
Parses a pipeline_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_pipeline_job_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.parse_training_pipeline_path
parse_training_pipeline_path(path: str) -> typing.Dict[str, str]
Parses a training_pipeline path into its component segments.
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.pipeline_job_path
pipeline_job_path(project: str, location: str, pipeline_job: str) -> str
Returns a fully-qualified pipeline_job string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.pipeline_job_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.training_pipeline_path
training_pipeline_path(project: str, location: str, training_pipeline: str) -> str
Returns a fully-qualified training_pipeline string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.training_pipeline_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.update_explanation_dataset
update_explanation_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.UpdateExplanationDatasetRequest,
dict,
]
] = None,
*,
model: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Incrementally update the dataset used for an examples model.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.update_explanation_dataset
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.update_model
update_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.UpdateModelRequest, dict
]
] = None,
*,
model: typing.Optional[google.cloud.aiplatform_v1.types.model.Model] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.model.Model
Updates a Model.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.update_model
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.upload_model
upload_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.UploadModelRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
model: typing.Optional[google.cloud.aiplatform_v1.types.model.Model] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Uploads a Model artifact into Vertex AI.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.upload_model
google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient
ModelServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.model_service.transports.base.ModelServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the model service client.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.exit
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.batch_import_evaluated_annotations
batch_import_evaluated_annotations(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.BatchImportEvaluatedAnnotationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
evaluated_annotations: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.evaluated_annotation.EvaluatedAnnotation
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.model_service.BatchImportEvaluatedAnnotationsResponse
)
Imports a list of externally generated EvaluatedAnnotations.
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.batch_import_model_evaluation_slices
batch_import_model_evaluation_slices(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.BatchImportModelEvaluationSlicesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
model_evaluation_slices: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.model_evaluation_slice.ModelEvaluationSlice
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.model_service.BatchImportModelEvaluationSlicesResponse
)
Imports a list of externally generated ModelEvaluationSlice.
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.common_billing_account_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.common_location_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.common_organization_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.common_project_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.copy_model
copy_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.CopyModelRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
source_model: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Copies an already existing Vertex AI Model into the specified Location.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.copy_model
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.delete_model
delete_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.DeleteModelRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a Model.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.delete_model
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.delete_model_version
delete_model_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.DeleteModelVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a Model version.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.delete_model_version
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.delete_operation
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.endpoint_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.export_model
export_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.ExportModelRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
output_config: typing.Optional[
google.cloud.aiplatform_v1.types.model_service.ExportModelRequest.OutputConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Exports a trained, exportable Model to a location specified by the user.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.export_model
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.from_service_account_file
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.from_service_account_info
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.from_service_account_json
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_location
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_model
get_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.GetModelRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.model.Model
Gets a Model.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_model
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_model_evaluation
get_model_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.GetModelEvaluationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.model_evaluation.ModelEvaluation
Gets a ModelEvaluation.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_model_evaluation
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_model_evaluation_slice
get_model_evaluation_slice(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.GetModelEvaluationSliceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.model_evaluation_slice.ModelEvaluationSlice
Gets a ModelEvaluationSlice.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_model_evaluation_slice
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.get_operation
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.import_model_evaluation
import_model_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.ImportModelEvaluationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
model_evaluation: typing.Optional[
google.cloud.aiplatform_v1.types.model_evaluation.ModelEvaluation
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.model_evaluation.ModelEvaluation
Imports an externally generated ModelEvaluation.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.import_model_evaluation
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.list_locations
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.list_model_evaluation_slices
list_model_evaluation_slices(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationSlicesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.model_service.pagers.ListModelEvaluationSlicesPager
)
Lists ModelEvaluationSlices in a ModelEvaluation.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.list_model_evaluation_slices
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.list_model_evaluations
list_model_evaluations(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.model_service.pagers.ListModelEvaluationsPager
Lists ModelEvaluations in a Model.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.list_model_evaluations
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.list_model_versions
list_model_versions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.ListModelVersionsRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.model_service.pagers.ListModelVersionsPager
Lists versions of the specified model.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.list_model_versions
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.list_models
list_models(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.ListModelsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.model_service.pagers.ListModelsPager
Lists Models in a Location.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.list_models
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.list_operations
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.merge_version_aliases
merge_version_aliases(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.MergeVersionAliasesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
version_aliases: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.model.Model
Merges a set of aliases for a Model version.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.merge_version_aliases
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.model_evaluation_path
model_evaluation_path(
project: str, location: str, model: str, evaluation: str
) -> str
Returns a fully-qualified model_evaluation string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.model_evaluation_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.model_evaluation_slice_path
model_evaluation_slice_path(
project: str, location: str, model: str, evaluation: str, slice: str
) -> str
Returns a fully-qualified model_evaluation_slice string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.model_evaluation_slice_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.model_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_common_location_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_common_organization_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_common_project_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_endpoint_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_model_evaluation_path
parse_model_evaluation_path(path: str) -> typing.Dict[str, str]
Parses a model_evaluation path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_model_evaluation_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_model_evaluation_slice_path
parse_model_evaluation_slice_path(path: str) -> typing.Dict[str, str]
Parses a model_evaluation_slice path into its component segments.
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_model_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_pipeline_job_path
parse_pipeline_job_path(path: str) -> typing.Dict[str, str]
Parses a pipeline_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_pipeline_job_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_training_pipeline_path
parse_training_pipeline_path(path: str) -> typing.Dict[str, str]
Parses a training_pipeline path into its component segments.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.parse_training_pipeline_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.pipeline_job_path
pipeline_job_path(project: str, location: str, pipeline_job: str) -> str
Returns a fully-qualified pipeline_job string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.pipeline_job_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.training_pipeline_path
training_pipeline_path(project: str, location: str, training_pipeline: str) -> str
Returns a fully-qualified training_pipeline string.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.training_pipeline_path
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.update_explanation_dataset
update_explanation_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.UpdateExplanationDatasetRequest,
dict,
]
] = None,
*,
model: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Incrementally update the dataset used for an examples model.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.update_explanation_dataset
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.update_model
update_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.UpdateModelRequest, dict
]
] = None,
*,
model: typing.Optional[google.cloud.aiplatform_v1.types.model.Model] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.model.Model
Updates a Model.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.update_model
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.upload_model
upload_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.model_service.UploadModelRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
model: typing.Optional[google.cloud.aiplatform_v1.types.model.Model] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Uploads a Model artifact into Vertex AI.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.upload_model
google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.model_service.ModelServiceClient.wait_operation
google.cloud.aiplatform_v1.services.model_service.pagers.ListModelEvaluationSlicesAsyncPager
ListModelEvaluationSlicesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationSlicesResponse
],
],
request: google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationSlicesRequest,
response: google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationSlicesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.model_service.pagers.ListModelEvaluationSlicesAsyncPager
google.cloud.aiplatform_v1.services.model_service.pagers.ListModelEvaluationSlicesPager
ListModelEvaluationSlicesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationSlicesResponse,
],
request: google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationSlicesRequest,
response: google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationSlicesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.model_service.pagers.ListModelEvaluationSlicesPager
google.cloud.aiplatform_v1.services.model_service.pagers.ListModelEvaluationsAsyncPager
ListModelEvaluationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationsResponse
],
],
request: google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationsRequest,
response: google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.model_service.pagers.ListModelEvaluationsAsyncPager
google.cloud.aiplatform_v1.services.model_service.pagers.ListModelEvaluationsPager
ListModelEvaluationsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationsResponse,
],
request: google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationsRequest,
response: google.cloud.aiplatform_v1.types.model_service.ListModelEvaluationsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.model_service.pagers.ListModelEvaluationsPager
google.cloud.aiplatform_v1.services.model_service.pagers.ListModelVersionsAsyncPager
ListModelVersionsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.model_service.ListModelVersionsResponse
],
],
request: google.cloud.aiplatform_v1.types.model_service.ListModelVersionsRequest,
response: google.cloud.aiplatform_v1.types.model_service.ListModelVersionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.model_service.pagers.ListModelVersionsAsyncPager
google.cloud.aiplatform_v1.services.model_service.pagers.ListModelVersionsPager
ListModelVersionsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.model_service.ListModelVersionsResponse
],
request: google.cloud.aiplatform_v1.types.model_service.ListModelVersionsRequest,
response: google.cloud.aiplatform_v1.types.model_service.ListModelVersionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.model_service.pagers.ListModelVersionsPager
google.cloud.aiplatform_v1.services.model_service.pagers.ListModelsAsyncPager
ListModelsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.model_service.ListModelsResponse
],
],
request: google.cloud.aiplatform_v1.types.model_service.ListModelsRequest,
response: google.cloud.aiplatform_v1.types.model_service.ListModelsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.model_service.pagers.ListModelsAsyncPager
google.cloud.aiplatform_v1.services.model_service.pagers.ListModelsPager
ListModelsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.model_service.ListModelsResponse
],
request: google.cloud.aiplatform_v1.types.model_service.ListModelsRequest,
response: google.cloud.aiplatform_v1.types.model_service.ListModelsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.model_service.pagers.ListModelsPager
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient
NotebookServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.notebook_service.transports.base.NotebookServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the notebook service async client.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.assign_notebook_runtime
assign_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.AssignNotebookRuntimeRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
notebook_runtime_template: typing.Optional[str] = None,
notebook_runtime: typing.Optional[
google.cloud.aiplatform_v1.types.notebook_runtime.NotebookRuntime
] = None,
notebook_runtime_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Assigns a NotebookRuntime to a user for a particular Notebook file.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.create_notebook_runtime_template
create_notebook_runtime_template(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.CreateNotebookRuntimeTemplateRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
notebook_runtime_template: typing.Optional[
google.cloud.aiplatform_v1.types.notebook_runtime.NotebookRuntimeTemplate
] = None,
notebook_runtime_template_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a NotebookRuntimeTemplate.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.delete_notebook_runtime
delete_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.DeleteNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a NotebookRuntime.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.delete_notebook_runtime_template
delete_notebook_runtime_template(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.DeleteNotebookRuntimeTemplateRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a NotebookRuntimeTemplate.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.get_notebook_runtime
get_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.GetNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.notebook_runtime.NotebookRuntime
Gets a NotebookRuntime.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.get_notebook_runtime
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.get_notebook_runtime_template
get_notebook_runtime_template(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.GetNotebookRuntimeTemplateRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.notebook_runtime.NotebookRuntimeTemplate
Gets a NotebookRuntimeTemplate.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.notebook_service.transports.base.NotebookServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.list_notebook_runtime_templates
list_notebook_runtime_templates(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimeTemplatesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.notebook_service.pagers.ListNotebookRuntimeTemplatesAsyncPager
)
Lists NotebookRuntimeTemplates in a Location.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.list_notebook_runtimes
list_notebook_runtimes(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.notebook_service.pagers.ListNotebookRuntimesAsyncPager
)
Lists NotebookRuntimes in a Location.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.network_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.notebook_runtime_path
notebook_runtime_path(project: str, location: str, notebook_runtime: str) -> str
Returns a fully-qualified notebook_runtime string.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.notebook_runtime_template_path
notebook_runtime_template_path(
project: str, location: str, notebook_runtime_template: str
) -> str
Returns a fully-qualified notebook_runtime_template string.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.parse_network_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.parse_notebook_runtime_path
parse_notebook_runtime_path(path: str) -> typing.Dict[str, str]
Parses a notebook_runtime path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.parse_notebook_runtime_template_path
parse_notebook_runtime_template_path(path: str) -> typing.Dict[str, str]
Parses a notebook_runtime_template path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.parse_subnetwork_path
parse_subnetwork_path(path: str) -> typing.Dict[str, str]
Parses a subnetwork path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.start_notebook_runtime
start_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.StartNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Starts a NotebookRuntime.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.subnetwork_path
subnetwork_path(project: str, region: str, subnetwork: str) -> str
Returns a fully-qualified subnetwork string.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.subnetwork_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.upgrade_notebook_runtime
upgrade_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.UpgradeNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Upgrades a NotebookRuntime.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient
NotebookServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.notebook_service.transports.base.NotebookServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the notebook service client.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.exit
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.assign_notebook_runtime
assign_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.AssignNotebookRuntimeRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
notebook_runtime_template: typing.Optional[str] = None,
notebook_runtime: typing.Optional[
google.cloud.aiplatform_v1.types.notebook_runtime.NotebookRuntime
] = None,
notebook_runtime_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Assigns a NotebookRuntime to a user for a particular Notebook file.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.assign_notebook_runtime
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.common_location_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.common_organization_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.common_project_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.create_notebook_runtime_template
create_notebook_runtime_template(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.CreateNotebookRuntimeTemplateRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
notebook_runtime_template: typing.Optional[
google.cloud.aiplatform_v1.types.notebook_runtime.NotebookRuntimeTemplate
] = None,
notebook_runtime_template_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a NotebookRuntimeTemplate.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.delete_notebook_runtime
delete_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.DeleteNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a NotebookRuntime.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.delete_notebook_runtime
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.delete_notebook_runtime_template
delete_notebook_runtime_template(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.DeleteNotebookRuntimeTemplateRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a NotebookRuntimeTemplate.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.delete_operation
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.from_service_account_file
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.from_service_account_info
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.from_service_account_json
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.get_location
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.get_notebook_runtime
get_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.GetNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.notebook_runtime.NotebookRuntime
Gets a NotebookRuntime.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.get_notebook_runtime
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.get_notebook_runtime_template
get_notebook_runtime_template(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.GetNotebookRuntimeTemplateRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.notebook_runtime.NotebookRuntimeTemplate
Gets a NotebookRuntimeTemplate.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.get_operation
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.list_locations
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.list_notebook_runtime_templates
list_notebook_runtime_templates(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimeTemplatesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.notebook_service.pagers.ListNotebookRuntimeTemplatesPager
)
Lists NotebookRuntimeTemplates in a Location.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.list_notebook_runtimes
list_notebook_runtimes(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.notebook_service.pagers.ListNotebookRuntimesPager
)
Lists NotebookRuntimes in a Location.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.list_notebook_runtimes
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.list_operations
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.network_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.notebook_runtime_path
notebook_runtime_path(project: str, location: str, notebook_runtime: str) -> str
Returns a fully-qualified notebook_runtime string.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.notebook_runtime_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.notebook_runtime_template_path
notebook_runtime_template_path(
project: str, location: str, notebook_runtime_template: str
) -> str
Returns a fully-qualified notebook_runtime_template string.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_common_project_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_network_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_notebook_runtime_path
parse_notebook_runtime_path(path: str) -> typing.Dict[str, str]
Parses a notebook_runtime path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_notebook_runtime_template_path
parse_notebook_runtime_template_path(path: str) -> typing.Dict[str, str]
Parses a notebook_runtime_template path into its component segments.
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_subnetwork_path
parse_subnetwork_path(path: str) -> typing.Dict[str, str]
Parses a subnetwork path into its component segments.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.parse_subnetwork_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.start_notebook_runtime
start_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.StartNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Starts a NotebookRuntime.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.start_notebook_runtime
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.subnetwork_path
subnetwork_path(project: str, region: str, subnetwork: str) -> str
Returns a fully-qualified subnetwork string.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.subnetwork_path
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.upgrade_notebook_runtime
upgrade_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.notebook_service.UpgradeNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Upgrades a NotebookRuntime.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.upgrade_notebook_runtime
google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.notebook_service.NotebookServiceClient.wait_operation
google.cloud.aiplatform_v1.services.notebook_service.pagers.ListNotebookRuntimeTemplatesAsyncPager
ListNotebookRuntimeTemplatesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimeTemplatesResponse
],
],
request: google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimeTemplatesRequest,
response: google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimeTemplatesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.notebook_service.pagers.ListNotebookRuntimeTemplatesAsyncPager
google.cloud.aiplatform_v1.services.notebook_service.pagers.ListNotebookRuntimeTemplatesPager
ListNotebookRuntimeTemplatesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimeTemplatesResponse,
],
request: google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimeTemplatesRequest,
response: google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimeTemplatesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.notebook_service.pagers.ListNotebookRuntimeTemplatesPager
google.cloud.aiplatform_v1.services.notebook_service.pagers.ListNotebookRuntimesAsyncPager
ListNotebookRuntimesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimesResponse
],
],
request: google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimesRequest,
response: google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.notebook_service.pagers.ListNotebookRuntimesAsyncPager
google.cloud.aiplatform_v1.services.notebook_service.pagers.ListNotebookRuntimesPager
ListNotebookRuntimesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimesResponse,
],
request: google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimesRequest,
response: google.cloud.aiplatform_v1.types.notebook_service.ListNotebookRuntimesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.notebook_service.pagers.ListNotebookRuntimesPager
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient
PersistentResourceServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.persistent_resource_service.transports.base.PersistentResourceServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the persistent resource service async client.
See more: google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.create_persistent_resource
create_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.persistent_resource_service.CreatePersistentResourceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
persistent_resource: typing.Optional[
google.cloud.aiplatform_v1.types.persistent_resource.PersistentResource
] = None,
persistent_resource_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a PersistentResource.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.delete_persistent_resource
delete_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.persistent_resource_service.DeletePersistentResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a PersistentResource.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.get_persistent_resource
get_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.persistent_resource_service.GetPersistentResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.persistent_resource.PersistentResource
Gets a PersistentResource.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.persistent_resource_service.transports.base.PersistentResourceServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.list_persistent_resources
list_persistent_resources(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.persistent_resource_service.ListPersistentResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.persistent_resource_service.pagers.ListPersistentResourcesAsyncPager
)
Lists PersistentResources in a Location.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_persistent_resource_path
parse_persistent_resource_path(path: str) -> typing.Dict[str, str]
Parses a persistent_resource path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.persistent_resource_path
persistent_resource_path(
project: str, location: str, persistent_resource: str
) -> str
Returns a fully-qualified persistent_resource string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.reboot_persistent_resource
reboot_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.persistent_resource_service.RebootPersistentResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Reboots a PersistentResource.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.update_persistent_resource
update_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.persistent_resource_service.UpdatePersistentResourceRequest,
dict,
]
] = None,
*,
persistent_resource: typing.Optional[
google.cloud.aiplatform_v1.types.persistent_resource.PersistentResource
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a PersistentResource.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient
PersistentResourceServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.persistent_resource_service.transports.base.PersistentResourceServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the persistent resource service client.
See more: google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.exit
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.create_persistent_resource
create_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.persistent_resource_service.CreatePersistentResourceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
persistent_resource: typing.Optional[
google.cloud.aiplatform_v1.types.persistent_resource.PersistentResource
] = None,
persistent_resource_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a PersistentResource.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.delete_persistent_resource
delete_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.persistent_resource_service.DeletePersistentResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a PersistentResource.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.get_persistent_resource
get_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.persistent_resource_service.GetPersistentResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.persistent_resource.PersistentResource
Gets a PersistentResource.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.list_persistent_resources
list_persistent_resources(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.persistent_resource_service.ListPersistentResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.persistent_resource_service.pagers.ListPersistentResourcesPager
)
Lists PersistentResources in a Location.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.parse_persistent_resource_path
parse_persistent_resource_path(path: str) -> typing.Dict[str, str]
Parses a persistent_resource path into its component segments.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.persistent_resource_path
persistent_resource_path(
project: str, location: str, persistent_resource: str
) -> str
Returns a fully-qualified persistent_resource string.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.reboot_persistent_resource
reboot_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.persistent_resource_service.RebootPersistentResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Reboots a PersistentResource.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.update_persistent_resource
update_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.persistent_resource_service.UpdatePersistentResourceRequest,
dict,
]
] = None,
*,
persistent_resource: typing.Optional[
google.cloud.aiplatform_v1.types.persistent_resource.PersistentResource
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates a PersistentResource.
google.cloud.aiplatform_v1.services.persistent_resource_service.PersistentResourceServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.persistent_resource_service.pagers.ListPersistentResourcesAsyncPager
ListPersistentResourcesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.persistent_resource_service.ListPersistentResourcesResponse
],
],
request: google.cloud.aiplatform_v1.types.persistent_resource_service.ListPersistentResourcesRequest,
response: google.cloud.aiplatform_v1.types.persistent_resource_service.ListPersistentResourcesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1.services.persistent_resource_service.pagers.ListPersistentResourcesPager
ListPersistentResourcesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.persistent_resource_service.ListPersistentResourcesResponse,
],
request: google.cloud.aiplatform_v1.types.persistent_resource_service.ListPersistentResourcesRequest,
response: google.cloud.aiplatform_v1.types.persistent_resource_service.ListPersistentResourcesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.persistent_resource_service.pagers.ListPersistentResourcesPager
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient
PipelineServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.pipeline_service.transports.base.PipelineServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the pipeline service async client.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.artifact_path
artifact_path(
project: str, location: str, metadata_store: str, artifact: str
) -> str
Returns a fully-qualified artifact string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.artifact_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.batch_cancel_pipeline_jobs
batch_cancel_pipeline_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.BatchCancelPipelineJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
names: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Batch cancel PipelineJobs.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.batch_delete_pipeline_jobs
batch_delete_pipeline_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.BatchDeletePipelineJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
names: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Batch deletes PipelineJobs The Operation is atomic.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.cancel_pipeline_job
cancel_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.CancelPipelineJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a PipelineJob.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.cancel_pipeline_job
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.cancel_training_pipeline
cancel_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.CancelTrainingPipelineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a TrainingPipeline.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.context_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.create_pipeline_job
create_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.CreatePipelineJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
pipeline_job: typing.Optional[
google.cloud.aiplatform_v1.types.pipeline_job.PipelineJob
] = None,
pipeline_job_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.pipeline_job.PipelineJob
Creates a PipelineJob.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.create_pipeline_job
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.create_training_pipeline
create_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.CreateTrainingPipelineRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
training_pipeline: typing.Optional[
google.cloud.aiplatform_v1.types.training_pipeline.TrainingPipeline
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.training_pipeline.TrainingPipeline
Creates a TrainingPipeline.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.custom_job_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.delete_pipeline_job
delete_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.DeletePipelineJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a PipelineJob.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.delete_pipeline_job
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.delete_training_pipeline
delete_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.DeleteTrainingPipelineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a TrainingPipeline.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.endpoint_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.execution_path
execution_path(
project: str, location: str, metadata_store: str, execution: str
) -> str
Returns a fully-qualified execution string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.execution_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.get_pipeline_job
get_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.GetPipelineJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.pipeline_job.PipelineJob
Gets a PipelineJob.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.get_pipeline_job
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.get_training_pipeline
get_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.GetTrainingPipelineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.training_pipeline.TrainingPipeline
Gets a TrainingPipeline.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.pipeline_service.transports.base.PipelineServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.list_pipeline_jobs
list_pipeline_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.ListPipelineJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.pipeline_service.pagers.ListPipelineJobsAsyncPager
)
Lists PipelineJobs in a Location.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.list_pipeline_jobs
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.list_training_pipelines
list_training_pipelines(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.ListTrainingPipelinesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.pipeline_service.pagers.ListTrainingPipelinesAsyncPager
)
Lists TrainingPipelines in a Location.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.model_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.network_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_artifact_path
parse_artifact_path(path: str) -> typing.Dict[str, str]
Parses a artifact path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_artifact_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_context_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_endpoint_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_execution_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_model_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_network_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_pipeline_job_path
parse_pipeline_job_path(path: str) -> typing.Dict[str, str]
Parses a pipeline_job path into its component segments.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_training_pipeline_path
parse_training_pipeline_path(path: str) -> typing.Dict[str, str]
Parses a training_pipeline path into its component segments.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.pipeline_job_path
pipeline_job_path(project: str, location: str, pipeline_job: str) -> str
Returns a fully-qualified pipeline_job string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.pipeline_job_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.training_pipeline_path
training_pipeline_path(project: str, location: str, training_pipeline: str) -> str
Returns a fully-qualified training_pipeline string.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient
PipelineServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.pipeline_service.transports.base.PipelineServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the pipeline service client.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.exit
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.artifact_path
artifact_path(
project: str, location: str, metadata_store: str, artifact: str
) -> str
Returns a fully-qualified artifact string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.artifact_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.batch_cancel_pipeline_jobs
batch_cancel_pipeline_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.BatchCancelPipelineJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
names: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Batch cancel PipelineJobs.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.batch_delete_pipeline_jobs
batch_delete_pipeline_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.BatchDeletePipelineJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
names: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Batch deletes PipelineJobs The Operation is atomic.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.cancel_pipeline_job
cancel_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.CancelPipelineJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a PipelineJob.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.cancel_pipeline_job
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.cancel_training_pipeline
cancel_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.CancelTrainingPipelineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a TrainingPipeline.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.cancel_training_pipeline
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.common_location_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.common_organization_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.common_project_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.context_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.create_pipeline_job
create_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.CreatePipelineJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
pipeline_job: typing.Optional[
google.cloud.aiplatform_v1.types.pipeline_job.PipelineJob
] = None,
pipeline_job_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.pipeline_job.PipelineJob
Creates a PipelineJob.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.create_pipeline_job
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.create_training_pipeline
create_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.CreateTrainingPipelineRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
training_pipeline: typing.Optional[
google.cloud.aiplatform_v1.types.training_pipeline.TrainingPipeline
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.training_pipeline.TrainingPipeline
Creates a TrainingPipeline.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.create_training_pipeline
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.custom_job_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.delete_operation
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.delete_pipeline_job
delete_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.DeletePipelineJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a PipelineJob.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.delete_pipeline_job
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.delete_training_pipeline
delete_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.DeleteTrainingPipelineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a TrainingPipeline.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.delete_training_pipeline
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.endpoint_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.execution_path
execution_path(
project: str, location: str, metadata_store: str, execution: str
) -> str
Returns a fully-qualified execution string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.execution_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.from_service_account_file
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.from_service_account_info
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.from_service_account_json
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.get_location
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.get_operation
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.get_pipeline_job
get_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.GetPipelineJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.pipeline_job.PipelineJob
Gets a PipelineJob.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.get_pipeline_job
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.get_training_pipeline
get_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.GetTrainingPipelineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.training_pipeline.TrainingPipeline
Gets a TrainingPipeline.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.get_training_pipeline
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.list_locations
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.list_operations
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.list_pipeline_jobs
list_pipeline_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.ListPipelineJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.pipeline_service.pagers.ListPipelineJobsPager
Lists PipelineJobs in a Location.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.list_pipeline_jobs
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.list_training_pipelines
list_training_pipelines(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.pipeline_service.ListTrainingPipelinesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.pipeline_service.pagers.ListTrainingPipelinesPager
)
Lists TrainingPipelines in a Location.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.list_training_pipelines
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.model_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.network_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_artifact_path
parse_artifact_path(path: str) -> typing.Dict[str, str]
Parses a artifact path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_artifact_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_common_project_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_context_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_custom_job_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_endpoint_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_execution_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_model_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_network_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_pipeline_job_path
parse_pipeline_job_path(path: str) -> typing.Dict[str, str]
Parses a pipeline_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_pipeline_job_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.parse_training_pipeline_path
parse_training_pipeline_path(path: str) -> typing.Dict[str, str]
Parses a training_pipeline path into its component segments.
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.pipeline_job_path
pipeline_job_path(project: str, location: str, pipeline_job: str) -> str
Returns a fully-qualified pipeline_job string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.pipeline_job_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.training_pipeline_path
training_pipeline_path(project: str, location: str, training_pipeline: str) -> str
Returns a fully-qualified training_pipeline string.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.training_pipeline_path
google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.pipeline_service.PipelineServiceClient.wait_operation
google.cloud.aiplatform_v1.services.pipeline_service.pagers.ListPipelineJobsAsyncPager
ListPipelineJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.pipeline_service.ListPipelineJobsResponse
],
],
request: google.cloud.aiplatform_v1.types.pipeline_service.ListPipelineJobsRequest,
response: google.cloud.aiplatform_v1.types.pipeline_service.ListPipelineJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.pipeline_service.pagers.ListPipelineJobsAsyncPager
google.cloud.aiplatform_v1.services.pipeline_service.pagers.ListPipelineJobsPager
ListPipelineJobsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.pipeline_service.ListPipelineJobsResponse,
],
request: google.cloud.aiplatform_v1.types.pipeline_service.ListPipelineJobsRequest,
response: google.cloud.aiplatform_v1.types.pipeline_service.ListPipelineJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.pipeline_service.pagers.ListPipelineJobsPager
google.cloud.aiplatform_v1.services.pipeline_service.pagers.ListTrainingPipelinesAsyncPager
ListTrainingPipelinesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.pipeline_service.ListTrainingPipelinesResponse
],
],
request: google.cloud.aiplatform_v1.types.pipeline_service.ListTrainingPipelinesRequest,
response: google.cloud.aiplatform_v1.types.pipeline_service.ListTrainingPipelinesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.pipeline_service.pagers.ListTrainingPipelinesAsyncPager
google.cloud.aiplatform_v1.services.pipeline_service.pagers.ListTrainingPipelinesPager
ListTrainingPipelinesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.pipeline_service.ListTrainingPipelinesResponse,
],
request: google.cloud.aiplatform_v1.types.pipeline_service.ListTrainingPipelinesRequest,
response: google.cloud.aiplatform_v1.types.pipeline_service.ListTrainingPipelinesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.pipeline_service.pagers.ListTrainingPipelinesPager
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient
PredictionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.prediction_service.transports.base.PredictionServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the prediction service async client.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.direct_predict
direct_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.DirectPredictRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.prediction_service.DirectPredictResponse
Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.direct_predict
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.direct_raw_predict
direct_raw_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.DirectRawPredictRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.prediction_service.DirectRawPredictResponse
Perform an unary online prediction request to a gRPC model server for custom containers.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.endpoint_path
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.explain
explain(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.ExplainRequest, dict
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
parameters: typing.Optional[google.protobuf.struct_pb2.Value] = None,
deployed_model_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.prediction_service.ExplainResponse
Perform an online explanation.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.explain
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.generate_content
generate_content(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.GenerateContentRequest,
dict,
]
] = None,
*,
model: typing.Optional[str] = None,
contents: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1.types.content.Content]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.prediction_service.GenerateContentResponse
Generate content with multimodal inputs.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.generate_content
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.prediction_service.transports.base.PredictionServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.model_path
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.parse_model_path
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.predict
predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.PredictRequest, dict
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
parameters: typing.Optional[google.protobuf.struct_pb2.Value] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.prediction_service.PredictResponse
Perform an online prediction.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.predict
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.raw_predict
raw_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.RawPredictRequest, dict
]
] = None,
*,
endpoint: typing.Optional[str] = None,
http_body: typing.Optional[google.api.httpbody_pb2.HttpBody] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api.httpbody_pb2.HttpBody
Perform an online prediction with an arbitrary HTTP payload.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.raw_predict
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.server_streaming_predict
server_streaming_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.StreamingPredictRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1.types.prediction_service.StreamingPredictResponse
]
]
Perform a server-side streaming online prediction request for Vertex LLM streaming.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.stream_direct_predict
stream_direct_predict(
requests: typing.Optional[
typing.AsyncIterator[
google.cloud.aiplatform_v1.types.prediction_service.StreamDirectPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1.types.prediction_service.StreamDirectPredictResponse
]
]
Perform a streaming online prediction request to a gRPC model server for Vertex first-party products and frameworks.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.stream_direct_raw_predict
stream_direct_raw_predict(
requests: typing.Optional[
typing.AsyncIterator[
google.cloud.aiplatform_v1.types.prediction_service.StreamDirectRawPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1.types.prediction_service.StreamDirectRawPredictResponse
]
]
Perform a streaming online prediction request to a gRPC model server for custom containers.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.stream_generate_content
stream_generate_content(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.GenerateContentRequest,
dict,
]
] = None,
*,
model: typing.Optional[str] = None,
contents: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1.types.content.Content]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1.types.prediction_service.GenerateContentResponse
]
]
Generate content with multimodal inputs with streaming support.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.stream_raw_predict
stream_raw_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.StreamRawPredictRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
http_body: typing.Optional[google.api.httpbody_pb2.HttpBody] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[typing.AsyncIterable[google.api.httpbody_pb2.HttpBody]]
Perform a streaming online prediction with an arbitrary HTTP payload.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.streaming_predict
streaming_predict(
requests: typing.Optional[
typing.AsyncIterator[
google.cloud.aiplatform_v1.types.prediction_service.StreamingPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1.types.prediction_service.StreamingPredictResponse
]
]
Perform a streaming online prediction request for Vertex first-party products and frameworks.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.streaming_raw_predict
streaming_raw_predict(
requests: typing.Optional[
typing.AsyncIterator[
google.cloud.aiplatform_v1.types.prediction_service.StreamingRawPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1.types.prediction_service.StreamingRawPredictResponse
]
]
Perform a streaming online prediction request through gRPC.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient
PredictionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.prediction_service.transports.base.PredictionServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the prediction service client.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.exit
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.common_location_path
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.common_project_path
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.delete_operation
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.direct_predict
direct_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.DirectPredictRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.prediction_service.DirectPredictResponse
Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.direct_predict
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.direct_raw_predict
direct_raw_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.DirectRawPredictRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.prediction_service.DirectRawPredictResponse
Perform an unary online prediction request to a gRPC model server for custom containers.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.direct_raw_predict
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.endpoint_path
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.explain
explain(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.ExplainRequest, dict
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
parameters: typing.Optional[google.protobuf.struct_pb2.Value] = None,
deployed_model_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.prediction_service.ExplainResponse
Perform an online explanation.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.explain
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.generate_content
generate_content(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.GenerateContentRequest,
dict,
]
] = None,
*,
model: typing.Optional[str] = None,
contents: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1.types.content.Content]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.prediction_service.GenerateContentResponse
Generate content with multimodal inputs.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.generate_content
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.get_location
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.get_operation
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.list_locations
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.list_operations
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.model_path
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.parse_endpoint_path
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.parse_model_path
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.predict
predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.PredictRequest, dict
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
parameters: typing.Optional[google.protobuf.struct_pb2.Value] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.prediction_service.PredictResponse
Perform an online prediction.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.predict
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.raw_predict
raw_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.RawPredictRequest, dict
]
] = None,
*,
endpoint: typing.Optional[str] = None,
http_body: typing.Optional[google.api.httpbody_pb2.HttpBody] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api.httpbody_pb2.HttpBody
Perform an online prediction with an arbitrary HTTP payload.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.raw_predict
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.server_streaming_predict
server_streaming_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.StreamingPredictRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1.types.prediction_service.StreamingPredictResponse
]
Perform a server-side streaming online prediction request for Vertex LLM streaming.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.stream_direct_predict
stream_direct_predict(
requests: typing.Optional[
typing.Iterator[
google.cloud.aiplatform_v1.types.prediction_service.StreamDirectPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1.types.prediction_service.StreamDirectPredictResponse
]
Perform a streaming online prediction request to a gRPC model server for Vertex first-party products and frameworks.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.stream_direct_predict
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.stream_direct_raw_predict
stream_direct_raw_predict(
requests: typing.Optional[
typing.Iterator[
google.cloud.aiplatform_v1.types.prediction_service.StreamDirectRawPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1.types.prediction_service.StreamDirectRawPredictResponse
]
Perform a streaming online prediction request to a gRPC model server for custom containers.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.stream_generate_content
stream_generate_content(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.GenerateContentRequest,
dict,
]
] = None,
*,
model: typing.Optional[str] = None,
contents: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1.types.content.Content]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1.types.prediction_service.GenerateContentResponse
]
Generate content with multimodal inputs with streaming support.
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.stream_raw_predict
stream_raw_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.prediction_service.StreamRawPredictRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
http_body: typing.Optional[google.api.httpbody_pb2.HttpBody] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[google.api.httpbody_pb2.HttpBody]
Perform a streaming online prediction with an arbitrary HTTP payload.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.stream_raw_predict
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.streaming_predict
streaming_predict(
requests: typing.Optional[
typing.Iterator[
google.cloud.aiplatform_v1.types.prediction_service.StreamingPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1.types.prediction_service.StreamingPredictResponse
]
Perform a streaming online prediction request for Vertex first-party products and frameworks.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.streaming_predict
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.streaming_raw_predict
streaming_raw_predict(
requests: typing.Optional[
typing.Iterator[
google.cloud.aiplatform_v1.types.prediction_service.StreamingRawPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1.types.prediction_service.StreamingRawPredictResponse
]
Perform a streaming online prediction request through gRPC.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.streaming_raw_predict
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.prediction_service.PredictionServiceClient.wait_operation
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient
ScheduleServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.schedule_service.transports.base.ScheduleServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the schedule service async client.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.artifact_path
artifact_path(
project: str, location: str, metadata_store: str, artifact: str
) -> str
Returns a fully-qualified artifact string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.artifact_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.context_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.create_schedule
create_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.CreateScheduleRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
schedule: typing.Optional[
google.cloud.aiplatform_v1.types.schedule.Schedule
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.schedule.Schedule
Creates a Schedule.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.create_schedule
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.custom_job_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.delete_schedule
delete_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.DeleteScheduleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a Schedule.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.delete_schedule
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.execution_path
execution_path(
project: str, location: str, metadata_store: str, execution: str
) -> str
Returns a fully-qualified execution string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.execution_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.get_schedule
get_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.GetScheduleRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.schedule.Schedule
Gets a Schedule.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.get_schedule
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.schedule_service.transports.base.ScheduleServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.list_schedules
list_schedules(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.ListSchedulesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.schedule_service.pagers.ListSchedulesAsyncPager
)
Lists Schedules in a Location.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.list_schedules
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.network_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_artifact_path
parse_artifact_path(path: str) -> typing.Dict[str, str]
Parses a artifact path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_artifact_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_context_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_execution_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_network_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_pipeline_job_path
parse_pipeline_job_path(path: str) -> typing.Dict[str, str]
Parses a pipeline_job path into its component segments.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_schedule_path
parse_schedule_path(path: str) -> typing.Dict[str, str]
Parses a schedule path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.parse_schedule_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.pause_schedule
pause_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.PauseScheduleRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Pauses a Schedule.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.pause_schedule
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.pipeline_job_path
pipeline_job_path(project: str, location: str, pipeline_job: str) -> str
Returns a fully-qualified pipeline_job string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.pipeline_job_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.resume_schedule
resume_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.ResumeScheduleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
catch_up: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Resumes a paused Schedule to start scheduling new runs.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.resume_schedule
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.schedule_path
schedule_path(project: str, location: str, schedule: str) -> str
Returns a fully-qualified schedule string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.schedule_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.update_schedule
update_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.UpdateScheduleRequest,
dict,
]
] = None,
*,
schedule: typing.Optional[
google.cloud.aiplatform_v1.types.schedule.Schedule
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.schedule.Schedule
Updates an active or paused Schedule.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.update_schedule
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient
ScheduleServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.schedule_service.transports.base.ScheduleServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the schedule service client.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.exit
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.artifact_path
artifact_path(
project: str, location: str, metadata_store: str, artifact: str
) -> str
Returns a fully-qualified artifact string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.artifact_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.common_location_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.common_organization_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.common_project_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.context_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.create_schedule
create_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.CreateScheduleRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
schedule: typing.Optional[
google.cloud.aiplatform_v1.types.schedule.Schedule
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.schedule.Schedule
Creates a Schedule.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.create_schedule
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.custom_job_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.delete_operation
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.delete_schedule
delete_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.DeleteScheduleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a Schedule.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.delete_schedule
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.execution_path
execution_path(
project: str, location: str, metadata_store: str, execution: str
) -> str
Returns a fully-qualified execution string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.execution_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.from_service_account_file
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.from_service_account_info
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.from_service_account_json
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.get_location
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.get_operation
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.get_schedule
get_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.GetScheduleRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.schedule.Schedule
Gets a Schedule.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.get_schedule
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.list_locations
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.list_operations
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.list_schedules
list_schedules(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.ListSchedulesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.schedule_service.pagers.ListSchedulesPager
Lists Schedules in a Location.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.list_schedules
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.network_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_artifact_path
parse_artifact_path(path: str) -> typing.Dict[str, str]
Parses a artifact path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_artifact_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_common_project_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_context_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_custom_job_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_execution_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_network_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_pipeline_job_path
parse_pipeline_job_path(path: str) -> typing.Dict[str, str]
Parses a pipeline_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_pipeline_job_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_schedule_path
parse_schedule_path(path: str) -> typing.Dict[str, str]
Parses a schedule path into its component segments.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.parse_schedule_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.pause_schedule
pause_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.PauseScheduleRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Pauses a Schedule.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.pause_schedule
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.pipeline_job_path
pipeline_job_path(project: str, location: str, pipeline_job: str) -> str
Returns a fully-qualified pipeline_job string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.pipeline_job_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.resume_schedule
resume_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.ResumeScheduleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
catch_up: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Resumes a paused Schedule to start scheduling new runs.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.resume_schedule
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.schedule_path
schedule_path(project: str, location: str, schedule: str) -> str
Returns a fully-qualified schedule string.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.schedule_path
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.update_schedule
update_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.schedule_service.UpdateScheduleRequest,
dict,
]
] = None,
*,
schedule: typing.Optional[
google.cloud.aiplatform_v1.types.schedule.Schedule
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.schedule.Schedule
Updates an active or paused Schedule.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.update_schedule
google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.schedule_service.ScheduleServiceClient.wait_operation
google.cloud.aiplatform_v1.services.schedule_service.pagers.ListSchedulesAsyncPager
ListSchedulesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.schedule_service.ListSchedulesResponse
],
],
request: google.cloud.aiplatform_v1.types.schedule_service.ListSchedulesRequest,
response: google.cloud.aiplatform_v1.types.schedule_service.ListSchedulesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.schedule_service.pagers.ListSchedulesAsyncPager
google.cloud.aiplatform_v1.services.schedule_service.pagers.ListSchedulesPager
ListSchedulesPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.schedule_service.ListSchedulesResponse
],
request: google.cloud.aiplatform_v1.types.schedule_service.ListSchedulesRequest,
response: google.cloud.aiplatform_v1.types.schedule_service.ListSchedulesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.schedule_service.pagers.ListSchedulesPager
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient
SpecialistPoolServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.specialist_pool_service.transports.base.SpecialistPoolServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the specialist pool service async client.
See more: google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.create_specialist_pool
create_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.specialist_pool_service.CreateSpecialistPoolRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
specialist_pool: typing.Optional[
google.cloud.aiplatform_v1.types.specialist_pool.SpecialistPool
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a SpecialistPool.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.delete_specialist_pool
delete_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.specialist_pool_service.DeleteSpecialistPoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a SpecialistPool as well as all Specialists in the pool.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.get_specialist_pool
get_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.specialist_pool_service.GetSpecialistPoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.specialist_pool.SpecialistPool
Gets a SpecialistPool.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.specialist_pool_service.transports.base.SpecialistPoolServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.list_specialist_pools
list_specialist_pools(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.specialist_pool_service.ListSpecialistPoolsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.specialist_pool_service.pagers.ListSpecialistPoolsAsyncPager
)
Lists SpecialistPools in a Location.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.parse_specialist_pool_path
parse_specialist_pool_path(path: str) -> typing.Dict[str, str]
Parses a specialist_pool path into its component segments.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.specialist_pool_path
specialist_pool_path(project: str, location: str, specialist_pool: str) -> str
Returns a fully-qualified specialist_pool string.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.update_specialist_pool
update_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.specialist_pool_service.UpdateSpecialistPoolRequest,
dict,
]
] = None,
*,
specialist_pool: typing.Optional[
google.cloud.aiplatform_v1.types.specialist_pool.SpecialistPool
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a SpecialistPool.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient
SpecialistPoolServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.specialist_pool_service.transports.base.SpecialistPoolServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the specialist pool service client.
See more: google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.exit
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.create_specialist_pool
create_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.specialist_pool_service.CreateSpecialistPoolRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
specialist_pool: typing.Optional[
google.cloud.aiplatform_v1.types.specialist_pool.SpecialistPool
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a SpecialistPool.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.delete_specialist_pool
delete_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.specialist_pool_service.DeleteSpecialistPoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a SpecialistPool as well as all Specialists in the pool.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.get_location
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.get_specialist_pool
get_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.specialist_pool_service.GetSpecialistPoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.specialist_pool.SpecialistPool
Gets a SpecialistPool.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.list_specialist_pools
list_specialist_pools(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.specialist_pool_service.ListSpecialistPoolsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.specialist_pool_service.pagers.ListSpecialistPoolsPager
)
Lists SpecialistPools in a Location.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.parse_specialist_pool_path
parse_specialist_pool_path(path: str) -> typing.Dict[str, str]
Parses a specialist_pool path into its component segments.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.specialist_pool_path
specialist_pool_path(project: str, location: str, specialist_pool: str) -> str
Returns a fully-qualified specialist_pool string.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.update_specialist_pool
update_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.specialist_pool_service.UpdateSpecialistPoolRequest,
dict,
]
] = None,
*,
specialist_pool: typing.Optional[
google.cloud.aiplatform_v1.types.specialist_pool.SpecialistPool
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates a SpecialistPool.
google.cloud.aiplatform_v1.services.specialist_pool_service.SpecialistPoolServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1.services.specialist_pool_service.pagers.ListSpecialistPoolsAsyncPager
ListSpecialistPoolsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.specialist_pool_service.ListSpecialistPoolsResponse
],
],
request: google.cloud.aiplatform_v1.types.specialist_pool_service.ListSpecialistPoolsRequest,
response: google.cloud.aiplatform_v1.types.specialist_pool_service.ListSpecialistPoolsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.specialist_pool_service.pagers.ListSpecialistPoolsAsyncPager
google.cloud.aiplatform_v1.services.specialist_pool_service.pagers.ListSpecialistPoolsPager
ListSpecialistPoolsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.specialist_pool_service.ListSpecialistPoolsResponse,
],
request: google.cloud.aiplatform_v1.types.specialist_pool_service.ListSpecialistPoolsRequest,
response: google.cloud.aiplatform_v1.types.specialist_pool_service.ListSpecialistPoolsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.specialist_pool_service.pagers.ListSpecialistPoolsPager
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient
TensorboardServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.tensorboard_service.transports.base.TensorboardServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the tensorboard service async client.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.batch_create_tensorboard_runs
batch_create_tensorboard_runs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.BatchCreateTensorboardRunsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.tensorboard_service.CreateTensorboardRunRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.tensorboard_service.BatchCreateTensorboardRunsResponse
)
Batch create TensorboardRuns.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.batch_create_tensorboard_time_series
batch_create_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.BatchCreateTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.tensorboard_service.CreateTensorboardTimeSeriesRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.tensorboard_service.BatchCreateTensorboardTimeSeriesResponse
)
Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.batch_read_tensorboard_time_series_data
batch_read_tensorboard_time_series_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.BatchReadTensorboardTimeSeriesDataRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.tensorboard_service.BatchReadTensorboardTimeSeriesDataResponse
)
Reads multiple TensorboardTimeSeries' data.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.create_tensorboard
create_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.CreateTensorboardRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard.Tensorboard
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a Tensorboard.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.create_tensorboard_experiment
create_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.CreateTensorboardExperimentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard_experiment: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard_experiment.TensorboardExperiment
] = None,
tensorboard_experiment_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_experiment.TensorboardExperiment
Creates a TensorboardExperiment.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.create_tensorboard_run
create_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.CreateTensorboardRunRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard_run: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard_run.TensorboardRun
] = None,
tensorboard_run_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_run.TensorboardRun
Creates a TensorboardRun.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.create_tensorboard_time_series
create_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.CreateTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard_time_series: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard_time_series.TensorboardTimeSeries
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_time_series.TensorboardTimeSeries
Creates a TensorboardTimeSeries.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.delete_tensorboard
delete_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.DeleteTensorboardRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a Tensorboard.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.delete_tensorboard_experiment
delete_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.DeleteTensorboardExperimentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a TensorboardExperiment.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.delete_tensorboard_run
delete_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.DeleteTensorboardRunRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a TensorboardRun.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.delete_tensorboard_time_series
delete_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.DeleteTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a TensorboardTimeSeries.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.export_tensorboard_time_series_data
export_tensorboard_time_series_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ExportTensorboardTimeSeriesDataRequest,
dict,
]
] = None,
*,
tensorboard_time_series: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ExportTensorboardTimeSeriesDataAsyncPager
)
Exports a TensorboardTimeSeries' data.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.get_tensorboard
get_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.GetTensorboardRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard.Tensorboard
Gets a Tensorboard.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.get_tensorboard_experiment
get_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.GetTensorboardExperimentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_experiment.TensorboardExperiment
Gets a TensorboardExperiment.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.get_tensorboard_run
get_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.GetTensorboardRunRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_run.TensorboardRun
Gets a TensorboardRun.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.get_tensorboard_time_series
get_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.GetTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_time_series.TensorboardTimeSeries
Gets a TensorboardTimeSeries.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.tensorboard_service.transports.base.TensorboardServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.list_tensorboard_experiments
list_tensorboard_experiments(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardExperimentsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardExperimentsAsyncPager
)
Lists TensorboardExperiments in a Location.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.list_tensorboard_runs
list_tensorboard_runs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardRunsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardRunsAsyncPager
)
Lists TensorboardRuns in a Location.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.list_tensorboard_time_series
list_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardTimeSeriesAsyncPager
)
Lists TensorboardTimeSeries in a Location.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.list_tensorboards
list_tensorboards(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardsAsyncPager
)
Lists Tensorboards in a Location.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_tensorboard_experiment_path
parse_tensorboard_experiment_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard_experiment path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_tensorboard_path
parse_tensorboard_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_tensorboard_run_path
parse_tensorboard_run_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard_run path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_tensorboard_time_series_path
parse_tensorboard_time_series_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard_time_series path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.read_tensorboard_blob_data
read_tensorboard_blob_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardBlobDataRequest,
dict,
]
] = None,
*,
time_series: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardBlobDataResponse
]
]
Gets bytes of TensorboardBlobs.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.read_tensorboard_size
read_tensorboard_size(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardSizeRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardSizeResponse
Returns the storage size for a given TensorBoard instance.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.read_tensorboard_time_series_data
read_tensorboard_time_series_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardTimeSeriesDataRequest,
dict,
]
] = None,
*,
tensorboard_time_series: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardTimeSeriesDataResponse
)
Reads a TensorboardTimeSeries' data.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.read_tensorboard_usage
read_tensorboard_usage(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardUsageRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardUsageResponse
Returns a list of monthly active users for a given TensorBoard instance.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.tensorboard_experiment_path
tensorboard_experiment_path(
project: str, location: str, tensorboard: str, experiment: str
) -> str
Returns a fully-qualified tensorboard_experiment string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.tensorboard_path
tensorboard_path(project: str, location: str, tensorboard: str) -> str
Returns a fully-qualified tensorboard string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.tensorboard_run_path
tensorboard_run_path(
project: str, location: str, tensorboard: str, experiment: str, run: str
) -> str
Returns a fully-qualified tensorboard_run string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.tensorboard_time_series_path
tensorboard_time_series_path(
project: str,
location: str,
tensorboard: str,
experiment: str,
run: str,
time_series: str,
) -> str
Returns a fully-qualified tensorboard_time_series string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.update_tensorboard
update_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.UpdateTensorboardRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard.Tensorboard
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a Tensorboard.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.update_tensorboard_experiment
update_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.UpdateTensorboardExperimentRequest,
dict,
]
] = None,
*,
tensorboard_experiment: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard_experiment.TensorboardExperiment
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_experiment.TensorboardExperiment
Updates a TensorboardExperiment.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.update_tensorboard_run
update_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.UpdateTensorboardRunRequest,
dict,
]
] = None,
*,
tensorboard_run: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard_run.TensorboardRun
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_run.TensorboardRun
Updates a TensorboardRun.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.update_tensorboard_time_series
update_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.UpdateTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
tensorboard_time_series: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard_time_series.TensorboardTimeSeries
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_time_series.TensorboardTimeSeries
Updates a TensorboardTimeSeries.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.write_tensorboard_experiment_data
write_tensorboard_experiment_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.WriteTensorboardExperimentDataRequest,
dict,
]
] = None,
*,
tensorboard_experiment: typing.Optional[str] = None,
write_run_data_requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.tensorboard_service.WriteTensorboardRunDataRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.tensorboard_service.WriteTensorboardExperimentDataResponse
)
Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceAsyncClient.write_tensorboard_run_data
write_tensorboard_run_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.WriteTensorboardRunDataRequest,
dict,
]
] = None,
*,
tensorboard_run: typing.Optional[str] = None,
time_series_data: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.tensorboard_data.TimeSeriesData
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.tensorboard_service.WriteTensorboardRunDataResponse
)
Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient
TensorboardServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.tensorboard_service.transports.base.TensorboardServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the tensorboard service client.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.exit
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.batch_create_tensorboard_runs
batch_create_tensorboard_runs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.BatchCreateTensorboardRunsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.tensorboard_service.CreateTensorboardRunRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.tensorboard_service.BatchCreateTensorboardRunsResponse
)
Batch create TensorboardRuns.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.batch_create_tensorboard_time_series
batch_create_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.BatchCreateTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.tensorboard_service.CreateTensorboardTimeSeriesRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.tensorboard_service.BatchCreateTensorboardTimeSeriesResponse
)
Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.batch_read_tensorboard_time_series_data
batch_read_tensorboard_time_series_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.BatchReadTensorboardTimeSeriesDataRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.tensorboard_service.BatchReadTensorboardTimeSeriesDataResponse
)
Reads multiple TensorboardTimeSeries' data.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.common_project_path
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.create_tensorboard
create_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.CreateTensorboardRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard.Tensorboard
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a Tensorboard.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.create_tensorboard
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.create_tensorboard_experiment
create_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.CreateTensorboardExperimentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard_experiment: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard_experiment.TensorboardExperiment
] = None,
tensorboard_experiment_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_experiment.TensorboardExperiment
Creates a TensorboardExperiment.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.create_tensorboard_run
create_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.CreateTensorboardRunRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard_run: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard_run.TensorboardRun
] = None,
tensorboard_run_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_run.TensorboardRun
Creates a TensorboardRun.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.create_tensorboard_time_series
create_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.CreateTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard_time_series: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard_time_series.TensorboardTimeSeries
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_time_series.TensorboardTimeSeries
Creates a TensorboardTimeSeries.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.delete_operation
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.delete_tensorboard
delete_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.DeleteTensorboardRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a Tensorboard.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.delete_tensorboard
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.delete_tensorboard_experiment
delete_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.DeleteTensorboardExperimentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a TensorboardExperiment.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.delete_tensorboard_run
delete_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.DeleteTensorboardRunRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a TensorboardRun.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.delete_tensorboard_time_series
delete_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.DeleteTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a TensorboardTimeSeries.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.export_tensorboard_time_series_data
export_tensorboard_time_series_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ExportTensorboardTimeSeriesDataRequest,
dict,
]
] = None,
*,
tensorboard_time_series: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ExportTensorboardTimeSeriesDataPager
)
Exports a TensorboardTimeSeries' data.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_location
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_operation
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_tensorboard
get_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.GetTensorboardRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard.Tensorboard
Gets a Tensorboard.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_tensorboard
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_tensorboard_experiment
get_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.GetTensorboardExperimentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_experiment.TensorboardExperiment
Gets a TensorboardExperiment.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_tensorboard_run
get_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.GetTensorboardRunRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_run.TensorboardRun
Gets a TensorboardRun.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_tensorboard_run
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.get_tensorboard_time_series
get_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.GetTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_time_series.TensorboardTimeSeries
Gets a TensorboardTimeSeries.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.list_locations
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.list_operations
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.list_tensorboard_experiments
list_tensorboard_experiments(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardExperimentsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardExperimentsPager
)
Lists TensorboardExperiments in a Location.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.list_tensorboard_runs
list_tensorboard_runs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardRunsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardRunsPager
)
Lists TensorboardRuns in a Location.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.list_tensorboard_time_series
list_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardTimeSeriesPager
)
Lists TensorboardTimeSeries in a Location.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.list_tensorboards
list_tensorboards(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardsPager
)
Lists Tensorboards in a Location.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.list_tensorboards
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.parse_tensorboard_experiment_path
parse_tensorboard_experiment_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard_experiment path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.parse_tensorboard_path
parse_tensorboard_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.parse_tensorboard_run_path
parse_tensorboard_run_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard_run path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.parse_tensorboard_time_series_path
parse_tensorboard_time_series_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard_time_series path into its component segments.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.read_tensorboard_blob_data
read_tensorboard_blob_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardBlobDataRequest,
dict,
]
] = None,
*,
time_series: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardBlobDataResponse
]
Gets bytes of TensorboardBlobs.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.read_tensorboard_size
read_tensorboard_size(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardSizeRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardSizeResponse
Returns the storage size for a given TensorBoard instance.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.read_tensorboard_time_series_data
read_tensorboard_time_series_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardTimeSeriesDataRequest,
dict,
]
] = None,
*,
tensorboard_time_series: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardTimeSeriesDataResponse
)
Reads a TensorboardTimeSeries' data.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.read_tensorboard_usage
read_tensorboard_usage(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardUsageRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_service.ReadTensorboardUsageResponse
Returns a list of monthly active users for a given TensorBoard instance.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.tensorboard_experiment_path
tensorboard_experiment_path(
project: str, location: str, tensorboard: str, experiment: str
) -> str
Returns a fully-qualified tensorboard_experiment string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.tensorboard_path
tensorboard_path(project: str, location: str, tensorboard: str) -> str
Returns a fully-qualified tensorboard string.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.tensorboard_path
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.tensorboard_run_path
tensorboard_run_path(
project: str, location: str, tensorboard: str, experiment: str, run: str
) -> str
Returns a fully-qualified tensorboard_run string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.tensorboard_time_series_path
tensorboard_time_series_path(
project: str,
location: str,
tensorboard: str,
experiment: str,
run: str,
time_series: str,
) -> str
Returns a fully-qualified tensorboard_time_series string.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.update_tensorboard
update_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.UpdateTensorboardRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard.Tensorboard
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates a Tensorboard.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.update_tensorboard
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.update_tensorboard_experiment
update_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.UpdateTensorboardExperimentRequest,
dict,
]
] = None,
*,
tensorboard_experiment: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard_experiment.TensorboardExperiment
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_experiment.TensorboardExperiment
Updates a TensorboardExperiment.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.update_tensorboard_run
update_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.UpdateTensorboardRunRequest,
dict,
]
] = None,
*,
tensorboard_run: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard_run.TensorboardRun
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_run.TensorboardRun
Updates a TensorboardRun.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.update_tensorboard_time_series
update_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.UpdateTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
tensorboard_time_series: typing.Optional[
google.cloud.aiplatform_v1.types.tensorboard_time_series.TensorboardTimeSeries
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.tensorboard_time_series.TensorboardTimeSeries
Updates a TensorboardTimeSeries.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.wait_operation
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.write_tensorboard_experiment_data
write_tensorboard_experiment_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.WriteTensorboardExperimentDataRequest,
dict,
]
] = None,
*,
tensorboard_experiment: typing.Optional[str] = None,
write_run_data_requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.tensorboard_service.WriteTensorboardRunDataRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.tensorboard_service.WriteTensorboardExperimentDataResponse
)
Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's.
google.cloud.aiplatform_v1.services.tensorboard_service.TensorboardServiceClient.write_tensorboard_run_data
write_tensorboard_run_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.tensorboard_service.WriteTensorboardRunDataRequest,
dict,
]
] = None,
*,
tensorboard_run: typing.Optional[str] = None,
time_series_data: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1.types.tensorboard_data.TimeSeriesData
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1.types.tensorboard_service.WriteTensorboardRunDataResponse
)
Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun.
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ExportTensorboardTimeSeriesDataAsyncPager
ExportTensorboardTimeSeriesDataAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.tensorboard_service.ExportTensorboardTimeSeriesDataResponse
],
],
request: google.cloud.aiplatform_v1.types.tensorboard_service.ExportTensorboardTimeSeriesDataRequest,
response: google.cloud.aiplatform_v1.types.tensorboard_service.ExportTensorboardTimeSeriesDataResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ExportTensorboardTimeSeriesDataPager
ExportTensorboardTimeSeriesDataPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.tensorboard_service.ExportTensorboardTimeSeriesDataResponse,
],
request: google.cloud.aiplatform_v1.types.tensorboard_service.ExportTensorboardTimeSeriesDataRequest,
response: google.cloud.aiplatform_v1.types.tensorboard_service.ExportTensorboardTimeSeriesDataResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ExportTensorboardTimeSeriesDataPager
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardExperimentsAsyncPager
ListTensorboardExperimentsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardExperimentsResponse
],
],
request: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardExperimentsRequest,
response: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardExperimentsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardExperimentsAsyncPager
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardExperimentsPager
ListTensorboardExperimentsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardExperimentsResponse,
],
request: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardExperimentsRequest,
response: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardExperimentsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardExperimentsPager
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardRunsAsyncPager
ListTensorboardRunsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardRunsResponse
],
],
request: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardRunsRequest,
response: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardRunsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardRunsAsyncPager
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardRunsPager
ListTensorboardRunsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardRunsResponse,
],
request: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardRunsRequest,
response: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardRunsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardRunsPager
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardTimeSeriesAsyncPager
ListTensorboardTimeSeriesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardTimeSeriesResponse
],
],
request: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardTimeSeriesRequest,
response: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardTimeSeriesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardTimeSeriesAsyncPager
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardTimeSeriesPager
ListTensorboardTimeSeriesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardTimeSeriesResponse,
],
request: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardTimeSeriesRequest,
response: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardTimeSeriesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardTimeSeriesPager
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardsAsyncPager
ListTensorboardsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardsResponse
],
],
request: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardsRequest,
response: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardsAsyncPager
google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardsPager
ListTensorboardsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardsResponse,
],
request: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardsRequest,
response: google.cloud.aiplatform_v1.types.tensorboard_service.ListTensorboardsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.tensorboard_service.pagers.ListTensorboardsPager
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient
VizierServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1.services.vizier_service.transports.base.VizierServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the vizier service async client.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.add_trial_measurement
add_trial_measurement(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.AddTrialMeasurementRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Trial
Adds a measurement of the objective metrics to a Trial.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.add_trial_measurement
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.check_trial_early_stopping_state
check_trial_early_stopping_state(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.CheckTrialEarlyStoppingStateRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Checks whether a Trial should stop or not.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.common_organization_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.complete_trial
complete_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.CompleteTrialRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Trial
Marks a Trial as complete.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.complete_trial
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.create_study
create_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.CreateStudyRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
study: typing.Optional[google.cloud.aiplatform_v1.types.study.Study] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Study
Creates a Study.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.create_study
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.create_trial
create_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.CreateTrialRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
trial: typing.Optional[google.cloud.aiplatform_v1.types.study.Trial] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Trial
Adds a user provided Trial to a Study.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.create_trial
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.custom_job_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.delete_study
delete_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.DeleteStudyRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a Study.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.delete_study
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.delete_trial
delete_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.DeleteTrialRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a Trial.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.delete_trial
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_location
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_operation
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_study
get_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.GetStudyRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Study
Gets a Study by name.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_study
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1.services.vizier_service.transports.base.VizierServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_trial
get_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.GetTrialRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Trial
Gets a Trial.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.get_trial
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.list_locations
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.list_operations
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.list_optimal_trials
list_optimal_trials(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.ListOptimalTrialsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.vizier_service.ListOptimalTrialsResponse
Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.list_optimal_trials
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.list_studies
list_studies(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.ListStudiesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.vizier_service.pagers.ListStudiesAsyncPager
Lists all the studies in a region for an associated project.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.list_studies
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.list_trials
list_trials(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.ListTrialsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.vizier_service.pagers.ListTrialsAsyncPager
Lists the Trials associated with a Study.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.list_trials
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.lookup_study
lookup_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.LookupStudyRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Study
Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.lookup_study
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.parse_custom_job_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.parse_study_path
parse_study_path(path: str) -> typing.Dict[str, str]
Parses a study path into its component segments.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.parse_study_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.parse_trial_path
parse_trial_path(path: str) -> typing.Dict[str, str]
Parses a trial path into its component segments.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.parse_trial_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.stop_trial
stop_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.StopTrialRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Trial
Stops a Trial.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.stop_trial
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.study_path
study_path(project: str, location: str, study: str) -> str
Returns a fully-qualified study string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.study_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.suggest_trials
suggest_trials(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.SuggestTrialsRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.suggest_trials
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.trial_path
trial_path(project: str, location: str, study: str, trial: str) -> str
Returns a fully-qualified trial string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.trial_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient
VizierServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1.services.vizier_service.transports.base.VizierServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the vizier service client.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.exit
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.add_trial_measurement
add_trial_measurement(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.AddTrialMeasurementRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Trial
Adds a measurement of the objective metrics to a Trial.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.add_trial_measurement
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.cancel_operation
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.check_trial_early_stopping_state
check_trial_early_stopping_state(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.CheckTrialEarlyStoppingStateRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Checks whether a Trial should stop or not.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.common_billing_account_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.common_folder_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.common_location_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.common_organization_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.common_project_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.complete_trial
complete_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.CompleteTrialRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Trial
Marks a Trial as complete.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.complete_trial
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.create_study
create_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.CreateStudyRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
study: typing.Optional[google.cloud.aiplatform_v1.types.study.Study] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Study
Creates a Study.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.create_study
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.create_trial
create_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.CreateTrialRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
trial: typing.Optional[google.cloud.aiplatform_v1.types.study.Trial] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Trial
Adds a user provided Trial to a Study.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.create_trial
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.custom_job_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.delete_operation
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.delete_study
delete_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.DeleteStudyRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a Study.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.delete_study
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.delete_trial
delete_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.DeleteTrialRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a Trial.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.delete_trial
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.from_service_account_file
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.from_service_account_info
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.from_service_account_json
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.get_iam_policy
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.get_location
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.get_operation
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.get_study
get_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.GetStudyRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Study
Gets a Study by name.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.get_study
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.get_trial
get_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.GetTrialRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Trial
Gets a Trial.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.get_trial
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.list_locations
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.list_operations
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.list_optimal_trials
list_optimal_trials(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.ListOptimalTrialsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.vizier_service.ListOptimalTrialsResponse
Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.list_optimal_trials
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.list_studies
list_studies(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.ListStudiesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.vizier_service.pagers.ListStudiesPager
Lists all the studies in a region for an associated project.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.list_studies
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.list_trials
list_trials(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.ListTrialsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.services.vizier_service.pagers.ListTrialsPager
Lists the Trials associated with a Study.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.list_trials
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.lookup_study
lookup_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.LookupStudyRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Study
Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.lookup_study
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_common_location_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_common_project_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_custom_job_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_study_path
parse_study_path(path: str) -> typing.Dict[str, str]
Parses a study path into its component segments.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_study_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_trial_path
parse_trial_path(path: str) -> typing.Dict[str, str]
Parses a trial path into its component segments.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.parse_trial_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.set_iam_policy
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.stop_trial
stop_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.StopTrialRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1.types.study.Trial
Stops a Trial.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.stop_trial
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.study_path
study_path(project: str, location: str, study: str) -> str
Returns a fully-qualified study string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.study_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.suggest_trials
suggest_trials(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1.types.vizier_service.SuggestTrialsRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.suggest_trials
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.test_iam_permissions
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.trial_path
trial_path(project: str, location: str, study: str, trial: str) -> str
Returns a fully-qualified trial string.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.trial_path
google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1.services.vizier_service.VizierServiceClient.wait_operation
google.cloud.aiplatform_v1.services.vizier_service.pagers.ListStudiesAsyncPager
ListStudiesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.vizier_service.ListStudiesResponse
],
],
request: google.cloud.aiplatform_v1.types.vizier_service.ListStudiesRequest,
response: google.cloud.aiplatform_v1.types.vizier_service.ListStudiesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.vizier_service.pagers.ListStudiesAsyncPager
google.cloud.aiplatform_v1.services.vizier_service.pagers.ListStudiesPager
ListStudiesPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.vizier_service.ListStudiesResponse
],
request: google.cloud.aiplatform_v1.types.vizier_service.ListStudiesRequest,
response: google.cloud.aiplatform_v1.types.vizier_service.ListStudiesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.vizier_service.pagers.ListStudiesPager
google.cloud.aiplatform_v1.services.vizier_service.pagers.ListTrialsAsyncPager
ListTrialsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1.types.vizier_service.ListTrialsResponse
],
],
request: google.cloud.aiplatform_v1.types.vizier_service.ListTrialsRequest,
response: google.cloud.aiplatform_v1.types.vizier_service.ListTrialsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1.services.vizier_service.pagers.ListTrialsAsyncPager
google.cloud.aiplatform_v1.services.vizier_service.pagers.ListTrialsPager
ListTrialsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1.types.vizier_service.ListTrialsResponse
],
request: google.cloud.aiplatform_v1.types.vizier_service.ListTrialsRequest,
response: google.cloud.aiplatform_v1.types.vizier_service.ListTrialsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1.services.vizier_service.pagers.ListTrialsPager
google.cloud.aiplatform_v1.types.AcceleratorType
AcceleratorType(value)
Represents a hardware accelerator type.
google.cloud.aiplatform_v1.types.ActiveLearningConfig
ActiveLearningConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Parameters that configure the active learning pipeline.
See more: google.cloud.aiplatform_v1.types.ActiveLearningConfig
google.cloud.aiplatform_v1.types.AddContextArtifactsAndExecutionsRequest
AddContextArtifactsAndExecutionsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for MetadataService.AddContextArtifactsAndExecutions.
See more: google.cloud.aiplatform_v1.types.AddContextArtifactsAndExecutionsRequest
google.cloud.aiplatform_v1.types.AddContextArtifactsAndExecutionsResponse
AddContextArtifactsAndExecutionsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for MetadataService.AddContextArtifactsAndExecutions.
See more: google.cloud.aiplatform_v1.types.AddContextArtifactsAndExecutionsResponse
google.cloud.aiplatform_v1.types.AddContextChildrenRequest
AddContextChildrenRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.AddContextChildren.
See more: google.cloud.aiplatform_v1.types.AddContextChildrenRequest
google.cloud.aiplatform_v1.types.AddContextChildrenResponse
AddContextChildrenResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.AddContextChildren.
See more: google.cloud.aiplatform_v1.types.AddContextChildrenResponse
google.cloud.aiplatform_v1.types.AddExecutionEventsRequest
AddExecutionEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.AddExecutionEvents.
See more: google.cloud.aiplatform_v1.types.AddExecutionEventsRequest
google.cloud.aiplatform_v1.types.AddExecutionEventsResponse
AddExecutionEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.AddExecutionEvents.
See more: google.cloud.aiplatform_v1.types.AddExecutionEventsResponse
google.cloud.aiplatform_v1.types.AddTrialMeasurementRequest
AddTrialMeasurementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.AddTrialMeasurement.
See more: google.cloud.aiplatform_v1.types.AddTrialMeasurementRequest
google.cloud.aiplatform_v1.types.Annotation
Annotation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.
google.cloud.aiplatform_v1.types.Annotation.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Annotation.LabelsEntry
google.cloud.aiplatform_v1.types.AnnotationSpec
AnnotationSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Identifies a concept with which DataItems may be annotated with.
google.cloud.aiplatform_v1.types.Artifact
Artifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Instance of a general artifact.
google.cloud.aiplatform_v1.types.Artifact.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Artifact.LabelsEntry
google.cloud.aiplatform_v1.types.Artifact.State
State(value)
Describes the state of the Artifact.
google.cloud.aiplatform_v1.types.AssignNotebookRuntimeOperationMetadata
AssignNotebookRuntimeOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Metadata information for NotebookService.AssignNotebookRuntime.
See more: google.cloud.aiplatform_v1.types.AssignNotebookRuntimeOperationMetadata
google.cloud.aiplatform_v1.types.AssignNotebookRuntimeRequest
AssignNotebookRuntimeRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.AssignNotebookRuntime.
See more: google.cloud.aiplatform_v1.types.AssignNotebookRuntimeRequest
google.cloud.aiplatform_v1.types.Attribution
Attribution(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Attribution that explains a particular prediction output.
google.cloud.aiplatform_v1.types.AutomaticResources
AutomaticResources(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
See more: google.cloud.aiplatform_v1.types.AutomaticResources
google.cloud.aiplatform_v1.types.AutoscalingMetricSpec
AutoscalingMetricSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.
See more: google.cloud.aiplatform_v1.types.AutoscalingMetricSpec
google.cloud.aiplatform_v1.types.AvroSource
AvroSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The storage details for Avro input content.
google.cloud.aiplatform_v1.types.BatchCancelPipelineJobsOperationMetadata
BatchCancelPipelineJobsOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for PipelineService.BatchCancelPipelineJobs.
See more: google.cloud.aiplatform_v1.types.BatchCancelPipelineJobsOperationMetadata
google.cloud.aiplatform_v1.types.BatchCancelPipelineJobsRequest
BatchCancelPipelineJobsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PipelineService.BatchCancelPipelineJobs.
See more: google.cloud.aiplatform_v1.types.BatchCancelPipelineJobsRequest
google.cloud.aiplatform_v1.types.BatchCancelPipelineJobsResponse
BatchCancelPipelineJobsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for PipelineService.BatchCancelPipelineJobs.
See more: google.cloud.aiplatform_v1.types.BatchCancelPipelineJobsResponse
google.cloud.aiplatform_v1.types.BatchCreateFeaturesOperationMetadata
BatchCreateFeaturesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform batch create Features.
See more: google.cloud.aiplatform_v1.types.BatchCreateFeaturesOperationMetadata
google.cloud.aiplatform_v1.types.BatchCreateFeaturesRequest
BatchCreateFeaturesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.BatchCreateFeatures.
See more: google.cloud.aiplatform_v1.types.BatchCreateFeaturesRequest
google.cloud.aiplatform_v1.types.BatchCreateFeaturesResponse
BatchCreateFeaturesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.BatchCreateFeatures.
See more: google.cloud.aiplatform_v1.types.BatchCreateFeaturesResponse
google.cloud.aiplatform_v1.types.BatchCreateTensorboardRunsRequest
BatchCreateTensorboardRunsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.BatchCreateTensorboardRuns.
See more: google.cloud.aiplatform_v1.types.BatchCreateTensorboardRunsRequest
google.cloud.aiplatform_v1.types.BatchCreateTensorboardRunsResponse
BatchCreateTensorboardRunsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.BatchCreateTensorboardRuns.
See more: google.cloud.aiplatform_v1.types.BatchCreateTensorboardRunsResponse
google.cloud.aiplatform_v1.types.BatchCreateTensorboardTimeSeriesRequest
BatchCreateTensorboardTimeSeriesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.BatchCreateTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1.types.BatchCreateTensorboardTimeSeriesRequest
google.cloud.aiplatform_v1.types.BatchCreateTensorboardTimeSeriesResponse
BatchCreateTensorboardTimeSeriesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.BatchCreateTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1.types.BatchCreateTensorboardTimeSeriesResponse
google.cloud.aiplatform_v1.types.BatchDedicatedResources
BatchDedicatedResources(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration.
See more: google.cloud.aiplatform_v1.types.BatchDedicatedResources
google.cloud.aiplatform_v1.types.BatchDeletePipelineJobsRequest
BatchDeletePipelineJobsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PipelineService.BatchDeletePipelineJobs.
See more: google.cloud.aiplatform_v1.types.BatchDeletePipelineJobsRequest
google.cloud.aiplatform_v1.types.BatchDeletePipelineJobsResponse
BatchDeletePipelineJobsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for PipelineService.BatchDeletePipelineJobs.
See more: google.cloud.aiplatform_v1.types.BatchDeletePipelineJobsResponse
google.cloud.aiplatform_v1.types.BatchImportEvaluatedAnnotationsRequest
BatchImportEvaluatedAnnotationsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ModelService.BatchImportEvaluatedAnnotations .
See more: google.cloud.aiplatform_v1.types.BatchImportEvaluatedAnnotationsRequest
google.cloud.aiplatform_v1.types.BatchImportEvaluatedAnnotationsResponse
BatchImportEvaluatedAnnotationsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for ModelService.BatchImportEvaluatedAnnotations .
See more: google.cloud.aiplatform_v1.types.BatchImportEvaluatedAnnotationsResponse
google.cloud.aiplatform_v1.types.BatchImportModelEvaluationSlicesRequest
BatchImportModelEvaluationSlicesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ModelService.BatchImportModelEvaluationSlices .
See more: google.cloud.aiplatform_v1.types.BatchImportModelEvaluationSlicesRequest
google.cloud.aiplatform_v1.types.BatchImportModelEvaluationSlicesResponse
BatchImportModelEvaluationSlicesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for ModelService.BatchImportModelEvaluationSlices .
See more: google.cloud.aiplatform_v1.types.BatchImportModelEvaluationSlicesResponse
google.cloud.aiplatform_v1.types.BatchMigrateResourcesOperationMetadata
BatchMigrateResourcesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for MigrationService.BatchMigrateResources.
See more: google.cloud.aiplatform_v1.types.BatchMigrateResourcesOperationMetadata
google.cloud.aiplatform_v1.types.BatchMigrateResourcesOperationMetadata.PartialResult
PartialResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a partial result in batch migration operation for one MigrateResourceRequest.
See more: google.cloud.aiplatform_v1.types.BatchMigrateResourcesOperationMetadata.PartialResult
google.cloud.aiplatform_v1.types.BatchMigrateResourcesRequest
BatchMigrateResourcesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for MigrationService.BatchMigrateResources.
See more: google.cloud.aiplatform_v1.types.BatchMigrateResourcesRequest
google.cloud.aiplatform_v1.types.BatchMigrateResourcesResponse
BatchMigrateResourcesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for MigrationService.BatchMigrateResources.
See more: google.cloud.aiplatform_v1.types.BatchMigrateResourcesResponse
google.cloud.aiplatform_v1.types.BatchPredictionJob
BatchPredictionJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A job that uses a Model to produce predictions on multiple [input instances][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
See more: google.cloud.aiplatform_v1.types.BatchPredictionJob
google.cloud.aiplatform_v1.types.BatchPredictionJob.InputConfig
InputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configures the input to BatchPredictionJob.
See more: google.cloud.aiplatform_v1.types.BatchPredictionJob.InputConfig
google.cloud.aiplatform_v1.types.BatchPredictionJob.InstanceConfig
InstanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration defining how to transform batch prediction input instances to the instances that the Model accepts.
See more: google.cloud.aiplatform_v1.types.BatchPredictionJob.InstanceConfig
google.cloud.aiplatform_v1.types.BatchPredictionJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.BatchPredictionJob.LabelsEntry
google.cloud.aiplatform_v1.types.BatchPredictionJob.OutputConfig
OutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configures the output of BatchPredictionJob.
See more: google.cloud.aiplatform_v1.types.BatchPredictionJob.OutputConfig
google.cloud.aiplatform_v1.types.BatchPredictionJob.OutputInfo
OutputInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Further describes this job's output.
See more: google.cloud.aiplatform_v1.types.BatchPredictionJob.OutputInfo
google.cloud.aiplatform_v1.types.BatchReadFeatureValuesOperationMetadata
BatchReadFeatureValuesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that batch reads Feature values.
See more: google.cloud.aiplatform_v1.types.BatchReadFeatureValuesOperationMetadata
google.cloud.aiplatform_v1.types.BatchReadFeatureValuesRequest
BatchReadFeatureValuesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeaturestoreService.BatchReadFeatureValues.
See more: google.cloud.aiplatform_v1.types.BatchReadFeatureValuesRequest
google.cloud.aiplatform_v1.types.BatchReadFeatureValuesRequest.EntityTypeSpec
EntityTypeSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Selects Features of an EntityType to read values of and specifies read settings.
See more: google.cloud.aiplatform_v1.types.BatchReadFeatureValuesRequest.EntityTypeSpec
google.cloud.aiplatform_v1.types.BatchReadFeatureValuesRequest.PassThroughField
PassThroughField(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describe pass-through fields in read_instance source.
See more: google.cloud.aiplatform_v1.types.BatchReadFeatureValuesRequest.PassThroughField
google.cloud.aiplatform_v1.types.BatchReadFeatureValuesResponse
BatchReadFeatureValuesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for FeaturestoreService.BatchReadFeatureValues.
See more: google.cloud.aiplatform_v1.types.BatchReadFeatureValuesResponse
google.cloud.aiplatform_v1.types.BatchReadTensorboardTimeSeriesDataRequest
BatchReadTensorboardTimeSeriesDataRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.BatchReadTensorboardTimeSeriesData.
See more: google.cloud.aiplatform_v1.types.BatchReadTensorboardTimeSeriesDataRequest
google.cloud.aiplatform_v1.types.BatchReadTensorboardTimeSeriesDataResponse
BatchReadTensorboardTimeSeriesDataResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.BatchReadTensorboardTimeSeriesData.
See more: google.cloud.aiplatform_v1.types.BatchReadTensorboardTimeSeriesDataResponse
google.cloud.aiplatform_v1.types.BigQueryDestination
BigQueryDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The BigQuery location for the output content.
See more: google.cloud.aiplatform_v1.types.BigQueryDestination
google.cloud.aiplatform_v1.types.BigQuerySource
BigQuerySource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The BigQuery location for the input content.
google.cloud.aiplatform_v1.types.Blob
Blob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Content blob.
See more: google.cloud.aiplatform_v1.types.Blob
google.cloud.aiplatform_v1.types.BlurBaselineConfig
BlurBaselineConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for blur baseline.
See more: google.cloud.aiplatform_v1.types.BlurBaselineConfig
google.cloud.aiplatform_v1.types.BoolArray
BoolArray(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of boolean values.
google.cloud.aiplatform_v1.types.CancelBatchPredictionJobRequest
CancelBatchPredictionJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CancelBatchPredictionJob.
See more: google.cloud.aiplatform_v1.types.CancelBatchPredictionJobRequest
google.cloud.aiplatform_v1.types.CancelCustomJobRequest
CancelCustomJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.CancelCustomJob.
See more: google.cloud.aiplatform_v1.types.CancelCustomJobRequest
google.cloud.aiplatform_v1.types.CancelDataLabelingJobRequest
CancelDataLabelingJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CancelDataLabelingJob.
See more: google.cloud.aiplatform_v1.types.CancelDataLabelingJobRequest
google.cloud.aiplatform_v1.types.CancelHyperparameterTuningJobRequest
CancelHyperparameterTuningJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CancelHyperparameterTuningJob.
See more: google.cloud.aiplatform_v1.types.CancelHyperparameterTuningJobRequest
google.cloud.aiplatform_v1.types.CancelNasJobRequest
CancelNasJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.CancelNasJob.
See more: google.cloud.aiplatform_v1.types.CancelNasJobRequest
google.cloud.aiplatform_v1.types.CancelPipelineJobRequest
CancelPipelineJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PipelineService.CancelPipelineJob.
See more: google.cloud.aiplatform_v1.types.CancelPipelineJobRequest
google.cloud.aiplatform_v1.types.CancelTrainingPipelineRequest
CancelTrainingPipelineRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PipelineService.CancelTrainingPipeline.
See more: google.cloud.aiplatform_v1.types.CancelTrainingPipelineRequest
google.cloud.aiplatform_v1.types.CancelTuningJobRequest
CancelTuningJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for GenAiTuningService.CancelTuningJob.
See more: google.cloud.aiplatform_v1.types.CancelTuningJobRequest
google.cloud.aiplatform_v1.types.Candidate
Candidate(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A response candidate generated from the model.
google.cloud.aiplatform_v1.types.Candidate.FinishReason
FinishReason(value)
The reason why the model stopped generating tokens.
See more: google.cloud.aiplatform_v1.types.Candidate.FinishReason
google.cloud.aiplatform_v1.types.CheckTrialEarlyStoppingStateMetatdata
CheckTrialEarlyStoppingStateMetatdata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.
See more: google.cloud.aiplatform_v1.types.CheckTrialEarlyStoppingStateMetatdata
google.cloud.aiplatform_v1.types.CheckTrialEarlyStoppingStateRequest
CheckTrialEarlyStoppingStateRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for VizierService.CheckTrialEarlyStoppingState.
See more: google.cloud.aiplatform_v1.types.CheckTrialEarlyStoppingStateRequest
google.cloud.aiplatform_v1.types.CheckTrialEarlyStoppingStateResponse
CheckTrialEarlyStoppingStateResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for VizierService.CheckTrialEarlyStoppingState.
See more: google.cloud.aiplatform_v1.types.CheckTrialEarlyStoppingStateResponse
google.cloud.aiplatform_v1.types.Citation
Citation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Source attributions for content.
google.cloud.aiplatform_v1.types.CitationMetadata
CitationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A collection of source attributions for a piece of content.
google.cloud.aiplatform_v1.types.CompleteTrialRequest
CompleteTrialRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.CompleteTrial.
See more: google.cloud.aiplatform_v1.types.CompleteTrialRequest
google.cloud.aiplatform_v1.types.CompletionStats
CompletionStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch.
google.cloud.aiplatform_v1.types.ComputeTokensRequest
ComputeTokensRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ComputeTokens RPC call.
See more: google.cloud.aiplatform_v1.types.ComputeTokensRequest
google.cloud.aiplatform_v1.types.ComputeTokensResponse
ComputeTokensResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for ComputeTokens RPC call.
See more: google.cloud.aiplatform_v1.types.ComputeTokensResponse
google.cloud.aiplatform_v1.types.ContainerRegistryDestination
ContainerRegistryDestination(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The Container Registry location for the container image.
See more: google.cloud.aiplatform_v1.types.ContainerRegistryDestination
google.cloud.aiplatform_v1.types.ContainerSpec
ContainerSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The spec of a Container.
google.cloud.aiplatform_v1.types.Content
Content(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The base structured datatype containing multi-part content of a message.
See more: google.cloud.aiplatform_v1.types.Content
google.cloud.aiplatform_v1.types.Context
Context(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Instance of a general context.
See more: google.cloud.aiplatform_v1.types.Context
google.cloud.aiplatform_v1.types.Context.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Context.LabelsEntry
google.cloud.aiplatform_v1.types.CopyModelOperationMetadata
CopyModelOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Details of ModelService.CopyModel operation.
See more: google.cloud.aiplatform_v1.types.CopyModelOperationMetadata
google.cloud.aiplatform_v1.types.CopyModelRequest
CopyModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.CopyModel.
google.cloud.aiplatform_v1.types.CopyModelResponse
CopyModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message of ModelService.CopyModel operation.
See more: google.cloud.aiplatform_v1.types.CopyModelResponse
google.cloud.aiplatform_v1.types.CountTokensRequest
CountTokensRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for [PredictionService.CountTokens][].
See more: google.cloud.aiplatform_v1.types.CountTokensRequest
google.cloud.aiplatform_v1.types.CountTokensResponse
CountTokensResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for [PredictionService.CountTokens][].
See more: google.cloud.aiplatform_v1.types.CountTokensResponse
google.cloud.aiplatform_v1.types.CreateArtifactRequest
CreateArtifactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.CreateArtifact.
See more: google.cloud.aiplatform_v1.types.CreateArtifactRequest
google.cloud.aiplatform_v1.types.CreateBatchPredictionJobRequest
CreateBatchPredictionJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CreateBatchPredictionJob.
See more: google.cloud.aiplatform_v1.types.CreateBatchPredictionJobRequest
google.cloud.aiplatform_v1.types.CreateContextRequest
CreateContextRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.CreateContext.
See more: google.cloud.aiplatform_v1.types.CreateContextRequest
google.cloud.aiplatform_v1.types.CreateCustomJobRequest
CreateCustomJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.CreateCustomJob.
See more: google.cloud.aiplatform_v1.types.CreateCustomJobRequest
google.cloud.aiplatform_v1.types.CreateDataLabelingJobRequest
CreateDataLabelingJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CreateDataLabelingJob.
See more: google.cloud.aiplatform_v1.types.CreateDataLabelingJobRequest
google.cloud.aiplatform_v1.types.CreateDatasetOperationMetadata
CreateDatasetOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for DatasetService.CreateDataset.
See more: google.cloud.aiplatform_v1.types.CreateDatasetOperationMetadata
google.cloud.aiplatform_v1.types.CreateDatasetRequest
CreateDatasetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.CreateDataset.
See more: google.cloud.aiplatform_v1.types.CreateDatasetRequest
google.cloud.aiplatform_v1.types.CreateDatasetVersionOperationMetadata
CreateDatasetVersionOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for DatasetService.CreateDatasetVersion.
See more: google.cloud.aiplatform_v1.types.CreateDatasetVersionOperationMetadata
google.cloud.aiplatform_v1.types.CreateDatasetVersionRequest
CreateDatasetVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.CreateDatasetVersion.
See more: google.cloud.aiplatform_v1.types.CreateDatasetVersionRequest
google.cloud.aiplatform_v1.types.CreateDeploymentResourcePoolOperationMetadata
CreateDeploymentResourcePoolOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for CreateDeploymentResourcePool method.
See more: google.cloud.aiplatform_v1.types.CreateDeploymentResourcePoolOperationMetadata
google.cloud.aiplatform_v1.types.CreateDeploymentResourcePoolRequest
CreateDeploymentResourcePoolRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for CreateDeploymentResourcePool method.
See more: google.cloud.aiplatform_v1.types.CreateDeploymentResourcePoolRequest
google.cloud.aiplatform_v1.types.CreateEndpointOperationMetadata
CreateEndpointOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for EndpointService.CreateEndpoint.
See more: google.cloud.aiplatform_v1.types.CreateEndpointOperationMetadata
google.cloud.aiplatform_v1.types.CreateEndpointRequest
CreateEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.CreateEndpoint.
See more: google.cloud.aiplatform_v1.types.CreateEndpointRequest
google.cloud.aiplatform_v1.types.CreateEntityTypeOperationMetadata
CreateEntityTypeOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create EntityType.
See more: google.cloud.aiplatform_v1.types.CreateEntityTypeOperationMetadata
google.cloud.aiplatform_v1.types.CreateEntityTypeRequest
CreateEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.CreateEntityType.
See more: google.cloud.aiplatform_v1.types.CreateEntityTypeRequest
google.cloud.aiplatform_v1.types.CreateExecutionRequest
CreateExecutionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.CreateExecution.
See more: google.cloud.aiplatform_v1.types.CreateExecutionRequest
google.cloud.aiplatform_v1.types.CreateFeatureGroupOperationMetadata
CreateFeatureGroupOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create FeatureGroup.
See more: google.cloud.aiplatform_v1.types.CreateFeatureGroupOperationMetadata
google.cloud.aiplatform_v1.types.CreateFeatureGroupRequest
CreateFeatureGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureRegistryService.CreateFeatureGroup.
See more: google.cloud.aiplatform_v1.types.CreateFeatureGroupRequest
google.cloud.aiplatform_v1.types.CreateFeatureOnlineStoreOperationMetadata
CreateFeatureOnlineStoreOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create FeatureOnlineStore.
See more: google.cloud.aiplatform_v1.types.CreateFeatureOnlineStoreOperationMetadata
google.cloud.aiplatform_v1.types.CreateFeatureOnlineStoreRequest
CreateFeatureOnlineStoreRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeatureOnlineStoreAdminService.CreateFeatureOnlineStore.
See more: google.cloud.aiplatform_v1.types.CreateFeatureOnlineStoreRequest
google.cloud.aiplatform_v1.types.CreateFeatureOperationMetadata
CreateFeatureOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create Feature.
See more: google.cloud.aiplatform_v1.types.CreateFeatureOperationMetadata
google.cloud.aiplatform_v1.types.CreateFeatureRequest
CreateFeatureRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.CreateFeature.
See more: google.cloud.aiplatform_v1.types.CreateFeatureRequest
google.cloud.aiplatform_v1.types.CreateFeatureViewOperationMetadata
CreateFeatureViewOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create FeatureView.
See more: google.cloud.aiplatform_v1.types.CreateFeatureViewOperationMetadata
google.cloud.aiplatform_v1.types.CreateFeatureViewRequest
CreateFeatureViewRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.CreateFeatureView.
See more: google.cloud.aiplatform_v1.types.CreateFeatureViewRequest
google.cloud.aiplatform_v1.types.CreateFeaturestoreOperationMetadata
CreateFeaturestoreOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create Featurestore.
See more: google.cloud.aiplatform_v1.types.CreateFeaturestoreOperationMetadata
google.cloud.aiplatform_v1.types.CreateFeaturestoreRequest
CreateFeaturestoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.CreateFeaturestore.
See more: google.cloud.aiplatform_v1.types.CreateFeaturestoreRequest
google.cloud.aiplatform_v1.types.CreateHyperparameterTuningJobRequest
CreateHyperparameterTuningJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CreateHyperparameterTuningJob.
See more: google.cloud.aiplatform_v1.types.CreateHyperparameterTuningJobRequest
google.cloud.aiplatform_v1.types.CreateIndexEndpointOperationMetadata
CreateIndexEndpointOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for IndexEndpointService.CreateIndexEndpoint.
See more: google.cloud.aiplatform_v1.types.CreateIndexEndpointOperationMetadata
google.cloud.aiplatform_v1.types.CreateIndexEndpointRequest
CreateIndexEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.CreateIndexEndpoint.
See more: google.cloud.aiplatform_v1.types.CreateIndexEndpointRequest
google.cloud.aiplatform_v1.types.CreateIndexOperationMetadata
CreateIndexOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for IndexService.CreateIndex.
See more: google.cloud.aiplatform_v1.types.CreateIndexOperationMetadata
google.cloud.aiplatform_v1.types.CreateIndexRequest
CreateIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.CreateIndex.
See more: google.cloud.aiplatform_v1.types.CreateIndexRequest
google.cloud.aiplatform_v1.types.CreateMetadataSchemaRequest
CreateMetadataSchemaRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.CreateMetadataSchema.
See more: google.cloud.aiplatform_v1.types.CreateMetadataSchemaRequest
google.cloud.aiplatform_v1.types.CreateMetadataStoreOperationMetadata
CreateMetadataStoreOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform MetadataService.CreateMetadataStore.
See more: google.cloud.aiplatform_v1.types.CreateMetadataStoreOperationMetadata
google.cloud.aiplatform_v1.types.CreateMetadataStoreRequest
CreateMetadataStoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.CreateMetadataStore.
See more: google.cloud.aiplatform_v1.types.CreateMetadataStoreRequest
google.cloud.aiplatform_v1.types.CreateModelDeploymentMonitoringJobRequest
CreateModelDeploymentMonitoringJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CreateModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1.types.CreateModelDeploymentMonitoringJobRequest
google.cloud.aiplatform_v1.types.CreateNasJobRequest
CreateNasJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.CreateNasJob.
See more: google.cloud.aiplatform_v1.types.CreateNasJobRequest
google.cloud.aiplatform_v1.types.CreateNotebookRuntimeTemplateOperationMetadata
CreateNotebookRuntimeTemplateOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Metadata information for NotebookService.CreateNotebookRuntimeTemplate.
See more: google.cloud.aiplatform_v1.types.CreateNotebookRuntimeTemplateOperationMetadata
google.cloud.aiplatform_v1.types.CreateNotebookRuntimeTemplateRequest
CreateNotebookRuntimeTemplateRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.CreateNotebookRuntimeTemplate.
See more: google.cloud.aiplatform_v1.types.CreateNotebookRuntimeTemplateRequest
google.cloud.aiplatform_v1.types.CreatePersistentResourceOperationMetadata
CreatePersistentResourceOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create PersistentResource.
See more: google.cloud.aiplatform_v1.types.CreatePersistentResourceOperationMetadata
google.cloud.aiplatform_v1.types.CreatePersistentResourceRequest
CreatePersistentResourceRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PersistentResourceService.CreatePersistentResource.
See more: google.cloud.aiplatform_v1.types.CreatePersistentResourceRequest
google.cloud.aiplatform_v1.types.CreatePipelineJobRequest
CreatePipelineJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PipelineService.CreatePipelineJob.
See more: google.cloud.aiplatform_v1.types.CreatePipelineJobRequest
google.cloud.aiplatform_v1.types.CreateRegistryFeatureOperationMetadata
CreateRegistryFeatureOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create FeatureGroup.
See more: google.cloud.aiplatform_v1.types.CreateRegistryFeatureOperationMetadata
google.cloud.aiplatform_v1.types.CreateScheduleRequest
CreateScheduleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.CreateSchedule.
See more: google.cloud.aiplatform_v1.types.CreateScheduleRequest
google.cloud.aiplatform_v1.types.CreateSpecialistPoolOperationMetadata
CreateSpecialistPoolOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for SpecialistPoolService.CreateSpecialistPool.
See more: google.cloud.aiplatform_v1.types.CreateSpecialistPoolOperationMetadata
google.cloud.aiplatform_v1.types.CreateSpecialistPoolRequest
CreateSpecialistPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for SpecialistPoolService.CreateSpecialistPool.
See more: google.cloud.aiplatform_v1.types.CreateSpecialistPoolRequest
google.cloud.aiplatform_v1.types.CreateStudyRequest
CreateStudyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.CreateStudy.
See more: google.cloud.aiplatform_v1.types.CreateStudyRequest
google.cloud.aiplatform_v1.types.CreateTensorboardExperimentRequest
CreateTensorboardExperimentRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.CreateTensorboardExperiment.
See more: google.cloud.aiplatform_v1.types.CreateTensorboardExperimentRequest
google.cloud.aiplatform_v1.types.CreateTensorboardOperationMetadata
CreateTensorboardOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create Tensorboard.
See more: google.cloud.aiplatform_v1.types.CreateTensorboardOperationMetadata
google.cloud.aiplatform_v1.types.CreateTensorboardRequest
CreateTensorboardRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.CreateTensorboard.
See more: google.cloud.aiplatform_v1.types.CreateTensorboardRequest
google.cloud.aiplatform_v1.types.CreateTensorboardRunRequest
CreateTensorboardRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.CreateTensorboardRun.
See more: google.cloud.aiplatform_v1.types.CreateTensorboardRunRequest
google.cloud.aiplatform_v1.types.CreateTensorboardTimeSeriesRequest
CreateTensorboardTimeSeriesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.CreateTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1.types.CreateTensorboardTimeSeriesRequest
google.cloud.aiplatform_v1.types.CreateTrainingPipelineRequest
CreateTrainingPipelineRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PipelineService.CreateTrainingPipeline.
See more: google.cloud.aiplatform_v1.types.CreateTrainingPipelineRequest
google.cloud.aiplatform_v1.types.CreateTrialRequest
CreateTrialRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.CreateTrial.
See more: google.cloud.aiplatform_v1.types.CreateTrialRequest
google.cloud.aiplatform_v1.types.CreateTuningJobRequest
CreateTuningJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for GenAiTuningService.CreateTuningJob.
See more: google.cloud.aiplatform_v1.types.CreateTuningJobRequest
google.cloud.aiplatform_v1.types.CsvDestination
CsvDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The storage details for CSV output content.
google.cloud.aiplatform_v1.types.CsvSource
CsvSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The storage details for CSV input content.
google.cloud.aiplatform_v1.types.CustomJob
CustomJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a job that runs custom workloads such as a Docker container or a Python package.
google.cloud.aiplatform_v1.types.CustomJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.CustomJob.LabelsEntry
google.cloud.aiplatform_v1.types.CustomJob.WebAccessUrisEntry
WebAccessUrisEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.CustomJob.WebAccessUrisEntry
google.cloud.aiplatform_v1.types.CustomJobSpec
CustomJobSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of a CustomJob.
google.cloud.aiplatform_v1.types.DataItem
DataItem(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A piece of data in a Dataset.
google.cloud.aiplatform_v1.types.DataItem.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.DataItem.LabelsEntry
google.cloud.aiplatform_v1.types.DataItemView
DataItemView(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A container for a single DataItem and Annotations on it.
google.cloud.aiplatform_v1.types.DataLabelingJob
DataLabelingJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset: .
google.cloud.aiplatform_v1.types.DataLabelingJob.AnnotationLabelsEntry
AnnotationLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.DataLabelingJob.AnnotationLabelsEntry
google.cloud.aiplatform_v1.types.DataLabelingJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.DataLabelingJob.LabelsEntry
google.cloud.aiplatform_v1.types.Dataset
Dataset(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A collection of DataItems and Annotations on them.
See more: google.cloud.aiplatform_v1.types.Dataset
google.cloud.aiplatform_v1.types.Dataset.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Dataset.LabelsEntry
google.cloud.aiplatform_v1.types.DatasetVersion
DatasetVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes the dataset version.
google.cloud.aiplatform_v1.types.DedicatedResources
DedicatedResources(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.
See more: google.cloud.aiplatform_v1.types.DedicatedResources
google.cloud.aiplatform_v1.types.DeleteArtifactRequest
DeleteArtifactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.DeleteArtifact.
See more: google.cloud.aiplatform_v1.types.DeleteArtifactRequest
google.cloud.aiplatform_v1.types.DeleteBatchPredictionJobRequest
DeleteBatchPredictionJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.DeleteBatchPredictionJob.
See more: google.cloud.aiplatform_v1.types.DeleteBatchPredictionJobRequest
google.cloud.aiplatform_v1.types.DeleteContextRequest
DeleteContextRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.DeleteContext.
See more: google.cloud.aiplatform_v1.types.DeleteContextRequest
google.cloud.aiplatform_v1.types.DeleteCustomJobRequest
DeleteCustomJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.DeleteCustomJob.
See more: google.cloud.aiplatform_v1.types.DeleteCustomJobRequest
google.cloud.aiplatform_v1.types.DeleteDataLabelingJobRequest
DeleteDataLabelingJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.DeleteDataLabelingJob.
See more: google.cloud.aiplatform_v1.types.DeleteDataLabelingJobRequest
google.cloud.aiplatform_v1.types.DeleteDatasetRequest
DeleteDatasetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.DeleteDataset.
See more: google.cloud.aiplatform_v1.types.DeleteDatasetRequest
google.cloud.aiplatform_v1.types.DeleteDatasetVersionRequest
DeleteDatasetVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.DeleteDatasetVersion.
See more: google.cloud.aiplatform_v1.types.DeleteDatasetVersionRequest
google.cloud.aiplatform_v1.types.DeleteDeploymentResourcePoolRequest
DeleteDeploymentResourcePoolRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for DeleteDeploymentResourcePool method.
See more: google.cloud.aiplatform_v1.types.DeleteDeploymentResourcePoolRequest
google.cloud.aiplatform_v1.types.DeleteEndpointRequest
DeleteEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.DeleteEndpoint.
See more: google.cloud.aiplatform_v1.types.DeleteEndpointRequest
google.cloud.aiplatform_v1.types.DeleteEntityTypeRequest
DeleteEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for [FeaturestoreService.DeleteEntityTypes][].
See more: google.cloud.aiplatform_v1.types.DeleteEntityTypeRequest
google.cloud.aiplatform_v1.types.DeleteExecutionRequest
DeleteExecutionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.DeleteExecution.
See more: google.cloud.aiplatform_v1.types.DeleteExecutionRequest
google.cloud.aiplatform_v1.types.DeleteFeatureGroupRequest
DeleteFeatureGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureRegistryService.DeleteFeatureGroup.
See more: google.cloud.aiplatform_v1.types.DeleteFeatureGroupRequest
google.cloud.aiplatform_v1.types.DeleteFeatureOnlineStoreRequest
DeleteFeatureOnlineStoreRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeatureOnlineStoreAdminService.DeleteFeatureOnlineStore.
See more: google.cloud.aiplatform_v1.types.DeleteFeatureOnlineStoreRequest
google.cloud.aiplatform_v1.types.DeleteFeatureRequest
DeleteFeatureRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.DeleteFeature.
See more: google.cloud.aiplatform_v1.types.DeleteFeatureRequest
google.cloud.aiplatform_v1.types.DeleteFeatureValuesOperationMetadata
DeleteFeatureValuesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that delete Feature values.
See more: google.cloud.aiplatform_v1.types.DeleteFeatureValuesOperationMetadata
google.cloud.aiplatform_v1.types.DeleteFeatureValuesRequest
DeleteFeatureValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.DeleteFeatureValues.
See more: google.cloud.aiplatform_v1.types.DeleteFeatureValuesRequest
google.cloud.aiplatform_v1.types.DeleteFeatureValuesRequest.SelectEntity
SelectEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Message to select entity.
See more: google.cloud.aiplatform_v1.types.DeleteFeatureValuesRequest.SelectEntity
google.cloud.aiplatform_v1.types.DeleteFeatureValuesRequest.SelectTimeRangeAndFeature
SelectTimeRangeAndFeature(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Message to select time range and feature.
See more: google.cloud.aiplatform_v1.types.DeleteFeatureValuesRequest.SelectTimeRangeAndFeature
google.cloud.aiplatform_v1.types.DeleteFeatureValuesResponse
DeleteFeatureValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.DeleteFeatureValues.
See more: google.cloud.aiplatform_v1.types.DeleteFeatureValuesResponse
google.cloud.aiplatform_v1.types.DeleteFeatureValuesResponse.SelectEntity
SelectEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message if the request uses the SelectEntity option.
See more: google.cloud.aiplatform_v1.types.DeleteFeatureValuesResponse.SelectEntity
google.cloud.aiplatform_v1.types.DeleteFeatureValuesResponse.SelectTimeRangeAndFeature
SelectTimeRangeAndFeature(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message if the request uses the SelectTimeRangeAndFeature option.
See more: google.cloud.aiplatform_v1.types.DeleteFeatureValuesResponse.SelectTimeRangeAndFeature
google.cloud.aiplatform_v1.types.DeleteFeatureViewRequest
DeleteFeatureViewRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for [FeatureOnlineStoreAdminService.DeleteFeatureViews][].
See more: google.cloud.aiplatform_v1.types.DeleteFeatureViewRequest
google.cloud.aiplatform_v1.types.DeleteFeaturestoreRequest
DeleteFeaturestoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.DeleteFeaturestore.
See more: google.cloud.aiplatform_v1.types.DeleteFeaturestoreRequest
google.cloud.aiplatform_v1.types.DeleteHyperparameterTuningJobRequest
DeleteHyperparameterTuningJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.DeleteHyperparameterTuningJob.
See more: google.cloud.aiplatform_v1.types.DeleteHyperparameterTuningJobRequest
google.cloud.aiplatform_v1.types.DeleteIndexEndpointRequest
DeleteIndexEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.DeleteIndexEndpoint.
See more: google.cloud.aiplatform_v1.types.DeleteIndexEndpointRequest
google.cloud.aiplatform_v1.types.DeleteIndexRequest
DeleteIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.DeleteIndex.
See more: google.cloud.aiplatform_v1.types.DeleteIndexRequest
google.cloud.aiplatform_v1.types.DeleteMetadataStoreOperationMetadata
DeleteMetadataStoreOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform MetadataService.DeleteMetadataStore.
See more: google.cloud.aiplatform_v1.types.DeleteMetadataStoreOperationMetadata
google.cloud.aiplatform_v1.types.DeleteMetadataStoreRequest
DeleteMetadataStoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.DeleteMetadataStore.
See more: google.cloud.aiplatform_v1.types.DeleteMetadataStoreRequest
google.cloud.aiplatform_v1.types.DeleteModelDeploymentMonitoringJobRequest
DeleteModelDeploymentMonitoringJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.DeleteModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1.types.DeleteModelDeploymentMonitoringJobRequest
google.cloud.aiplatform_v1.types.DeleteModelRequest
DeleteModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.DeleteModel.
See more: google.cloud.aiplatform_v1.types.DeleteModelRequest
google.cloud.aiplatform_v1.types.DeleteModelVersionRequest
DeleteModelVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.DeleteModelVersion.
See more: google.cloud.aiplatform_v1.types.DeleteModelVersionRequest
google.cloud.aiplatform_v1.types.DeleteNasJobRequest
DeleteNasJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.DeleteNasJob.
See more: google.cloud.aiplatform_v1.types.DeleteNasJobRequest
google.cloud.aiplatform_v1.types.DeleteNotebookRuntimeRequest
DeleteNotebookRuntimeRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.DeleteNotebookRuntime.
See more: google.cloud.aiplatform_v1.types.DeleteNotebookRuntimeRequest
google.cloud.aiplatform_v1.types.DeleteNotebookRuntimeTemplateRequest
DeleteNotebookRuntimeTemplateRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.DeleteNotebookRuntimeTemplate.
See more: google.cloud.aiplatform_v1.types.DeleteNotebookRuntimeTemplateRequest
google.cloud.aiplatform_v1.types.DeleteOperationMetadata
DeleteOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Details of operations that perform deletes of any entities.
See more: google.cloud.aiplatform_v1.types.DeleteOperationMetadata
google.cloud.aiplatform_v1.types.DeletePersistentResourceRequest
DeletePersistentResourceRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PersistentResourceService.DeletePersistentResource.
See more: google.cloud.aiplatform_v1.types.DeletePersistentResourceRequest
google.cloud.aiplatform_v1.types.DeletePipelineJobRequest
DeletePipelineJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PipelineService.DeletePipelineJob.
See more: google.cloud.aiplatform_v1.types.DeletePipelineJobRequest
google.cloud.aiplatform_v1.types.DeleteSavedQueryRequest
DeleteSavedQueryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.DeleteSavedQuery.
See more: google.cloud.aiplatform_v1.types.DeleteSavedQueryRequest
google.cloud.aiplatform_v1.types.DeleteScheduleRequest
DeleteScheduleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.DeleteSchedule.
See more: google.cloud.aiplatform_v1.types.DeleteScheduleRequest
google.cloud.aiplatform_v1.types.DeleteSpecialistPoolRequest
DeleteSpecialistPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for SpecialistPoolService.DeleteSpecialistPool.
See more: google.cloud.aiplatform_v1.types.DeleteSpecialistPoolRequest
google.cloud.aiplatform_v1.types.DeleteStudyRequest
DeleteStudyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.DeleteStudy.
See more: google.cloud.aiplatform_v1.types.DeleteStudyRequest
google.cloud.aiplatform_v1.types.DeleteTensorboardExperimentRequest
DeleteTensorboardExperimentRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.DeleteTensorboardExperiment.
See more: google.cloud.aiplatform_v1.types.DeleteTensorboardExperimentRequest
google.cloud.aiplatform_v1.types.DeleteTensorboardRequest
DeleteTensorboardRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.DeleteTensorboard.
See more: google.cloud.aiplatform_v1.types.DeleteTensorboardRequest
google.cloud.aiplatform_v1.types.DeleteTensorboardRunRequest
DeleteTensorboardRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.DeleteTensorboardRun.
See more: google.cloud.aiplatform_v1.types.DeleteTensorboardRunRequest
google.cloud.aiplatform_v1.types.DeleteTensorboardTimeSeriesRequest
DeleteTensorboardTimeSeriesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.DeleteTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1.types.DeleteTensorboardTimeSeriesRequest
google.cloud.aiplatform_v1.types.DeleteTrainingPipelineRequest
DeleteTrainingPipelineRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PipelineService.DeleteTrainingPipeline.
See more: google.cloud.aiplatform_v1.types.DeleteTrainingPipelineRequest
google.cloud.aiplatform_v1.types.DeleteTrialRequest
DeleteTrialRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.DeleteTrial.
See more: google.cloud.aiplatform_v1.types.DeleteTrialRequest
google.cloud.aiplatform_v1.types.DeployIndexOperationMetadata
DeployIndexOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for IndexEndpointService.DeployIndex.
See more: google.cloud.aiplatform_v1.types.DeployIndexOperationMetadata
google.cloud.aiplatform_v1.types.DeployIndexRequest
DeployIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.DeployIndex.
See more: google.cloud.aiplatform_v1.types.DeployIndexRequest
google.cloud.aiplatform_v1.types.DeployIndexResponse
DeployIndexResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexEndpointService.DeployIndex.
See more: google.cloud.aiplatform_v1.types.DeployIndexResponse
google.cloud.aiplatform_v1.types.DeployModelOperationMetadata
DeployModelOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for EndpointService.DeployModel.
See more: google.cloud.aiplatform_v1.types.DeployModelOperationMetadata
google.cloud.aiplatform_v1.types.DeployModelRequest
DeployModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.DeployModel.
See more: google.cloud.aiplatform_v1.types.DeployModelRequest
google.cloud.aiplatform_v1.types.DeployModelRequest.TrafficSplitEntry
TrafficSplitEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.DeployModelRequest.TrafficSplitEntry
google.cloud.aiplatform_v1.types.DeployModelResponse
DeployModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for EndpointService.DeployModel.
See more: google.cloud.aiplatform_v1.types.DeployModelResponse
google.cloud.aiplatform_v1.types.DeployedIndex
DeployedIndex(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A deployment of an Index.
google.cloud.aiplatform_v1.types.DeployedIndexAuthConfig
DeployedIndexAuthConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Used to set up the auth on the DeployedIndex's private endpoint.
See more: google.cloud.aiplatform_v1.types.DeployedIndexAuthConfig
google.cloud.aiplatform_v1.types.DeployedIndexAuthConfig.AuthProvider
AuthProvider(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for an authentication provider, including support for
JSON Web Token
(JWT) <https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32>
__.
See more: google.cloud.aiplatform_v1.types.DeployedIndexAuthConfig.AuthProvider
google.cloud.aiplatform_v1.types.DeployedIndexRef
DeployedIndexRef(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Points to a DeployedIndex.
google.cloud.aiplatform_v1.types.DeployedModel
DeployedModel(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A deployment of a Model.
google.cloud.aiplatform_v1.types.DeployedModelRef
DeployedModelRef(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Points to a DeployedModel.
google.cloud.aiplatform_v1.types.DeploymentResourcePool
DeploymentResourcePool(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources.
See more: google.cloud.aiplatform_v1.types.DeploymentResourcePool
google.cloud.aiplatform_v1.types.DestinationFeatureSetting
DestinationFeatureSetting(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform_v1.types.DirectPredictRequest
DirectPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.DirectPredict.
See more: google.cloud.aiplatform_v1.types.DirectPredictRequest
google.cloud.aiplatform_v1.types.DirectPredictResponse
DirectPredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.DirectPredict.
See more: google.cloud.aiplatform_v1.types.DirectPredictResponse
google.cloud.aiplatform_v1.types.DirectRawPredictRequest
DirectRawPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.DirectRawPredict.
See more: google.cloud.aiplatform_v1.types.DirectRawPredictRequest
google.cloud.aiplatform_v1.types.DirectRawPredictResponse
DirectRawPredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.DirectRawPredict.
See more: google.cloud.aiplatform_v1.types.DirectRawPredictResponse
google.cloud.aiplatform_v1.types.DiskSpec
DiskSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of disk options.
google.cloud.aiplatform_v1.types.DoubleArray
DoubleArray(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of double values.
google.cloud.aiplatform_v1.types.EncryptionSpec
EncryptionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a customer-managed encryption key spec that can be applied to a top-level resource.
google.cloud.aiplatform_v1.types.Endpoint
Endpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
google.cloud.aiplatform_v1.types.Endpoint.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Endpoint.LabelsEntry
google.cloud.aiplatform_v1.types.Endpoint.TrafficSplitEntry
TrafficSplitEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Endpoint.TrafficSplitEntry
google.cloud.aiplatform_v1.types.EntityIdSelector
EntityIdSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Selector for entityId.
google.cloud.aiplatform_v1.types.EntityType
EntityType(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An entity type is a type of object in a system that needs to be modeled and have stored information about.
google.cloud.aiplatform_v1.types.EntityType.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.EntityType.LabelsEntry
google.cloud.aiplatform_v1.types.EnvVar
EnvVar(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents an environment variable present in a Container or Python Module.
See more: google.cloud.aiplatform_v1.types.EnvVar
google.cloud.aiplatform_v1.types.ErrorAnalysisAnnotation
ErrorAnalysisAnnotation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Model error analysis for each annotation.
See more: google.cloud.aiplatform_v1.types.ErrorAnalysisAnnotation
google.cloud.aiplatform_v1.types.ErrorAnalysisAnnotation.AttributedItem
AttributedItem(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Attributed items for a given annotation, typically representing neighbors from the training sets constrained by the query type.
See more: google.cloud.aiplatform_v1.types.ErrorAnalysisAnnotation.AttributedItem
google.cloud.aiplatform_v1.types.ErrorAnalysisAnnotation.QueryType
QueryType(value)
The query type used for finding the attributed items.
See more: google.cloud.aiplatform_v1.types.ErrorAnalysisAnnotation.QueryType
google.cloud.aiplatform_v1.types.EvaluatedAnnotation
EvaluatedAnnotation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
True positive, false positive, or false negative.
See more: google.cloud.aiplatform_v1.types.EvaluatedAnnotation
google.cloud.aiplatform_v1.types.EvaluatedAnnotation.EvaluatedAnnotationType
EvaluatedAnnotationType(value)
Describes the type of the EvaluatedAnnotation.
See more: google.cloud.aiplatform_v1.types.EvaluatedAnnotation.EvaluatedAnnotationType
google.cloud.aiplatform_v1.types.EvaluatedAnnotationExplanation
EvaluatedAnnotationExplanation(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Explanation result of the prediction produced by the Model.
See more: google.cloud.aiplatform_v1.types.EvaluatedAnnotationExplanation
google.cloud.aiplatform_v1.types.Event
Event(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An edge describing the relationship between an Artifact and an Execution in a lineage graph.
See more: google.cloud.aiplatform_v1.types.Event
google.cloud.aiplatform_v1.types.Event.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Event.LabelsEntry
google.cloud.aiplatform_v1.types.Event.Type
Type(value)
Describes whether an Event's Artifact is the Execution's input or output.
google.cloud.aiplatform_v1.types.Examples
Examples(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Example-based explainability that returns the nearest neighbors from the provided dataset.
google.cloud.aiplatform_v1.types.Examples.ExampleGcsSource
ExampleGcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The Cloud Storage input instances.
See more: google.cloud.aiplatform_v1.types.Examples.ExampleGcsSource
google.cloud.aiplatform_v1.types.Examples.ExampleGcsSource.DataFormat
DataFormat(value)
The format of the input example instances.
See more: google.cloud.aiplatform_v1.types.Examples.ExampleGcsSource.DataFormat
google.cloud.aiplatform_v1.types.ExamplesOverride
ExamplesOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Overrides for example-based explanations.
google.cloud.aiplatform_v1.types.ExamplesOverride.DataFormat
DataFormat(value)
Data format enum.
See more: google.cloud.aiplatform_v1.types.ExamplesOverride.DataFormat
google.cloud.aiplatform_v1.types.ExamplesRestrictionsNamespace
ExamplesRestrictionsNamespace(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Restrictions namespace for example-based explanations overrides.
See more: google.cloud.aiplatform_v1.types.ExamplesRestrictionsNamespace
google.cloud.aiplatform_v1.types.Execution
Execution(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Instance of a general execution.
google.cloud.aiplatform_v1.types.Execution.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Execution.LabelsEntry
google.cloud.aiplatform_v1.types.Execution.State
State(value)
Describes the state of the Execution.
google.cloud.aiplatform_v1.types.ExplainRequest
ExplainRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.Explain.
google.cloud.aiplatform_v1.types.ExplainResponse
ExplainResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.Explain.
google.cloud.aiplatform_v1.types.Explanation
Explanation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Explanation of a prediction (provided in PredictResponse.predictions) produced by the Model on a given instance.
google.cloud.aiplatform_v1.types.ExplanationMetadata
ExplanationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata describing the Model's input and output for explanation.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadata
google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata
InputMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata of the input of a feature.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata
google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.Encoding
Encoding(value)
Defines how a feature is encoded.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.Encoding
google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.FeatureValueDomain
FeatureValueDomain(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Domain details of the input feature value.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.FeatureValueDomain
google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.Visualization
Visualization(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Visualization configurations for image explanation.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.Visualization
google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.Visualization.ColorMap
ColorMap(value)
The color scheme used for highlighting areas.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.Visualization.ColorMap
google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.Visualization.OverlayType
OverlayType(value)
How the original image is displayed in the visualization.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.Visualization.OverlayType
google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.Visualization.Polarity
Polarity(value)
Whether to only highlight pixels with positive contributions, negative or both.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.Visualization.Polarity
google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.Visualization.Type
Type(value)
Type of the image visualization.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadata.InputMetadata.Visualization.Type
google.cloud.aiplatform_v1.types.ExplanationMetadata.InputsEntry
InputsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadata.InputsEntry
google.cloud.aiplatform_v1.types.ExplanationMetadata.OutputMetadata
OutputMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata of the prediction output to be explained.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadata.OutputMetadata
google.cloud.aiplatform_v1.types.ExplanationMetadata.OutputsEntry
OutputsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadata.OutputsEntry
google.cloud.aiplatform_v1.types.ExplanationMetadataOverride
ExplanationMetadataOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The ExplanationMetadata entries that can be overridden at [online explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadataOverride
google.cloud.aiplatform_v1.types.ExplanationMetadataOverride.InputMetadataOverride
InputMetadataOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The [input metadata][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata] entries to be overridden.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadataOverride.InputMetadataOverride
google.cloud.aiplatform_v1.types.ExplanationMetadataOverride.InputsEntry
InputsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.ExplanationMetadataOverride.InputsEntry
google.cloud.aiplatform_v1.types.ExplanationParameters
ExplanationParameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Parameters to configure explaining for Model's predictions.
See more: google.cloud.aiplatform_v1.types.ExplanationParameters
google.cloud.aiplatform_v1.types.ExplanationSpec
ExplanationSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specification of Model explanation.
google.cloud.aiplatform_v1.types.ExplanationSpecOverride
ExplanationSpecOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The ExplanationSpec entries that can be overridden at [online explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.
See more: google.cloud.aiplatform_v1.types.ExplanationSpecOverride
google.cloud.aiplatform_v1.types.ExportDataConfig
ExportDataConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes what part of the Dataset is to be exported, the destination of the export and how to export.
google.cloud.aiplatform_v1.types.ExportDataConfig.ExportUse
ExportUse(value)
ExportUse indicates the usage of the exported files.
See more: google.cloud.aiplatform_v1.types.ExportDataConfig.ExportUse
google.cloud.aiplatform_v1.types.ExportDataOperationMetadata
ExportDataOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Runtime operation information for DatasetService.ExportData.
See more: google.cloud.aiplatform_v1.types.ExportDataOperationMetadata
google.cloud.aiplatform_v1.types.ExportDataRequest
ExportDataRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ExportData.
See more: google.cloud.aiplatform_v1.types.ExportDataRequest
google.cloud.aiplatform_v1.types.ExportDataResponse
ExportDataResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ExportData.
See more: google.cloud.aiplatform_v1.types.ExportDataResponse
google.cloud.aiplatform_v1.types.ExportFeatureValuesOperationMetadata
ExportFeatureValuesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that exports Features values.
See more: google.cloud.aiplatform_v1.types.ExportFeatureValuesOperationMetadata
google.cloud.aiplatform_v1.types.ExportFeatureValuesRequest
ExportFeatureValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.ExportFeatureValues.
See more: google.cloud.aiplatform_v1.types.ExportFeatureValuesRequest
google.cloud.aiplatform_v1.types.ExportFeatureValuesRequest.FullExport
FullExport(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes exporting all historical Feature values of all entities of the EntityType between [start_time, end_time].
See more: google.cloud.aiplatform_v1.types.ExportFeatureValuesRequest.FullExport
google.cloud.aiplatform_v1.types.ExportFeatureValuesRequest.SnapshotExport
SnapshotExport(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes exporting the latest Feature values of all entities of the EntityType between [start_time, snapshot_time].
See more: google.cloud.aiplatform_v1.types.ExportFeatureValuesRequest.SnapshotExport
google.cloud.aiplatform_v1.types.ExportFeatureValuesResponse
ExportFeatureValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.ExportFeatureValues.
See more: google.cloud.aiplatform_v1.types.ExportFeatureValuesResponse
google.cloud.aiplatform_v1.types.ExportFilterSplit
ExportFilterSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored.
See more: google.cloud.aiplatform_v1.types.ExportFilterSplit
google.cloud.aiplatform_v1.types.ExportFractionSplit
ExportFractionSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns the input data to training, validation, and test sets as per the given fractions.
See more: google.cloud.aiplatform_v1.types.ExportFractionSplit
google.cloud.aiplatform_v1.types.ExportModelOperationMetadata
ExportModelOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of ModelService.ExportModel operation.
See more: google.cloud.aiplatform_v1.types.ExportModelOperationMetadata
google.cloud.aiplatform_v1.types.ExportModelOperationMetadata.OutputInfo
OutputInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Further describes the output of the ExportModel.
See more: google.cloud.aiplatform_v1.types.ExportModelOperationMetadata.OutputInfo
google.cloud.aiplatform_v1.types.ExportModelRequest
ExportModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.ExportModel.
See more: google.cloud.aiplatform_v1.types.ExportModelRequest
google.cloud.aiplatform_v1.types.ExportModelRequest.OutputConfig
OutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Output configuration for the Model export.
See more: google.cloud.aiplatform_v1.types.ExportModelRequest.OutputConfig
google.cloud.aiplatform_v1.types.ExportModelResponse
ExportModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message of ModelService.ExportModel operation.
See more: google.cloud.aiplatform_v1.types.ExportModelResponse
google.cloud.aiplatform_v1.types.ExportTensorboardTimeSeriesDataRequest
ExportTensorboardTimeSeriesDataRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.ExportTensorboardTimeSeriesData.
See more: google.cloud.aiplatform_v1.types.ExportTensorboardTimeSeriesDataRequest
google.cloud.aiplatform_v1.types.ExportTensorboardTimeSeriesDataResponse
ExportTensorboardTimeSeriesDataResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.ExportTensorboardTimeSeriesData.
See more: google.cloud.aiplatform_v1.types.ExportTensorboardTimeSeriesDataResponse
google.cloud.aiplatform_v1.types.Feature
Feature(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Feature Metadata information.
See more: google.cloud.aiplatform_v1.types.Feature
google.cloud.aiplatform_v1.types.Feature.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Feature.LabelsEntry
google.cloud.aiplatform_v1.types.Feature.MonitoringStatsAnomaly
MonitoringStatsAnomaly(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.
See more: google.cloud.aiplatform_v1.types.Feature.MonitoringStatsAnomaly
google.cloud.aiplatform_v1.types.Feature.MonitoringStatsAnomaly.Objective
Objective(value)
If the objective in the request is both Import Feature Analysis and Snapshot Analysis, this objective could be one of them.
See more: google.cloud.aiplatform_v1.types.Feature.MonitoringStatsAnomaly.Objective
google.cloud.aiplatform_v1.types.Feature.ValueType
ValueType(value)
Only applicable for Vertex AI Legacy Feature Store.
See more: google.cloud.aiplatform_v1.types.Feature.ValueType
google.cloud.aiplatform_v1.types.FeatureGroup
FeatureGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Vertex AI Feature Group.
google.cloud.aiplatform_v1.types.FeatureGroup.BigQuery
BigQuery(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input source type for BigQuery Tables and Views.
See more: google.cloud.aiplatform_v1.types.FeatureGroup.BigQuery
google.cloud.aiplatform_v1.types.FeatureGroup.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.FeatureGroup.LabelsEntry
google.cloud.aiplatform_v1.types.FeatureNoiseSigma
FeatureNoiseSigma(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Noise sigma by features.
See more: google.cloud.aiplatform_v1.types.FeatureNoiseSigma
google.cloud.aiplatform_v1.types.FeatureNoiseSigma.NoiseSigmaForFeature
NoiseSigmaForFeature(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Noise sigma for a single feature.
See more: google.cloud.aiplatform_v1.types.FeatureNoiseSigma.NoiseSigmaForFeature
google.cloud.aiplatform_v1.types.FeatureOnlineStore
FeatureOnlineStore(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Vertex AI Feature Online Store provides a centralized repository for serving ML features and embedding indexes at low latency.
See more: google.cloud.aiplatform_v1.types.FeatureOnlineStore
google.cloud.aiplatform_v1.types.FeatureOnlineStore.Bigtable
Bigtable(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform_v1.types.FeatureOnlineStore.Bigtable.AutoScaling
AutoScaling(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform_v1.types.FeatureOnlineStore.DedicatedServingEndpoint
DedicatedServingEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The dedicated serving endpoint for this FeatureOnlineStore.
See more: google.cloud.aiplatform_v1.types.FeatureOnlineStore.DedicatedServingEndpoint
google.cloud.aiplatform_v1.types.FeatureOnlineStore.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.FeatureOnlineStore.LabelsEntry
google.cloud.aiplatform_v1.types.FeatureOnlineStore.Optimized
Optimized(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Optimized storage type.
See more: google.cloud.aiplatform_v1.types.FeatureOnlineStore.Optimized
google.cloud.aiplatform_v1.types.FeatureOnlineStore.State
State(value)
Possible states a featureOnlineStore can have.
See more: google.cloud.aiplatform_v1.types.FeatureOnlineStore.State
google.cloud.aiplatform_v1.types.FeatureSelector
FeatureSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Selector for Features of an EntityType.
google.cloud.aiplatform_v1.types.FeatureStatsAnomaly
FeatureStatsAnomaly(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Stats and Anomaly generated at specific timestamp for specific Feature.
See more: google.cloud.aiplatform_v1.types.FeatureStatsAnomaly
google.cloud.aiplatform_v1.types.FeatureValue
FeatureValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Value for a feature.
google.cloud.aiplatform_v1.types.FeatureValue.Metadata
Metadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata of feature value.
See more: google.cloud.aiplatform_v1.types.FeatureValue.Metadata
google.cloud.aiplatform_v1.types.FeatureValueDestination
FeatureValueDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A destination location for Feature values and format.
See more: google.cloud.aiplatform_v1.types.FeatureValueDestination
google.cloud.aiplatform_v1.types.FeatureValueList
FeatureValueList(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Container for list of values.
google.cloud.aiplatform_v1.types.FeatureView
FeatureView(mapping=None, *, ignore_unknown_fields=False, **kwargs)
FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.
google.cloud.aiplatform_v1.types.FeatureView.BigQuerySource
BigQuerySource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform_v1.types.FeatureView.FeatureRegistrySource
FeatureRegistrySource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A Feature Registry source for features that need to be synced to Online Store.
See more: google.cloud.aiplatform_v1.types.FeatureView.FeatureRegistrySource
google.cloud.aiplatform_v1.types.FeatureView.FeatureRegistrySource.FeatureGroup
FeatureGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Features belonging to a single feature group that will be synced to Online Store.
See more: google.cloud.aiplatform_v1.types.FeatureView.FeatureRegistrySource.FeatureGroup
google.cloud.aiplatform_v1.types.FeatureView.IndexConfig
IndexConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for vector indexing.
See more: google.cloud.aiplatform_v1.types.FeatureView.IndexConfig
google.cloud.aiplatform_v1.types.FeatureView.IndexConfig.BruteForceConfig
BruteForceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration options for using brute force search.
See more: google.cloud.aiplatform_v1.types.FeatureView.IndexConfig.BruteForceConfig
google.cloud.aiplatform_v1.types.FeatureView.IndexConfig.DistanceMeasureType
DistanceMeasureType(value)
The distance measure used in nearest neighbor search.
See more: google.cloud.aiplatform_v1.types.FeatureView.IndexConfig.DistanceMeasureType
google.cloud.aiplatform_v1.types.FeatureView.IndexConfig.TreeAHConfig
TreeAHConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration options for the tree-AH algorithm.
See more: google.cloud.aiplatform_v1.types.FeatureView.IndexConfig.TreeAHConfig
google.cloud.aiplatform_v1.types.FeatureView.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.FeatureView.LabelsEntry
google.cloud.aiplatform_v1.types.FeatureView.SyncConfig
SyncConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for Sync.
See more: google.cloud.aiplatform_v1.types.FeatureView.SyncConfig
google.cloud.aiplatform_v1.types.FeatureViewDataFormat
FeatureViewDataFormat(value)
Format of the data in the Feature View.
See more: google.cloud.aiplatform_v1.types.FeatureViewDataFormat
google.cloud.aiplatform_v1.types.FeatureViewDataKey
FeatureViewDataKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Lookup key for a feature view.
See more: google.cloud.aiplatform_v1.types.FeatureViewDataKey
google.cloud.aiplatform_v1.types.FeatureViewDataKey.CompositeKey
CompositeKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)
ID that is comprised from several parts (columns).
See more: google.cloud.aiplatform_v1.types.FeatureViewDataKey.CompositeKey
google.cloud.aiplatform_v1.types.FeatureViewSync
FeatureViewSync(mapping=None, *, ignore_unknown_fields=False, **kwargs)
FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store.
google.cloud.aiplatform_v1.types.FeatureViewSync.SyncSummary
SyncSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Summary from the Sync job.
See more: google.cloud.aiplatform_v1.types.FeatureViewSync.SyncSummary
google.cloud.aiplatform_v1.types.Featurestore
Featurestore(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Vertex AI Feature Store provides a centralized repository for organizing, storing, and serving ML features.
google.cloud.aiplatform_v1.types.Featurestore.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Featurestore.LabelsEntry
google.cloud.aiplatform_v1.types.Featurestore.OnlineServingConfig
OnlineServingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
OnlineServingConfig specifies the details for provisioning online serving resources.
See more: google.cloud.aiplatform_v1.types.Featurestore.OnlineServingConfig
google.cloud.aiplatform_v1.types.Featurestore.OnlineServingConfig.Scaling
Scaling(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Online serving scaling configuration.
See more: google.cloud.aiplatform_v1.types.Featurestore.OnlineServingConfig.Scaling
google.cloud.aiplatform_v1.types.Featurestore.State
State(value)
Possible states a featurestore can have.
See more: google.cloud.aiplatform_v1.types.Featurestore.State
google.cloud.aiplatform_v1.types.FeaturestoreMonitoringConfig
FeaturestoreMonitoringConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Configuration of how features in Featurestore are monitored.
See more: google.cloud.aiplatform_v1.types.FeaturestoreMonitoringConfig
google.cloud.aiplatform_v1.types.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis
ImportFeaturesAnalysis(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration of the Featurestore's ImportFeature Analysis Based Monitoring.
See more: google.cloud.aiplatform_v1.types.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis
google.cloud.aiplatform_v1.types.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis.Baseline
Baseline(value)
Defines the baseline to do anomaly detection for feature values imported by each ImportFeatureValues operation.
See more: google.cloud.aiplatform_v1.types.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis.Baseline
google.cloud.aiplatform_v1.types.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis.State
State(value)
The state defines whether to enable ImportFeature analysis.
See more: google.cloud.aiplatform_v1.types.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis.State
google.cloud.aiplatform_v1.types.FeaturestoreMonitoringConfig.SnapshotAnalysis
SnapshotAnalysis(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration of the Featurestore's Snapshot Analysis Based Monitoring.
See more: google.cloud.aiplatform_v1.types.FeaturestoreMonitoringConfig.SnapshotAnalysis
google.cloud.aiplatform_v1.types.FeaturestoreMonitoringConfig.ThresholdConfig
ThresholdConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The config for Featurestore Monitoring threshold.
See more: google.cloud.aiplatform_v1.types.FeaturestoreMonitoringConfig.ThresholdConfig
google.cloud.aiplatform_v1.types.FetchFeatureValuesRequest
FetchFeatureValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreService.FetchFeatureValues.
See more: google.cloud.aiplatform_v1.types.FetchFeatureValuesRequest
google.cloud.aiplatform_v1.types.FetchFeatureValuesResponse
FetchFeatureValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeatureOnlineStoreService.FetchFeatureValues.
See more: google.cloud.aiplatform_v1.types.FetchFeatureValuesResponse
google.cloud.aiplatform_v1.types.FetchFeatureValuesResponse.FeatureNameValuePairList
FeatureNameValuePairList(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response structure in the format of key (feature name) and (feature) value pair.
See more: google.cloud.aiplatform_v1.types.FetchFeatureValuesResponse.FeatureNameValuePairList
google.cloud.aiplatform_v1.types.FetchFeatureValuesResponse.FeatureNameValuePairList.FeatureNameValuePair
FeatureNameValuePair(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Feature name & value pair.
google.cloud.aiplatform_v1.types.FileData
FileData(mapping=None, *, ignore_unknown_fields=False, **kwargs)
URI based data.
google.cloud.aiplatform_v1.types.FilterSplit
FilterSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored.
google.cloud.aiplatform_v1.types.FindNeighborsRequest
FindNeighborsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The request message for MatchService.FindNeighbors.
See more: google.cloud.aiplatform_v1.types.FindNeighborsRequest
google.cloud.aiplatform_v1.types.FindNeighborsRequest.Query
Query(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A query to find a number of the nearest neighbors (most similar vectors) of a vector.
See more: google.cloud.aiplatform_v1.types.FindNeighborsRequest.Query
google.cloud.aiplatform_v1.types.FindNeighborsResponse
FindNeighborsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The response message for MatchService.FindNeighbors.
See more: google.cloud.aiplatform_v1.types.FindNeighborsResponse
google.cloud.aiplatform_v1.types.FindNeighborsResponse.NearestNeighbors
NearestNeighbors(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Nearest neighbors for one query.
See more: google.cloud.aiplatform_v1.types.FindNeighborsResponse.NearestNeighbors
google.cloud.aiplatform_v1.types.FindNeighborsResponse.Neighbor
Neighbor(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A neighbor of the query vector.
See more: google.cloud.aiplatform_v1.types.FindNeighborsResponse.Neighbor
google.cloud.aiplatform_v1.types.FractionSplit
FractionSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns the input data to training, validation, and test sets as per the given fractions.
google.cloud.aiplatform_v1.types.FunctionCall
FunctionCall(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.
google.cloud.aiplatform_v1.types.FunctionDeclaration
FunctionDeclaration(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Structured representation of a function declaration as defined by
the OpenAPI 3.0
specification <https://spec.openapis.org/oas/v3.0.3>
__.
See more: google.cloud.aiplatform_v1.types.FunctionDeclaration
google.cloud.aiplatform_v1.types.FunctionResponse
FunctionResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model.
google.cloud.aiplatform_v1.types.GcsDestination
GcsDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The Google Cloud Storage location where the output is to be written to.
google.cloud.aiplatform_v1.types.GcsSource
GcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The Google Cloud Storage location for the input content.
google.cloud.aiplatform_v1.types.GenerateContentRequest
GenerateContentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for [PredictionService.GenerateContent].
See more: google.cloud.aiplatform_v1.types.GenerateContentRequest
google.cloud.aiplatform_v1.types.GenerateContentResponse
GenerateContentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for [PredictionService.GenerateContent].
See more: google.cloud.aiplatform_v1.types.GenerateContentResponse
google.cloud.aiplatform_v1.types.GenerateContentResponse.PromptFeedback
PromptFeedback(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Content filter results for a prompt sent in the request.
See more: google.cloud.aiplatform_v1.types.GenerateContentResponse.PromptFeedback
google.cloud.aiplatform_v1.types.GenerateContentResponse.PromptFeedback.BlockedReason
BlockedReason(value)
Blocked reason enumeration.
See more: google.cloud.aiplatform_v1.types.GenerateContentResponse.PromptFeedback.BlockedReason
google.cloud.aiplatform_v1.types.GenerateContentResponse.UsageMetadata
UsageMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Usage metadata about response(s).
See more: google.cloud.aiplatform_v1.types.GenerateContentResponse.UsageMetadata
google.cloud.aiplatform_v1.types.GenerationConfig
GenerationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Generation config.
google.cloud.aiplatform_v1.types.GenericOperationMetadata
GenericOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Generic Metadata shared by all operations.
See more: google.cloud.aiplatform_v1.types.GenericOperationMetadata
google.cloud.aiplatform_v1.types.GenieSource
GenieSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains information about the source of the models generated from Generative AI Studio.
google.cloud.aiplatform_v1.types.GetAnnotationSpecRequest
GetAnnotationSpecRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.GetAnnotationSpec.
See more: google.cloud.aiplatform_v1.types.GetAnnotationSpecRequest
google.cloud.aiplatform_v1.types.GetArtifactRequest
GetArtifactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.GetArtifact.
See more: google.cloud.aiplatform_v1.types.GetArtifactRequest
google.cloud.aiplatform_v1.types.GetBatchPredictionJobRequest
GetBatchPredictionJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.GetBatchPredictionJob.
See more: google.cloud.aiplatform_v1.types.GetBatchPredictionJobRequest
google.cloud.aiplatform_v1.types.GetContextRequest
GetContextRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.GetContext.
See more: google.cloud.aiplatform_v1.types.GetContextRequest
google.cloud.aiplatform_v1.types.GetCustomJobRequest
GetCustomJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.GetCustomJob.
See more: google.cloud.aiplatform_v1.types.GetCustomJobRequest
google.cloud.aiplatform_v1.types.GetDataLabelingJobRequest
GetDataLabelingJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.GetDataLabelingJob.
See more: google.cloud.aiplatform_v1.types.GetDataLabelingJobRequest
google.cloud.aiplatform_v1.types.GetDatasetRequest
GetDatasetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.GetDataset.
See more: google.cloud.aiplatform_v1.types.GetDatasetRequest
google.cloud.aiplatform_v1.types.GetDatasetVersionRequest
GetDatasetVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.GetDatasetVersion.
See more: google.cloud.aiplatform_v1.types.GetDatasetVersionRequest
google.cloud.aiplatform_v1.types.GetDeploymentResourcePoolRequest
GetDeploymentResourcePoolRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for GetDeploymentResourcePool method.
See more: google.cloud.aiplatform_v1.types.GetDeploymentResourcePoolRequest
google.cloud.aiplatform_v1.types.GetEndpointRequest
GetEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.GetEndpoint .
See more: google.cloud.aiplatform_v1.types.GetEndpointRequest
google.cloud.aiplatform_v1.types.GetEntityTypeRequest
GetEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.GetEntityType.
See more: google.cloud.aiplatform_v1.types.GetEntityTypeRequest
google.cloud.aiplatform_v1.types.GetExecutionRequest
GetExecutionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.GetExecution.
See more: google.cloud.aiplatform_v1.types.GetExecutionRequest
google.cloud.aiplatform_v1.types.GetFeatureGroupRequest
GetFeatureGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureRegistryService.GetFeatureGroup.
See more: google.cloud.aiplatform_v1.types.GetFeatureGroupRequest
google.cloud.aiplatform_v1.types.GetFeatureOnlineStoreRequest
GetFeatureOnlineStoreRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeatureOnlineStoreAdminService.GetFeatureOnlineStore.
See more: google.cloud.aiplatform_v1.types.GetFeatureOnlineStoreRequest
google.cloud.aiplatform_v1.types.GetFeatureRequest
GetFeatureRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.GetFeature.
See more: google.cloud.aiplatform_v1.types.GetFeatureRequest
google.cloud.aiplatform_v1.types.GetFeatureViewRequest
GetFeatureViewRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.GetFeatureView.
See more: google.cloud.aiplatform_v1.types.GetFeatureViewRequest
google.cloud.aiplatform_v1.types.GetFeatureViewSyncRequest
GetFeatureViewSyncRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.GetFeatureViewSync.
See more: google.cloud.aiplatform_v1.types.GetFeatureViewSyncRequest
google.cloud.aiplatform_v1.types.GetFeaturestoreRequest
GetFeaturestoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.GetFeaturestore.
See more: google.cloud.aiplatform_v1.types.GetFeaturestoreRequest
google.cloud.aiplatform_v1.types.GetHyperparameterTuningJobRequest
GetHyperparameterTuningJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.GetHyperparameterTuningJob.
See more: google.cloud.aiplatform_v1.types.GetHyperparameterTuningJobRequest
google.cloud.aiplatform_v1.types.GetIndexEndpointRequest
GetIndexEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.GetIndexEndpoint .
See more: google.cloud.aiplatform_v1.types.GetIndexEndpointRequest
google.cloud.aiplatform_v1.types.GetIndexRequest
GetIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.GetIndex .
google.cloud.aiplatform_v1.types.GetMetadataSchemaRequest
GetMetadataSchemaRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.GetMetadataSchema.
See more: google.cloud.aiplatform_v1.types.GetMetadataSchemaRequest
google.cloud.aiplatform_v1.types.GetMetadataStoreRequest
GetMetadataStoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.GetMetadataStore.
See more: google.cloud.aiplatform_v1.types.GetMetadataStoreRequest
google.cloud.aiplatform_v1.types.GetModelDeploymentMonitoringJobRequest
GetModelDeploymentMonitoringJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.GetModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1.types.GetModelDeploymentMonitoringJobRequest
google.cloud.aiplatform_v1.types.GetModelEvaluationRequest
GetModelEvaluationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.GetModelEvaluation.
See more: google.cloud.aiplatform_v1.types.GetModelEvaluationRequest
google.cloud.aiplatform_v1.types.GetModelEvaluationSliceRequest
GetModelEvaluationSliceRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ModelService.GetModelEvaluationSlice.
See more: google.cloud.aiplatform_v1.types.GetModelEvaluationSliceRequest
google.cloud.aiplatform_v1.types.GetModelRequest
GetModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.GetModel.
google.cloud.aiplatform_v1.types.GetNasJobRequest
GetNasJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.GetNasJob.
google.cloud.aiplatform_v1.types.GetNasTrialDetailRequest
GetNasTrialDetailRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.GetNasTrialDetail.
See more: google.cloud.aiplatform_v1.types.GetNasTrialDetailRequest
google.cloud.aiplatform_v1.types.GetNotebookRuntimeRequest
GetNotebookRuntimeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for NotebookService.GetNotebookRuntime .
See more: google.cloud.aiplatform_v1.types.GetNotebookRuntimeRequest
google.cloud.aiplatform_v1.types.GetNotebookRuntimeTemplateRequest
GetNotebookRuntimeTemplateRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.GetNotebookRuntimeTemplate .
See more: google.cloud.aiplatform_v1.types.GetNotebookRuntimeTemplateRequest
google.cloud.aiplatform_v1.types.GetPersistentResourceRequest
GetPersistentResourceRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PersistentResourceService.GetPersistentResource.
See more: google.cloud.aiplatform_v1.types.GetPersistentResourceRequest
google.cloud.aiplatform_v1.types.GetPipelineJobRequest
GetPipelineJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PipelineService.GetPipelineJob.
See more: google.cloud.aiplatform_v1.types.GetPipelineJobRequest
google.cloud.aiplatform_v1.types.GetPublisherModelRequest
GetPublisherModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelGardenService.GetPublisherModel .
See more: google.cloud.aiplatform_v1.types.GetPublisherModelRequest
google.cloud.aiplatform_v1.types.GetScheduleRequest
GetScheduleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.GetSchedule.
See more: google.cloud.aiplatform_v1.types.GetScheduleRequest
google.cloud.aiplatform_v1.types.GetSpecialistPoolRequest
GetSpecialistPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for SpecialistPoolService.GetSpecialistPool.
See more: google.cloud.aiplatform_v1.types.GetSpecialistPoolRequest
google.cloud.aiplatform_v1.types.GetStudyRequest
GetStudyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.GetStudy.
google.cloud.aiplatform_v1.types.GetTensorboardExperimentRequest
GetTensorboardExperimentRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.GetTensorboardExperiment.
See more: google.cloud.aiplatform_v1.types.GetTensorboardExperimentRequest
google.cloud.aiplatform_v1.types.GetTensorboardRequest
GetTensorboardRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.GetTensorboard.
See more: google.cloud.aiplatform_v1.types.GetTensorboardRequest
google.cloud.aiplatform_v1.types.GetTensorboardRunRequest
GetTensorboardRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.GetTensorboardRun.
See more: google.cloud.aiplatform_v1.types.GetTensorboardRunRequest
google.cloud.aiplatform_v1.types.GetTensorboardTimeSeriesRequest
GetTensorboardTimeSeriesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.GetTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1.types.GetTensorboardTimeSeriesRequest
google.cloud.aiplatform_v1.types.GetTrainingPipelineRequest
GetTrainingPipelineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PipelineService.GetTrainingPipeline.
See more: google.cloud.aiplatform_v1.types.GetTrainingPipelineRequest
google.cloud.aiplatform_v1.types.GetTrialRequest
GetTrialRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.GetTrial.
google.cloud.aiplatform_v1.types.GetTuningJobRequest
GetTuningJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for GenAiTuningService.GetTuningJob.
See more: google.cloud.aiplatform_v1.types.GetTuningJobRequest
google.cloud.aiplatform_v1.types.GoogleSearchRetrieval
GoogleSearchRetrieval(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tool to retrieve public web data for grounding, powered by Google.
See more: google.cloud.aiplatform_v1.types.GoogleSearchRetrieval
google.cloud.aiplatform_v1.types.GroundingAttribution
GroundingAttribution(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Grounding attribution.
See more: google.cloud.aiplatform_v1.types.GroundingAttribution
google.cloud.aiplatform_v1.types.GroundingAttribution.Web
Web(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Attribution from the web.
See more: google.cloud.aiplatform_v1.types.GroundingAttribution.Web
google.cloud.aiplatform_v1.types.GroundingMetadata
GroundingMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata returned to client when grounding is enabled.
See more: google.cloud.aiplatform_v1.types.GroundingMetadata
google.cloud.aiplatform_v1.types.HarmCategory
HarmCategory(value)
Harm categories that will block the content.
google.cloud.aiplatform_v1.types.HyperparameterTuningJob
HyperparameterTuningJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a HyperparameterTuningJob.
See more: google.cloud.aiplatform_v1.types.HyperparameterTuningJob
google.cloud.aiplatform_v1.types.HyperparameterTuningJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.HyperparameterTuningJob.LabelsEntry
google.cloud.aiplatform_v1.types.IdMatcher
IdMatcher(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Matcher for Features of an EntityType by Feature ID.
google.cloud.aiplatform_v1.types.ImportDataConfig
ImportDataConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes the location from where we import data into a Dataset, together with the labels that will be applied to the DataItems and the Annotations.
google.cloud.aiplatform_v1.types.ImportDataConfig.AnnotationLabelsEntry
AnnotationLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.ImportDataConfig.AnnotationLabelsEntry
google.cloud.aiplatform_v1.types.ImportDataConfig.DataItemLabelsEntry
DataItemLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.ImportDataConfig.DataItemLabelsEntry
google.cloud.aiplatform_v1.types.ImportDataOperationMetadata
ImportDataOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Runtime operation information for DatasetService.ImportData.
See more: google.cloud.aiplatform_v1.types.ImportDataOperationMetadata
google.cloud.aiplatform_v1.types.ImportDataRequest
ImportDataRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ImportData.
See more: google.cloud.aiplatform_v1.types.ImportDataRequest
google.cloud.aiplatform_v1.types.ImportDataResponse
ImportDataResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ImportData.
See more: google.cloud.aiplatform_v1.types.ImportDataResponse
google.cloud.aiplatform_v1.types.ImportFeatureValuesOperationMetadata
ImportFeatureValuesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform import Feature values.
See more: google.cloud.aiplatform_v1.types.ImportFeatureValuesOperationMetadata
google.cloud.aiplatform_v1.types.ImportFeatureValuesRequest
ImportFeatureValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.ImportFeatureValues.
See more: google.cloud.aiplatform_v1.types.ImportFeatureValuesRequest
google.cloud.aiplatform_v1.types.ImportFeatureValuesRequest.FeatureSpec
FeatureSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Defines the Feature value(s) to import.
See more: google.cloud.aiplatform_v1.types.ImportFeatureValuesRequest.FeatureSpec
google.cloud.aiplatform_v1.types.ImportFeatureValuesResponse
ImportFeatureValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.ImportFeatureValues.
See more: google.cloud.aiplatform_v1.types.ImportFeatureValuesResponse
google.cloud.aiplatform_v1.types.ImportModelEvaluationRequest
ImportModelEvaluationRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ModelService.ImportModelEvaluation .
See more: google.cloud.aiplatform_v1.types.ImportModelEvaluationRequest
google.cloud.aiplatform_v1.types.Index
Index(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.
See more: google.cloud.aiplatform_v1.types.Index
google.cloud.aiplatform_v1.types.Index.IndexUpdateMethod
IndexUpdateMethod(value)
The update method of an Index.
See more: google.cloud.aiplatform_v1.types.Index.IndexUpdateMethod
google.cloud.aiplatform_v1.types.Index.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Index.LabelsEntry
google.cloud.aiplatform_v1.types.IndexDatapoint
IndexDatapoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A datapoint of Index.
google.cloud.aiplatform_v1.types.IndexDatapoint.CrowdingTag
CrowdingTag(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Crowding tag is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute.
See more: google.cloud.aiplatform_v1.types.IndexDatapoint.CrowdingTag
google.cloud.aiplatform_v1.types.IndexDatapoint.NumericRestriction
NumericRestriction(mapping=None, *, ignore_unknown_fields=False, **kwargs)
This field allows restricts to be based on numeric comparisons rather than categorical tokens.
See more: google.cloud.aiplatform_v1.types.IndexDatapoint.NumericRestriction
google.cloud.aiplatform_v1.types.IndexDatapoint.NumericRestriction.Operator
Operator(value)
Which comparison operator to use.
See more: google.cloud.aiplatform_v1.types.IndexDatapoint.NumericRestriction.Operator
google.cloud.aiplatform_v1.types.IndexDatapoint.Restriction
Restriction(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Restriction of a datapoint which describe its attributes(tokens) from each of several attribute categories(namespaces).
See more: google.cloud.aiplatform_v1.types.IndexDatapoint.Restriction
google.cloud.aiplatform_v1.types.IndexEndpoint
IndexEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Indexes are deployed into it.
google.cloud.aiplatform_v1.types.IndexEndpoint.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.IndexEndpoint.LabelsEntry
google.cloud.aiplatform_v1.types.IndexPrivateEndpoints
IndexPrivateEndpoints(mapping=None, *, ignore_unknown_fields=False, **kwargs)
IndexPrivateEndpoints proto is used to provide paths for users to send requests via private endpoints (e.g.
See more: google.cloud.aiplatform_v1.types.IndexPrivateEndpoints
google.cloud.aiplatform_v1.types.IndexStats
IndexStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Stats of the Index.
google.cloud.aiplatform_v1.types.InputDataConfig
InputDataConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model.
google.cloud.aiplatform_v1.types.Int64Array
Int64Array(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of int64 values.
google.cloud.aiplatform_v1.types.IntegratedGradientsAttribution
IntegratedGradientsAttribution(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure.
See more: google.cloud.aiplatform_v1.types.IntegratedGradientsAttribution
google.cloud.aiplatform_v1.types.JobState
JobState(value)
Describes the state of a job.
google.cloud.aiplatform_v1.types.LargeModelReference
LargeModelReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains information about the Large Model.
See more: google.cloud.aiplatform_v1.types.LargeModelReference
google.cloud.aiplatform_v1.types.LineageSubgraph
LineageSubgraph(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A subgraph of the overall lineage graph.
google.cloud.aiplatform_v1.types.ListAnnotationsRequest
ListAnnotationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ListAnnotations.
See more: google.cloud.aiplatform_v1.types.ListAnnotationsRequest
google.cloud.aiplatform_v1.types.ListAnnotationsResponse
ListAnnotationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ListAnnotations.
See more: google.cloud.aiplatform_v1.types.ListAnnotationsResponse
google.cloud.aiplatform_v1.types.ListArtifactsRequest
ListArtifactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.ListArtifacts.
See more: google.cloud.aiplatform_v1.types.ListArtifactsRequest
google.cloud.aiplatform_v1.types.ListArtifactsResponse
ListArtifactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.ListArtifacts.
See more: google.cloud.aiplatform_v1.types.ListArtifactsResponse
google.cloud.aiplatform_v1.types.ListBatchPredictionJobsRequest
ListBatchPredictionJobsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.ListBatchPredictionJobs.
See more: google.cloud.aiplatform_v1.types.ListBatchPredictionJobsRequest
google.cloud.aiplatform_v1.types.ListBatchPredictionJobsResponse
ListBatchPredictionJobsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for JobService.ListBatchPredictionJobs .
See more: google.cloud.aiplatform_v1.types.ListBatchPredictionJobsResponse
google.cloud.aiplatform_v1.types.ListContextsRequest
ListContextsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.ListContexts .
See more: google.cloud.aiplatform_v1.types.ListContextsRequest
google.cloud.aiplatform_v1.types.ListContextsResponse
ListContextsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.ListContexts.
See more: google.cloud.aiplatform_v1.types.ListContextsResponse
google.cloud.aiplatform_v1.types.ListCustomJobsRequest
ListCustomJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.ListCustomJobs.
See more: google.cloud.aiplatform_v1.types.ListCustomJobsRequest
google.cloud.aiplatform_v1.types.ListCustomJobsResponse
ListCustomJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for JobService.ListCustomJobs .
See more: google.cloud.aiplatform_v1.types.ListCustomJobsResponse
google.cloud.aiplatform_v1.types.ListDataItemsRequest
ListDataItemsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ListDataItems.
See more: google.cloud.aiplatform_v1.types.ListDataItemsRequest
google.cloud.aiplatform_v1.types.ListDataItemsResponse
ListDataItemsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ListDataItems.
See more: google.cloud.aiplatform_v1.types.ListDataItemsResponse
google.cloud.aiplatform_v1.types.ListDataLabelingJobsRequest
ListDataLabelingJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.ListDataLabelingJobs.
See more: google.cloud.aiplatform_v1.types.ListDataLabelingJobsRequest
google.cloud.aiplatform_v1.types.ListDataLabelingJobsResponse
ListDataLabelingJobsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for JobService.ListDataLabelingJobs.
See more: google.cloud.aiplatform_v1.types.ListDataLabelingJobsResponse
google.cloud.aiplatform_v1.types.ListDatasetVersionsRequest
ListDatasetVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ListDatasetVersions.
See more: google.cloud.aiplatform_v1.types.ListDatasetVersionsRequest
google.cloud.aiplatform_v1.types.ListDatasetVersionsResponse
ListDatasetVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ListDatasetVersions.
See more: google.cloud.aiplatform_v1.types.ListDatasetVersionsResponse
google.cloud.aiplatform_v1.types.ListDatasetsRequest
ListDatasetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ListDatasets.
See more: google.cloud.aiplatform_v1.types.ListDatasetsRequest
google.cloud.aiplatform_v1.types.ListDatasetsResponse
ListDatasetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ListDatasets.
See more: google.cloud.aiplatform_v1.types.ListDatasetsResponse
google.cloud.aiplatform_v1.types.ListDeploymentResourcePoolsRequest
ListDeploymentResourcePoolsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ListDeploymentResourcePools method.
See more: google.cloud.aiplatform_v1.types.ListDeploymentResourcePoolsRequest
google.cloud.aiplatform_v1.types.ListDeploymentResourcePoolsResponse
ListDeploymentResourcePoolsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for ListDeploymentResourcePools method.
See more: google.cloud.aiplatform_v1.types.ListDeploymentResourcePoolsResponse
google.cloud.aiplatform_v1.types.ListEndpointsRequest
ListEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.ListEndpoints.
See more: google.cloud.aiplatform_v1.types.ListEndpointsRequest
google.cloud.aiplatform_v1.types.ListEndpointsResponse
ListEndpointsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for EndpointService.ListEndpoints.
See more: google.cloud.aiplatform_v1.types.ListEndpointsResponse
google.cloud.aiplatform_v1.types.ListEntityTypesRequest
ListEntityTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.ListEntityTypes.
See more: google.cloud.aiplatform_v1.types.ListEntityTypesRequest
google.cloud.aiplatform_v1.types.ListEntityTypesResponse
ListEntityTypesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.ListEntityTypes.
See more: google.cloud.aiplatform_v1.types.ListEntityTypesResponse
google.cloud.aiplatform_v1.types.ListExecutionsRequest
ListExecutionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.ListExecutions.
See more: google.cloud.aiplatform_v1.types.ListExecutionsRequest
google.cloud.aiplatform_v1.types.ListExecutionsResponse
ListExecutionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.ListExecutions.
See more: google.cloud.aiplatform_v1.types.ListExecutionsResponse
google.cloud.aiplatform_v1.types.ListFeatureGroupsRequest
ListFeatureGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureRegistryService.ListFeatureGroups.
See more: google.cloud.aiplatform_v1.types.ListFeatureGroupsRequest
google.cloud.aiplatform_v1.types.ListFeatureGroupsResponse
ListFeatureGroupsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeatureRegistryService.ListFeatureGroups.
See more: google.cloud.aiplatform_v1.types.ListFeatureGroupsResponse
google.cloud.aiplatform_v1.types.ListFeatureOnlineStoresRequest
ListFeatureOnlineStoresRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeatureOnlineStoreAdminService.ListFeatureOnlineStores.
See more: google.cloud.aiplatform_v1.types.ListFeatureOnlineStoresRequest
google.cloud.aiplatform_v1.types.ListFeatureOnlineStoresResponse
ListFeatureOnlineStoresResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for FeatureOnlineStoreAdminService.ListFeatureOnlineStores.
See more: google.cloud.aiplatform_v1.types.ListFeatureOnlineStoresResponse
google.cloud.aiplatform_v1.types.ListFeatureViewSyncsRequest
ListFeatureViewSyncsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.ListFeatureViewSyncs.
See more: google.cloud.aiplatform_v1.types.ListFeatureViewSyncsRequest
google.cloud.aiplatform_v1.types.ListFeatureViewSyncsResponse
ListFeatureViewSyncsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for FeatureOnlineStoreAdminService.ListFeatureViewSyncs.
See more: google.cloud.aiplatform_v1.types.ListFeatureViewSyncsResponse
google.cloud.aiplatform_v1.types.ListFeatureViewsRequest
ListFeatureViewsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.ListFeatureViews.
See more: google.cloud.aiplatform_v1.types.ListFeatureViewsRequest
google.cloud.aiplatform_v1.types.ListFeatureViewsResponse
ListFeatureViewsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeatureOnlineStoreAdminService.ListFeatureViews.
See more: google.cloud.aiplatform_v1.types.ListFeatureViewsResponse
google.cloud.aiplatform_v1.types.ListFeaturesRequest
ListFeaturesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.ListFeatures.
See more: google.cloud.aiplatform_v1.types.ListFeaturesRequest
google.cloud.aiplatform_v1.types.ListFeaturesResponse
ListFeaturesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.ListFeatures.
See more: google.cloud.aiplatform_v1.types.ListFeaturesResponse
google.cloud.aiplatform_v1.types.ListFeaturestoresRequest
ListFeaturestoresRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.ListFeaturestores.
See more: google.cloud.aiplatform_v1.types.ListFeaturestoresRequest
google.cloud.aiplatform_v1.types.ListFeaturestoresResponse
ListFeaturestoresResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.ListFeaturestores.
See more: google.cloud.aiplatform_v1.types.ListFeaturestoresResponse
google.cloud.aiplatform_v1.types.ListHyperparameterTuningJobsRequest
ListHyperparameterTuningJobsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.ListHyperparameterTuningJobs.
See more: google.cloud.aiplatform_v1.types.ListHyperparameterTuningJobsRequest
google.cloud.aiplatform_v1.types.ListHyperparameterTuningJobsResponse
ListHyperparameterTuningJobsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for JobService.ListHyperparameterTuningJobs .
See more: google.cloud.aiplatform_v1.types.ListHyperparameterTuningJobsResponse
google.cloud.aiplatform_v1.types.ListIndexEndpointsRequest
ListIndexEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.ListIndexEndpoints.
See more: google.cloud.aiplatform_v1.types.ListIndexEndpointsRequest
google.cloud.aiplatform_v1.types.ListIndexEndpointsResponse
ListIndexEndpointsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexEndpointService.ListIndexEndpoints.
See more: google.cloud.aiplatform_v1.types.ListIndexEndpointsResponse
google.cloud.aiplatform_v1.types.ListIndexesRequest
ListIndexesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.ListIndexes.
See more: google.cloud.aiplatform_v1.types.ListIndexesRequest
google.cloud.aiplatform_v1.types.ListIndexesResponse
ListIndexesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexService.ListIndexes.
See more: google.cloud.aiplatform_v1.types.ListIndexesResponse
google.cloud.aiplatform_v1.types.ListMetadataSchemasRequest
ListMetadataSchemasRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.ListMetadataSchemas.
See more: google.cloud.aiplatform_v1.types.ListMetadataSchemasRequest
google.cloud.aiplatform_v1.types.ListMetadataSchemasResponse
ListMetadataSchemasResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.ListMetadataSchemas.
See more: google.cloud.aiplatform_v1.types.ListMetadataSchemasResponse
google.cloud.aiplatform_v1.types.ListMetadataStoresRequest
ListMetadataStoresRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.ListMetadataStores.
See more: google.cloud.aiplatform_v1.types.ListMetadataStoresRequest
google.cloud.aiplatform_v1.types.ListMetadataStoresResponse
ListMetadataStoresResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.ListMetadataStores.
See more: google.cloud.aiplatform_v1.types.ListMetadataStoresResponse
google.cloud.aiplatform_v1.types.ListModelDeploymentMonitoringJobsRequest
ListModelDeploymentMonitoringJobsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.ListModelDeploymentMonitoringJobs.
See more: google.cloud.aiplatform_v1.types.ListModelDeploymentMonitoringJobsRequest
google.cloud.aiplatform_v1.types.ListModelDeploymentMonitoringJobsResponse
ListModelDeploymentMonitoringJobsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for JobService.ListModelDeploymentMonitoringJobs.
See more: google.cloud.aiplatform_v1.types.ListModelDeploymentMonitoringJobsResponse
google.cloud.aiplatform_v1.types.ListModelEvaluationSlicesRequest
ListModelEvaluationSlicesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ModelService.ListModelEvaluationSlices.
See more: google.cloud.aiplatform_v1.types.ListModelEvaluationSlicesRequest
google.cloud.aiplatform_v1.types.ListModelEvaluationSlicesResponse
ListModelEvaluationSlicesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for ModelService.ListModelEvaluationSlices.
See more: google.cloud.aiplatform_v1.types.ListModelEvaluationSlicesResponse
google.cloud.aiplatform_v1.types.ListModelEvaluationsRequest
ListModelEvaluationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.ListModelEvaluations.
See more: google.cloud.aiplatform_v1.types.ListModelEvaluationsRequest
google.cloud.aiplatform_v1.types.ListModelEvaluationsResponse
ListModelEvaluationsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for ModelService.ListModelEvaluations.
See more: google.cloud.aiplatform_v1.types.ListModelEvaluationsResponse
google.cloud.aiplatform_v1.types.ListModelVersionsRequest
ListModelVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.ListModelVersions.
See more: google.cloud.aiplatform_v1.types.ListModelVersionsRequest
google.cloud.aiplatform_v1.types.ListModelVersionsResponse
ListModelVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for ModelService.ListModelVersions .
See more: google.cloud.aiplatform_v1.types.ListModelVersionsResponse
google.cloud.aiplatform_v1.types.ListModelsRequest
ListModelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.ListModels.
See more: google.cloud.aiplatform_v1.types.ListModelsRequest
google.cloud.aiplatform_v1.types.ListModelsResponse
ListModelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for ModelService.ListModels .
See more: google.cloud.aiplatform_v1.types.ListModelsResponse
google.cloud.aiplatform_v1.types.ListNasJobsRequest
ListNasJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.ListNasJobs.
See more: google.cloud.aiplatform_v1.types.ListNasJobsRequest
google.cloud.aiplatform_v1.types.ListNasJobsResponse
ListNasJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for JobService.ListNasJobs .
See more: google.cloud.aiplatform_v1.types.ListNasJobsResponse
google.cloud.aiplatform_v1.types.ListNasTrialDetailsRequest
ListNasTrialDetailsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.ListNasTrialDetails.
See more: google.cloud.aiplatform_v1.types.ListNasTrialDetailsRequest
google.cloud.aiplatform_v1.types.ListNasTrialDetailsResponse
ListNasTrialDetailsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for JobService.ListNasTrialDetails .
See more: google.cloud.aiplatform_v1.types.ListNasTrialDetailsResponse
google.cloud.aiplatform_v1.types.ListNotebookRuntimeTemplatesRequest
ListNotebookRuntimeTemplatesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.ListNotebookRuntimeTemplates.
See more: google.cloud.aiplatform_v1.types.ListNotebookRuntimeTemplatesRequest
google.cloud.aiplatform_v1.types.ListNotebookRuntimeTemplatesResponse
ListNotebookRuntimeTemplatesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for NotebookService.ListNotebookRuntimeTemplates.
See more: google.cloud.aiplatform_v1.types.ListNotebookRuntimeTemplatesResponse
google.cloud.aiplatform_v1.types.ListNotebookRuntimesRequest
ListNotebookRuntimesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for NotebookService.ListNotebookRuntimes.
See more: google.cloud.aiplatform_v1.types.ListNotebookRuntimesRequest
google.cloud.aiplatform_v1.types.ListNotebookRuntimesResponse
ListNotebookRuntimesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for NotebookService.ListNotebookRuntimes.
See more: google.cloud.aiplatform_v1.types.ListNotebookRuntimesResponse
google.cloud.aiplatform_v1.types.ListOptimalTrialsRequest
ListOptimalTrialsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.ListOptimalTrials.
See more: google.cloud.aiplatform_v1.types.ListOptimalTrialsRequest
google.cloud.aiplatform_v1.types.ListOptimalTrialsResponse
ListOptimalTrialsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VizierService.ListOptimalTrials.
See more: google.cloud.aiplatform_v1.types.ListOptimalTrialsResponse
google.cloud.aiplatform_v1.types.ListPersistentResourcesRequest
ListPersistentResourcesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for [PersistentResourceService.ListPersistentResource][].
See more: google.cloud.aiplatform_v1.types.ListPersistentResourcesRequest
google.cloud.aiplatform_v1.types.ListPersistentResourcesResponse
ListPersistentResourcesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for PersistentResourceService.ListPersistentResources .
See more: google.cloud.aiplatform_v1.types.ListPersistentResourcesResponse
google.cloud.aiplatform_v1.types.ListPipelineJobsRequest
ListPipelineJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PipelineService.ListPipelineJobs.
See more: google.cloud.aiplatform_v1.types.ListPipelineJobsRequest
google.cloud.aiplatform_v1.types.ListPipelineJobsResponse
ListPipelineJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PipelineService.ListPipelineJobs .
See more: google.cloud.aiplatform_v1.types.ListPipelineJobsResponse
google.cloud.aiplatform_v1.types.ListSavedQueriesRequest
ListSavedQueriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ListSavedQueries.
See more: google.cloud.aiplatform_v1.types.ListSavedQueriesRequest
google.cloud.aiplatform_v1.types.ListSavedQueriesResponse
ListSavedQueriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ListSavedQueries.
See more: google.cloud.aiplatform_v1.types.ListSavedQueriesResponse
google.cloud.aiplatform_v1.types.ListSchedulesRequest
ListSchedulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.ListSchedules.
See more: google.cloud.aiplatform_v1.types.ListSchedulesRequest
google.cloud.aiplatform_v1.types.ListSchedulesResponse
ListSchedulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for ScheduleService.ListSchedules .
See more: google.cloud.aiplatform_v1.types.ListSchedulesResponse
google.cloud.aiplatform_v1.types.ListSpecialistPoolsRequest
ListSpecialistPoolsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for SpecialistPoolService.ListSpecialistPools.
See more: google.cloud.aiplatform_v1.types.ListSpecialistPoolsRequest
google.cloud.aiplatform_v1.types.ListSpecialistPoolsResponse
ListSpecialistPoolsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for SpecialistPoolService.ListSpecialistPools.
See more: google.cloud.aiplatform_v1.types.ListSpecialistPoolsResponse
google.cloud.aiplatform_v1.types.ListStudiesRequest
ListStudiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.ListStudies.
See more: google.cloud.aiplatform_v1.types.ListStudiesRequest
google.cloud.aiplatform_v1.types.ListStudiesResponse
ListStudiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VizierService.ListStudies.
See more: google.cloud.aiplatform_v1.types.ListStudiesResponse
google.cloud.aiplatform_v1.types.ListTensorboardExperimentsRequest
ListTensorboardExperimentsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.ListTensorboardExperiments.
See more: google.cloud.aiplatform_v1.types.ListTensorboardExperimentsRequest
google.cloud.aiplatform_v1.types.ListTensorboardExperimentsResponse
ListTensorboardExperimentsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.ListTensorboardExperiments.
See more: google.cloud.aiplatform_v1.types.ListTensorboardExperimentsResponse
google.cloud.aiplatform_v1.types.ListTensorboardRunsRequest
ListTensorboardRunsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.ListTensorboardRuns.
See more: google.cloud.aiplatform_v1.types.ListTensorboardRunsRequest
google.cloud.aiplatform_v1.types.ListTensorboardRunsResponse
ListTensorboardRunsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for TensorboardService.ListTensorboardRuns.
See more: google.cloud.aiplatform_v1.types.ListTensorboardRunsResponse
google.cloud.aiplatform_v1.types.ListTensorboardTimeSeriesRequest
ListTensorboardTimeSeriesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.ListTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1.types.ListTensorboardTimeSeriesRequest
google.cloud.aiplatform_v1.types.ListTensorboardTimeSeriesResponse
ListTensorboardTimeSeriesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.ListTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1.types.ListTensorboardTimeSeriesResponse
google.cloud.aiplatform_v1.types.ListTensorboardsRequest
ListTensorboardsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.ListTensorboards.
See more: google.cloud.aiplatform_v1.types.ListTensorboardsRequest
google.cloud.aiplatform_v1.types.ListTensorboardsResponse
ListTensorboardsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for TensorboardService.ListTensorboards.
See more: google.cloud.aiplatform_v1.types.ListTensorboardsResponse
google.cloud.aiplatform_v1.types.ListTrainingPipelinesRequest
ListTrainingPipelinesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PipelineService.ListTrainingPipelines.
See more: google.cloud.aiplatform_v1.types.ListTrainingPipelinesRequest
google.cloud.aiplatform_v1.types.ListTrainingPipelinesResponse
ListTrainingPipelinesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for PipelineService.ListTrainingPipelines .
See more: google.cloud.aiplatform_v1.types.ListTrainingPipelinesResponse
google.cloud.aiplatform_v1.types.ListTrialsRequest
ListTrialsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.ListTrials.
See more: google.cloud.aiplatform_v1.types.ListTrialsRequest
google.cloud.aiplatform_v1.types.ListTrialsResponse
ListTrialsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VizierService.ListTrials.
See more: google.cloud.aiplatform_v1.types.ListTrialsResponse
google.cloud.aiplatform_v1.types.ListTuningJobsRequest
ListTuningJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for GenAiTuningService.ListTuningJobs.
See more: google.cloud.aiplatform_v1.types.ListTuningJobsRequest
google.cloud.aiplatform_v1.types.ListTuningJobsResponse
ListTuningJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for GenAiTuningService.ListTuningJobs .
See more: google.cloud.aiplatform_v1.types.ListTuningJobsResponse
google.cloud.aiplatform_v1.types.LookupStudyRequest
LookupStudyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.LookupStudy.
See more: google.cloud.aiplatform_v1.types.LookupStudyRequest
google.cloud.aiplatform_v1.types.MachineSpec
MachineSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specification of a single machine.
google.cloud.aiplatform_v1.types.ManualBatchTuningParameters
ManualBatchTuningParameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Manual batch tuning parameters.
See more: google.cloud.aiplatform_v1.types.ManualBatchTuningParameters
google.cloud.aiplatform_v1.types.Measurement
Measurement(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A message representing a Measurement of a Trial.
google.cloud.aiplatform_v1.types.Measurement.Metric
Metric(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A message representing a metric in the measurement.
See more: google.cloud.aiplatform_v1.types.Measurement.Metric
google.cloud.aiplatform_v1.types.MergeVersionAliasesRequest
MergeVersionAliasesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.MergeVersionAliases.
See more: google.cloud.aiplatform_v1.types.MergeVersionAliasesRequest
google.cloud.aiplatform_v1.types.MetadataSchema
MetadataSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Instance of a general MetadataSchema.
google.cloud.aiplatform_v1.types.MetadataSchema.MetadataSchemaType
MetadataSchemaType(value)
Describes the type of the MetadataSchema.
See more: google.cloud.aiplatform_v1.types.MetadataSchema.MetadataSchemaType
google.cloud.aiplatform_v1.types.MetadataStore
MetadataStore(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Instance of a metadata store.
google.cloud.aiplatform_v1.types.MetadataStore.MetadataStoreState
MetadataStoreState(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents state information for a MetadataStore.
See more: google.cloud.aiplatform_v1.types.MetadataStore.MetadataStoreState
google.cloud.aiplatform_v1.types.MigratableResource
MigratableResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents one resource that exists in automl.googleapis.com, datalabeling.googleapis.com or ml.googleapis.com.
See more: google.cloud.aiplatform_v1.types.MigratableResource
google.cloud.aiplatform_v1.types.MigratableResource.AutomlDataset
AutomlDataset(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents one Dataset in automl.googleapis.com.
See more: google.cloud.aiplatform_v1.types.MigratableResource.AutomlDataset
google.cloud.aiplatform_v1.types.MigratableResource.AutomlModel
AutomlModel(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents one Model in automl.googleapis.com.
See more: google.cloud.aiplatform_v1.types.MigratableResource.AutomlModel
google.cloud.aiplatform_v1.types.MigratableResource.DataLabelingDataset
DataLabelingDataset(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents one Dataset in datalabeling.googleapis.com.
See more: google.cloud.aiplatform_v1.types.MigratableResource.DataLabelingDataset
google.cloud.aiplatform_v1.types.MigratableResource.DataLabelingDataset.DataLabelingAnnotatedDataset
DataLabelingAnnotatedDataset(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Represents one AnnotatedDataset in datalabeling.googleapis.com.
See more: google.cloud.aiplatform_v1.types.MigratableResource.DataLabelingDataset.DataLabelingAnnotatedDataset
google.cloud.aiplatform_v1.types.MigratableResource.MlEngineModelVersion
MlEngineModelVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents one model Version in ml.googleapis.com.
See more: google.cloud.aiplatform_v1.types.MigratableResource.MlEngineModelVersion
google.cloud.aiplatform_v1.types.MigrateResourceRequest
MigrateResourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config of migrating one resource from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
See more: google.cloud.aiplatform_v1.types.MigrateResourceRequest
google.cloud.aiplatform_v1.types.MigrateResourceRequest.MigrateAutomlDatasetConfig
MigrateAutomlDatasetConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for migrating Dataset in automl.googleapis.com to Vertex AI's Dataset.
See more: google.cloud.aiplatform_v1.types.MigrateResourceRequest.MigrateAutomlDatasetConfig
google.cloud.aiplatform_v1.types.MigrateResourceRequest.MigrateAutomlModelConfig
MigrateAutomlModelConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for migrating Model in automl.googleapis.com to Vertex AI's Model.
See more: google.cloud.aiplatform_v1.types.MigrateResourceRequest.MigrateAutomlModelConfig
google.cloud.aiplatform_v1.types.MigrateResourceRequest.MigrateDataLabelingDatasetConfig
MigrateDataLabelingDatasetConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI's Dataset.
See more: google.cloud.aiplatform_v1.types.MigrateResourceRequest.MigrateDataLabelingDatasetConfig
google.cloud.aiplatform_v1.types.MigrateResourceRequest.MigrateDataLabelingDatasetConfig.MigrateDataLabelingAnnotatedDatasetConfig
MigrateDataLabelingAnnotatedDatasetConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Config for migrating AnnotatedDataset in datalabeling.googleapis.com to Vertex AI's SavedQuery.
google.cloud.aiplatform_v1.types.MigrateResourceRequest.MigrateMlEngineModelVersionConfig
MigrateMlEngineModelVersionConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Config for migrating version in ml.googleapis.com to Vertex AI's Model.
See more: google.cloud.aiplatform_v1.types.MigrateResourceRequest.MigrateMlEngineModelVersionConfig
google.cloud.aiplatform_v1.types.MigrateResourceResponse
MigrateResourceResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes a successfully migrated resource.
See more: google.cloud.aiplatform_v1.types.MigrateResourceResponse
google.cloud.aiplatform_v1.types.Model
Model(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A trained machine learning Model.
See more: google.cloud.aiplatform_v1.types.Model
google.cloud.aiplatform_v1.types.Model.BaseModelSource
BaseModelSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
User input field to specify the base model source.
See more: google.cloud.aiplatform_v1.types.Model.BaseModelSource
google.cloud.aiplatform_v1.types.Model.DataStats
DataStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Stats of data used for train or evaluate the Model.
google.cloud.aiplatform_v1.types.Model.DeploymentResourcesType
DeploymentResourcesType(value)
Identifies a type of Model's prediction resources.
See more: google.cloud.aiplatform_v1.types.Model.DeploymentResourcesType
google.cloud.aiplatform_v1.types.Model.ExportFormat
ExportFormat(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents export format supported by the Model.
See more: google.cloud.aiplatform_v1.types.Model.ExportFormat
google.cloud.aiplatform_v1.types.Model.ExportFormat.ExportableContent
ExportableContent(value)
The Model content that can be exported.
See more: google.cloud.aiplatform_v1.types.Model.ExportFormat.ExportableContent
google.cloud.aiplatform_v1.types.Model.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Model.LabelsEntry
google.cloud.aiplatform_v1.types.Model.OriginalModelInfo
OriginalModelInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains information about the original Model if this Model is a copy.
See more: google.cloud.aiplatform_v1.types.Model.OriginalModelInfo
google.cloud.aiplatform_v1.types.ModelContainerSpec
ModelContainerSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specification of a container for serving predictions.
See more: google.cloud.aiplatform_v1.types.ModelContainerSpec
google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringBigQueryTable
ModelDeploymentMonitoringBigQueryTable(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name as well as some information of the logs stored in this table.
See more: google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringBigQueryTable
google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringBigQueryTable.LogSource
LogSource(value)
Indicates where does the log come from.
See more: google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringBigQueryTable.LogSource
google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringBigQueryTable.LogType
LogType(value)
Indicates what type of traffic does the log belong to.
See more: google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringBigQueryTable.LogType
google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringJob
ModelDeploymentMonitoringJob(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Represents a job that runs periodically to monitor the deployed models in an endpoint.
See more: google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringJob
google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringJob.LabelsEntry
google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata
LatestMonitoringPipelineMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
All metadata of most recent monitoring pipelines.
See more: google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata
google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringJob.MonitoringScheduleState
MonitoringScheduleState(value)
The state to Specify the monitoring pipeline.
See more: google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringJob.MonitoringScheduleState
google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringObjectiveConfig
ModelDeploymentMonitoringObjectiveConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
ModelDeploymentMonitoringObjectiveConfig contains the pair of deployed_model_id to ModelMonitoringObjectiveConfig.
See more: google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringObjectiveConfig
google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringObjectiveType
ModelDeploymentMonitoringObjectiveType(value)
The Model Monitoring Objective types.
See more: google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringObjectiveType
google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringScheduleConfig
ModelDeploymentMonitoringScheduleConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The config for scheduling monitoring job.
See more: google.cloud.aiplatform_v1.types.ModelDeploymentMonitoringScheduleConfig
google.cloud.aiplatform_v1.types.ModelEvaluation
ModelEvaluation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A collection of metrics calculated by comparing Model's predictions on all of the test data against annotations from the test data.
google.cloud.aiplatform_v1.types.ModelEvaluation.ModelEvaluationExplanationSpec
ModelEvaluationExplanationSpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform_v1.types.ModelEvaluationSlice
ModelEvaluationSlice(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A collection of metrics calculated by comparing Model's predictions on a slice of the test data against ground truth annotations.
See more: google.cloud.aiplatform_v1.types.ModelEvaluationSlice
google.cloud.aiplatform_v1.types.ModelEvaluationSlice.Slice
Slice(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Definition of a slice.
See more: google.cloud.aiplatform_v1.types.ModelEvaluationSlice.Slice
google.cloud.aiplatform_v1.types.ModelEvaluationSlice.Slice.SliceSpec
SliceSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specification for how the data should be sliced.
See more: google.cloud.aiplatform_v1.types.ModelEvaluationSlice.Slice.SliceSpec
google.cloud.aiplatform_v1.types.ModelEvaluationSlice.Slice.SliceSpec.ConfigsEntry
ConfigsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.ModelEvaluationSlice.Slice.SliceSpec.ConfigsEntry
google.cloud.aiplatform_v1.types.ModelEvaluationSlice.Slice.SliceSpec.Range
Range(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A range of values for slice(s).
See more: google.cloud.aiplatform_v1.types.ModelEvaluationSlice.Slice.SliceSpec.Range
google.cloud.aiplatform_v1.types.ModelEvaluationSlice.Slice.SliceSpec.SliceConfig
SliceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specification message containing the config for this SliceSpec.
See more: google.cloud.aiplatform_v1.types.ModelEvaluationSlice.Slice.SliceSpec.SliceConfig
google.cloud.aiplatform_v1.types.ModelEvaluationSlice.Slice.SliceSpec.Value
Value(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Single value that supports strings and floats.
See more: google.cloud.aiplatform_v1.types.ModelEvaluationSlice.Slice.SliceSpec.Value
google.cloud.aiplatform_v1.types.ModelExplanation
ModelExplanation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Aggregated explanation metrics for a Model over a set of instances.
google.cloud.aiplatform_v1.types.ModelGardenSource
ModelGardenSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains information about the source of the models generated from Model Garden.
See more: google.cloud.aiplatform_v1.types.ModelGardenSource
google.cloud.aiplatform_v1.types.ModelMonitoringAlertConfig
ModelMonitoringAlertConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The alert config for model monitoring.
See more: google.cloud.aiplatform_v1.types.ModelMonitoringAlertConfig
google.cloud.aiplatform_v1.types.ModelMonitoringAlertConfig.EmailAlertConfig
EmailAlertConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The config for email alert.
See more: google.cloud.aiplatform_v1.types.ModelMonitoringAlertConfig.EmailAlertConfig
google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig
ModelMonitoringObjectiveConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The objective configuration for model monitoring, including the information needed to detect anomalies for one particular model.
See more: google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig
google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.ExplanationConfig
ExplanationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The config for integrating with Vertex Explainable AI.
See more: google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.ExplanationConfig
google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline
ExplanationBaseline(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Output from BatchPredictionJob for Model Monitoring baseline dataset, which can be used to generate baseline attribution scores.
google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline.PredictionFormat
PredictionFormat(value)
The storage format of the predictions generated BatchPrediction job.
google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.PredictionDriftDetectionConfig
PredictionDriftDetectionConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The config for Prediction data drift detection.
See more: google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.PredictionDriftDetectionConfig
google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.PredictionDriftDetectionConfig.AttributionScoreDriftThresholdsEntry
AttributionScoreDriftThresholdsEntry(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The abstract base class for a message.
google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.PredictionDriftDetectionConfig.DriftThresholdsEntry
DriftThresholdsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.TrainingDataset
TrainingDataset(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training Dataset information.
See more: google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.TrainingDataset
google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.TrainingPredictionSkewDetectionConfig
TrainingPredictionSkewDetectionConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The config for Training & Prediction data skew detection.
google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.TrainingPredictionSkewDetectionConfig.AttributionScoreSkewThresholdsEntry
AttributionScoreSkewThresholdsEntry(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The abstract base class for a message.
google.cloud.aiplatform_v1.types.ModelMonitoringObjectiveConfig.TrainingPredictionSkewDetectionConfig.SkewThresholdsEntry
SkewThresholdsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
google.cloud.aiplatform_v1.types.ModelMonitoringStatsAnomalies
ModelMonitoringStatsAnomalies(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Statistics and anomalies generated by Model Monitoring.
See more: google.cloud.aiplatform_v1.types.ModelMonitoringStatsAnomalies
google.cloud.aiplatform_v1.types.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies
FeatureHistoricStatsAnomalies(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Historical Stats (and Anomalies) for a specific Feature.
See more: google.cloud.aiplatform_v1.types.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies
google.cloud.aiplatform_v1.types.ModelSourceInfo
ModelSourceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Detail description of the source information of the model.
google.cloud.aiplatform_v1.types.ModelSourceInfo.ModelSourceType
ModelSourceType(value)
Source of the model.
See more: google.cloud.aiplatform_v1.types.ModelSourceInfo.ModelSourceType
google.cloud.aiplatform_v1.types.MutateDeployedIndexOperationMetadata
MutateDeployedIndexOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for IndexEndpointService.MutateDeployedIndex.
See more: google.cloud.aiplatform_v1.types.MutateDeployedIndexOperationMetadata
google.cloud.aiplatform_v1.types.MutateDeployedIndexRequest
MutateDeployedIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.MutateDeployedIndex.
See more: google.cloud.aiplatform_v1.types.MutateDeployedIndexRequest
google.cloud.aiplatform_v1.types.MutateDeployedIndexResponse
MutateDeployedIndexResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexEndpointService.MutateDeployedIndex.
See more: google.cloud.aiplatform_v1.types.MutateDeployedIndexResponse
google.cloud.aiplatform_v1.types.MutateDeployedModelOperationMetadata
MutateDeployedModelOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for EndpointService.MutateDeployedModel.
See more: google.cloud.aiplatform_v1.types.MutateDeployedModelOperationMetadata
google.cloud.aiplatform_v1.types.MutateDeployedModelRequest
MutateDeployedModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.MutateDeployedModel.
See more: google.cloud.aiplatform_v1.types.MutateDeployedModelRequest
google.cloud.aiplatform_v1.types.MutateDeployedModelResponse
MutateDeployedModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for EndpointService.MutateDeployedModel.
See more: google.cloud.aiplatform_v1.types.MutateDeployedModelResponse
google.cloud.aiplatform_v1.types.NasJob
NasJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a Neural Architecture Search (NAS) job.
See more: google.cloud.aiplatform_v1.types.NasJob
google.cloud.aiplatform_v1.types.NasJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.NasJob.LabelsEntry
google.cloud.aiplatform_v1.types.NasJobOutput
NasJobOutput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a uCAIP NasJob output.
google.cloud.aiplatform_v1.types.NasJobOutput.MultiTrialJobOutput
MultiTrialJobOutput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The output of a multi-trial Neural Architecture Search (NAS) jobs.
See more: google.cloud.aiplatform_v1.types.NasJobOutput.MultiTrialJobOutput
google.cloud.aiplatform_v1.types.NasJobSpec
NasJobSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of a NasJob.
google.cloud.aiplatform_v1.types.NasJobSpec.MultiTrialAlgorithmSpec
MultiTrialAlgorithmSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The spec of multi-trial Neural Architecture Search (NAS).
See more: google.cloud.aiplatform_v1.types.NasJobSpec.MultiTrialAlgorithmSpec
google.cloud.aiplatform_v1.types.NasJobSpec.MultiTrialAlgorithmSpec.MetricSpec
MetricSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a metric to optimize.
See more: google.cloud.aiplatform_v1.types.NasJobSpec.MultiTrialAlgorithmSpec.MetricSpec
google.cloud.aiplatform_v1.types.NasJobSpec.MultiTrialAlgorithmSpec.MetricSpec.GoalType
GoalType(value)
The available types of optimization goals.
See more: google.cloud.aiplatform_v1.types.NasJobSpec.MultiTrialAlgorithmSpec.MetricSpec.GoalType
google.cloud.aiplatform_v1.types.NasJobSpec.MultiTrialAlgorithmSpec.MultiTrialAlgorithm
MultiTrialAlgorithm(value)
The available types of multi-trial algorithms.
See more: google.cloud.aiplatform_v1.types.NasJobSpec.MultiTrialAlgorithmSpec.MultiTrialAlgorithm
google.cloud.aiplatform_v1.types.NasJobSpec.MultiTrialAlgorithmSpec.SearchTrialSpec
SearchTrialSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represent spec for search trials.
See more: google.cloud.aiplatform_v1.types.NasJobSpec.MultiTrialAlgorithmSpec.SearchTrialSpec
google.cloud.aiplatform_v1.types.NasJobSpec.MultiTrialAlgorithmSpec.TrainTrialSpec
TrainTrialSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represent spec for train trials.
See more: google.cloud.aiplatform_v1.types.NasJobSpec.MultiTrialAlgorithmSpec.TrainTrialSpec
google.cloud.aiplatform_v1.types.NasTrial
NasTrial(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a uCAIP NasJob trial.
google.cloud.aiplatform_v1.types.NasTrial.State
State(value)
Describes a NasTrial state.
google.cloud.aiplatform_v1.types.NasTrialDetail
NasTrialDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a NasTrial details along with its parameters.
google.cloud.aiplatform_v1.types.NearestNeighborQuery
NearestNeighborQuery(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A query to find a number of similar entities.
See more: google.cloud.aiplatform_v1.types.NearestNeighborQuery
google.cloud.aiplatform_v1.types.NearestNeighborQuery.Embedding
Embedding(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The embedding vector.
See more: google.cloud.aiplatform_v1.types.NearestNeighborQuery.Embedding
google.cloud.aiplatform_v1.types.NearestNeighborQuery.Parameters
Parameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Parameters that can be overrided in each query to tune query latency and recall.
See more: google.cloud.aiplatform_v1.types.NearestNeighborQuery.Parameters
google.cloud.aiplatform_v1.types.NearestNeighborQuery.StringFilter
StringFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)
String filter is used to search a subset of the entities by using boolean rules on string columns.
See more: google.cloud.aiplatform_v1.types.NearestNeighborQuery.StringFilter
google.cloud.aiplatform_v1.types.NearestNeighborSearchOperationMetadata
NearestNeighborSearchOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation metadata with regard to Matching Engine Index.
See more: google.cloud.aiplatform_v1.types.NearestNeighborSearchOperationMetadata
google.cloud.aiplatform_v1.types.NearestNeighborSearchOperationMetadata.ContentValidationStats
ContentValidationStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)
See more: google.cloud.aiplatform_v1.types.NearestNeighborSearchOperationMetadata.ContentValidationStats
google.cloud.aiplatform_v1.types.NearestNeighborSearchOperationMetadata.RecordError
RecordError(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform_v1.types.NearestNeighborSearchOperationMetadata.RecordError.RecordErrorType
RecordErrorType(value)
Values: ERROR_TYPE_UNSPECIFIED (0): Default, shall not be used.
See more: google.cloud.aiplatform_v1.types.NearestNeighborSearchOperationMetadata.RecordError.RecordErrorType
google.cloud.aiplatform_v1.types.NearestNeighbors
NearestNeighbors(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Nearest neighbors for one query.
google.cloud.aiplatform_v1.types.NearestNeighbors.Neighbor
Neighbor(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A neighbor of the query vector.
See more: google.cloud.aiplatform_v1.types.NearestNeighbors.Neighbor
google.cloud.aiplatform_v1.types.Neighbor
Neighbor(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Neighbors for example-based explanations.
google.cloud.aiplatform_v1.types.NetworkSpec
NetworkSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Network spec.
google.cloud.aiplatform_v1.types.NfsMount
NfsMount(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a mount configuration for Network File System (NFS) to mount.
google.cloud.aiplatform_v1.types.NotebookEucConfig
NotebookEucConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The euc configuration of NotebookRuntimeTemplate.
See more: google.cloud.aiplatform_v1.types.NotebookEucConfig
google.cloud.aiplatform_v1.types.NotebookIdleShutdownConfig
NotebookIdleShutdownConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.
See more: google.cloud.aiplatform_v1.types.NotebookIdleShutdownConfig
google.cloud.aiplatform_v1.types.NotebookRuntime
NotebookRuntime(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.
google.cloud.aiplatform_v1.types.NotebookRuntime.HealthState
HealthState(value)
The substate of the NotebookRuntime to display health information.
See more: google.cloud.aiplatform_v1.types.NotebookRuntime.HealthState
google.cloud.aiplatform_v1.types.NotebookRuntime.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.NotebookRuntime.LabelsEntry
google.cloud.aiplatform_v1.types.NotebookRuntime.RuntimeState
RuntimeState(value)
The substate of the NotebookRuntime to display state of runtime.
See more: google.cloud.aiplatform_v1.types.NotebookRuntime.RuntimeState
google.cloud.aiplatform_v1.types.NotebookRuntimeTemplate
NotebookRuntimeTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc.
See more: google.cloud.aiplatform_v1.types.NotebookRuntimeTemplate
google.cloud.aiplatform_v1.types.NotebookRuntimeTemplate.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.NotebookRuntimeTemplate.LabelsEntry
google.cloud.aiplatform_v1.types.NotebookRuntimeTemplateRef
NotebookRuntimeTemplateRef(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Points to a NotebookRuntimeTemplateRef.
See more: google.cloud.aiplatform_v1.types.NotebookRuntimeTemplateRef
google.cloud.aiplatform_v1.types.NotebookRuntimeType
NotebookRuntimeType(value)
Represents a notebook runtime type.
See more: google.cloud.aiplatform_v1.types.NotebookRuntimeType
google.cloud.aiplatform_v1.types.Part
Part(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A datatype containing media that is part of a multi-part Content
message.
See more: google.cloud.aiplatform_v1.types.Part
google.cloud.aiplatform_v1.types.PauseModelDeploymentMonitoringJobRequest
PauseModelDeploymentMonitoringJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.PauseModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1.types.PauseModelDeploymentMonitoringJobRequest
google.cloud.aiplatform_v1.types.PauseScheduleRequest
PauseScheduleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.PauseSchedule.
See more: google.cloud.aiplatform_v1.types.PauseScheduleRequest
google.cloud.aiplatform_v1.types.PersistentDiskSpec
PersistentDiskSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] options.
See more: google.cloud.aiplatform_v1.types.PersistentDiskSpec
google.cloud.aiplatform_v1.types.PersistentResource
PersistentResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents long-lasting resources that are dedicated to users to runs custom workloads.
See more: google.cloud.aiplatform_v1.types.PersistentResource
google.cloud.aiplatform_v1.types.PersistentResource.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.PersistentResource.LabelsEntry
google.cloud.aiplatform_v1.types.PersistentResource.State
State(value)
Describes the PersistentResource state.
See more: google.cloud.aiplatform_v1.types.PersistentResource.State
google.cloud.aiplatform_v1.types.PipelineFailurePolicy
PipelineFailurePolicy(value)
Represents the failure policy of a pipeline.
See more: google.cloud.aiplatform_v1.types.PipelineFailurePolicy
google.cloud.aiplatform_v1.types.PipelineJob
PipelineJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An instance of a machine learning PipelineJob.
google.cloud.aiplatform_v1.types.PipelineJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.PipelineJob.LabelsEntry
google.cloud.aiplatform_v1.types.PipelineJob.RuntimeConfig
RuntimeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The runtime config of a PipelineJob.
See more: google.cloud.aiplatform_v1.types.PipelineJob.RuntimeConfig
google.cloud.aiplatform_v1.types.PipelineJob.RuntimeConfig.InputArtifact
InputArtifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The type of an input artifact.
See more: google.cloud.aiplatform_v1.types.PipelineJob.RuntimeConfig.InputArtifact
google.cloud.aiplatform_v1.types.PipelineJob.RuntimeConfig.InputArtifactsEntry
InputArtifactsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.PipelineJob.RuntimeConfig.InputArtifactsEntry
google.cloud.aiplatform_v1.types.PipelineJob.RuntimeConfig.ParameterValuesEntry
ParameterValuesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.PipelineJob.RuntimeConfig.ParameterValuesEntry
google.cloud.aiplatform_v1.types.PipelineJob.RuntimeConfig.ParametersEntry
ParametersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.PipelineJob.RuntimeConfig.ParametersEntry
google.cloud.aiplatform_v1.types.PipelineJobDetail
PipelineJobDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The runtime detail of PipelineJob.
See more: google.cloud.aiplatform_v1.types.PipelineJobDetail
google.cloud.aiplatform_v1.types.PipelineState
PipelineState(value)
Describes the state of a pipeline.
google.cloud.aiplatform_v1.types.PipelineTaskDetail
PipelineTaskDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The runtime detail of a task execution.
See more: google.cloud.aiplatform_v1.types.PipelineTaskDetail
google.cloud.aiplatform_v1.types.PipelineTaskDetail.ArtifactList
ArtifactList(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of artifact metadata.
See more: google.cloud.aiplatform_v1.types.PipelineTaskDetail.ArtifactList
google.cloud.aiplatform_v1.types.PipelineTaskDetail.InputsEntry
InputsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.PipelineTaskDetail.InputsEntry
google.cloud.aiplatform_v1.types.PipelineTaskDetail.OutputsEntry
OutputsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.PipelineTaskDetail.OutputsEntry
google.cloud.aiplatform_v1.types.PipelineTaskDetail.PipelineTaskStatus
PipelineTaskStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A single record of the task status.
See more: google.cloud.aiplatform_v1.types.PipelineTaskDetail.PipelineTaskStatus
google.cloud.aiplatform_v1.types.PipelineTaskDetail.State
State(value)
Specifies state of TaskExecution.
See more: google.cloud.aiplatform_v1.types.PipelineTaskDetail.State
google.cloud.aiplatform_v1.types.PipelineTaskExecutorDetail
PipelineTaskExecutorDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The runtime detail of a pipeline executor.
See more: google.cloud.aiplatform_v1.types.PipelineTaskExecutorDetail
google.cloud.aiplatform_v1.types.PipelineTaskExecutorDetail.ContainerDetail
ContainerDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The detail of a container execution.
See more: google.cloud.aiplatform_v1.types.PipelineTaskExecutorDetail.ContainerDetail
google.cloud.aiplatform_v1.types.PipelineTaskExecutorDetail.CustomJobDetail
CustomJobDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The detailed info for a custom job executor.
See more: google.cloud.aiplatform_v1.types.PipelineTaskExecutorDetail.CustomJobDetail
google.cloud.aiplatform_v1.types.PipelineTemplateMetadata
PipelineTemplateMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Pipeline template metadata if PipelineJob.template_uri is from supported template registry.
See more: google.cloud.aiplatform_v1.types.PipelineTemplateMetadata
google.cloud.aiplatform_v1.types.Port
Port(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a network port in a container.
See more: google.cloud.aiplatform_v1.types.Port
google.cloud.aiplatform_v1.types.PredefinedSplit
PredefinedSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns input data to training, validation, and test sets based on the value of a provided key.
google.cloud.aiplatform_v1.types.PredictRequest
PredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.Predict.
google.cloud.aiplatform_v1.types.PredictRequestResponseLoggingConfig
PredictRequestResponseLoggingConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Configuration for logging request-response to a BigQuery table.
See more: google.cloud.aiplatform_v1.types.PredictRequestResponseLoggingConfig
google.cloud.aiplatform_v1.types.PredictResponse
PredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.Predict.
google.cloud.aiplatform_v1.types.PredictSchemata
PredictSchemata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob.
google.cloud.aiplatform_v1.types.Presets
Presets(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Preset configuration for example-based explanations.
See more: google.cloud.aiplatform_v1.types.Presets
google.cloud.aiplatform_v1.types.Presets.Modality
Modality(value)
Preset option controlling parameters for different modalities.
google.cloud.aiplatform_v1.types.Presets.Query
Query(value)
Preset option controlling parameters for query speed-precision trade-off.
google.cloud.aiplatform_v1.types.PrivateEndpoints
PrivateEndpoints(mapping=None, *, ignore_unknown_fields=False, **kwargs)
PrivateEndpoints proto is used to provide paths for users to send requests privately.
google.cloud.aiplatform_v1.types.PrivateServiceConnectConfig
PrivateServiceConnectConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents configuration for private service connect.
See more: google.cloud.aiplatform_v1.types.PrivateServiceConnectConfig
google.cloud.aiplatform_v1.types.Probe
Probe(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
See more: google.cloud.aiplatform_v1.types.Probe
google.cloud.aiplatform_v1.types.Probe.ExecAction
ExecAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)
ExecAction specifies a command to execute.
google.cloud.aiplatform_v1.types.PscAutomatedEndpoints
PscAutomatedEndpoints(mapping=None, *, ignore_unknown_fields=False, **kwargs)
PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig.
See more: google.cloud.aiplatform_v1.types.PscAutomatedEndpoints
google.cloud.aiplatform_v1.types.PublisherModel
PublisherModel(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A Model Garden Publisher Model.
google.cloud.aiplatform_v1.types.PublisherModel.CallToAction
CallToAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Actions could take on this Publisher Model.
See more: google.cloud.aiplatform_v1.types.PublisherModel.CallToAction
google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.Deploy
Deploy(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.
See more: google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.Deploy
google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.DeployGke
DeployGke(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configurations for PublisherModel GKE deployment .
See more: google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.DeployGke
google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.OpenFineTuningPipelines
OpenFineTuningPipelines(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Open fine tuning pipelines.
See more: google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.OpenFineTuningPipelines
google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.OpenNotebooks
OpenNotebooks(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Open notebooks.
See more: google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.OpenNotebooks
google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.RegionalResourceReferences
RegionalResourceReferences(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The regional resource name or the URI.
See more: google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.RegionalResourceReferences
google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.RegionalResourceReferences.ReferencesEntry
ReferencesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.ViewRestApi
ViewRestApi(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Rest API docs.
See more: google.cloud.aiplatform_v1.types.PublisherModel.CallToAction.ViewRestApi
google.cloud.aiplatform_v1.types.PublisherModel.Documentation
Documentation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A named piece of documentation.
See more: google.cloud.aiplatform_v1.types.PublisherModel.Documentation
google.cloud.aiplatform_v1.types.PublisherModel.LaunchStage
LaunchStage(value)
An enum representing the launch stage of a PublisherModel.
See more: google.cloud.aiplatform_v1.types.PublisherModel.LaunchStage
google.cloud.aiplatform_v1.types.PublisherModel.OpenSourceCategory
OpenSourceCategory(value)
An enum representing the open source category of a PublisherModel.
See more: google.cloud.aiplatform_v1.types.PublisherModel.OpenSourceCategory
google.cloud.aiplatform_v1.types.PublisherModel.ResourceReference
ResourceReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Reference to a resource.
See more: google.cloud.aiplatform_v1.types.PublisherModel.ResourceReference
google.cloud.aiplatform_v1.types.PublisherModel.VersionState
VersionState(value)
An enum representing the state of the PublicModelVersion.
See more: google.cloud.aiplatform_v1.types.PublisherModel.VersionState
google.cloud.aiplatform_v1.types.PublisherModelView
PublisherModelView(value)
View enumeration of PublisherModel.
See more: google.cloud.aiplatform_v1.types.PublisherModelView
google.cloud.aiplatform_v1.types.PurgeArtifactsMetadata
PurgeArtifactsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Details of operations that perform MetadataService.PurgeArtifacts.
See more: google.cloud.aiplatform_v1.types.PurgeArtifactsMetadata
google.cloud.aiplatform_v1.types.PurgeArtifactsRequest
PurgeArtifactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.PurgeArtifacts.
See more: google.cloud.aiplatform_v1.types.PurgeArtifactsRequest
google.cloud.aiplatform_v1.types.PurgeArtifactsResponse
PurgeArtifactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.PurgeArtifacts.
See more: google.cloud.aiplatform_v1.types.PurgeArtifactsResponse
google.cloud.aiplatform_v1.types.PurgeContextsMetadata
PurgeContextsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Details of operations that perform MetadataService.PurgeContexts.
See more: google.cloud.aiplatform_v1.types.PurgeContextsMetadata
google.cloud.aiplatform_v1.types.PurgeContextsRequest
PurgeContextsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.PurgeContexts.
See more: google.cloud.aiplatform_v1.types.PurgeContextsRequest
google.cloud.aiplatform_v1.types.PurgeContextsResponse
PurgeContextsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.PurgeContexts.
See more: google.cloud.aiplatform_v1.types.PurgeContextsResponse
google.cloud.aiplatform_v1.types.PurgeExecutionsMetadata
PurgeExecutionsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Details of operations that perform MetadataService.PurgeExecutions.
See more: google.cloud.aiplatform_v1.types.PurgeExecutionsMetadata
google.cloud.aiplatform_v1.types.PurgeExecutionsRequest
PurgeExecutionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.PurgeExecutions.
See more: google.cloud.aiplatform_v1.types.PurgeExecutionsRequest
google.cloud.aiplatform_v1.types.PurgeExecutionsResponse
PurgeExecutionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.PurgeExecutions.
See more: google.cloud.aiplatform_v1.types.PurgeExecutionsResponse
google.cloud.aiplatform_v1.types.PythonPackageSpec
PythonPackageSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The spec of a Python packaged code.
See more: google.cloud.aiplatform_v1.types.PythonPackageSpec
google.cloud.aiplatform_v1.types.QueryArtifactLineageSubgraphRequest
QueryArtifactLineageSubgraphRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for MetadataService.QueryArtifactLineageSubgraph.
See more: google.cloud.aiplatform_v1.types.QueryArtifactLineageSubgraphRequest
google.cloud.aiplatform_v1.types.QueryContextLineageSubgraphRequest
QueryContextLineageSubgraphRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for MetadataService.QueryContextLineageSubgraph.
See more: google.cloud.aiplatform_v1.types.QueryContextLineageSubgraphRequest
google.cloud.aiplatform_v1.types.QueryDeployedModelsRequest
QueryDeployedModelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for QueryDeployedModels method.
See more: google.cloud.aiplatform_v1.types.QueryDeployedModelsRequest
google.cloud.aiplatform_v1.types.QueryDeployedModelsResponse
QueryDeployedModelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for QueryDeployedModels method.
See more: google.cloud.aiplatform_v1.types.QueryDeployedModelsResponse
google.cloud.aiplatform_v1.types.QueryExecutionInputsAndOutputsRequest
QueryExecutionInputsAndOutputsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for MetadataService.QueryExecutionInputsAndOutputs.
See more: google.cloud.aiplatform_v1.types.QueryExecutionInputsAndOutputsRequest
google.cloud.aiplatform_v1.types.RawPredictRequest
RawPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.RawPredict.
See more: google.cloud.aiplatform_v1.types.RawPredictRequest
google.cloud.aiplatform_v1.types.RaySpec
RaySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration information for the Ray cluster.
See more: google.cloud.aiplatform_v1.types.RaySpec
google.cloud.aiplatform_v1.types.ReadFeatureValuesRequest
ReadFeatureValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreOnlineServingService.ReadFeatureValues.
See more: google.cloud.aiplatform_v1.types.ReadFeatureValuesRequest
google.cloud.aiplatform_v1.types.ReadFeatureValuesResponse
ReadFeatureValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreOnlineServingService.ReadFeatureValues.
See more: google.cloud.aiplatform_v1.types.ReadFeatureValuesResponse
google.cloud.aiplatform_v1.types.ReadFeatureValuesResponse.EntityView
EntityView(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Entity view with Feature values.
See more: google.cloud.aiplatform_v1.types.ReadFeatureValuesResponse.EntityView
google.cloud.aiplatform_v1.types.ReadFeatureValuesResponse.EntityView.Data
Data(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Container to hold value(s), successive in time, for one Feature from the request.
See more: google.cloud.aiplatform_v1.types.ReadFeatureValuesResponse.EntityView.Data
google.cloud.aiplatform_v1.types.ReadFeatureValuesResponse.FeatureDescriptor
FeatureDescriptor(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata for requested Features.
See more: google.cloud.aiplatform_v1.types.ReadFeatureValuesResponse.FeatureDescriptor
google.cloud.aiplatform_v1.types.ReadFeatureValuesResponse.Header
Header(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response header with metadata for the requested ReadFeatureValuesRequest.entity_type and Features.
See more: google.cloud.aiplatform_v1.types.ReadFeatureValuesResponse.Header
google.cloud.aiplatform_v1.types.ReadIndexDatapointsRequest
ReadIndexDatapointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The request message for MatchService.ReadIndexDatapoints.
See more: google.cloud.aiplatform_v1.types.ReadIndexDatapointsRequest
google.cloud.aiplatform_v1.types.ReadIndexDatapointsResponse
ReadIndexDatapointsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The response message for MatchService.ReadIndexDatapoints.
See more: google.cloud.aiplatform_v1.types.ReadIndexDatapointsResponse
google.cloud.aiplatform_v1.types.ReadTensorboardBlobDataRequest
ReadTensorboardBlobDataRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.ReadTensorboardBlobData.
See more: google.cloud.aiplatform_v1.types.ReadTensorboardBlobDataRequest
google.cloud.aiplatform_v1.types.ReadTensorboardBlobDataResponse
ReadTensorboardBlobDataResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.ReadTensorboardBlobData.
See more: google.cloud.aiplatform_v1.types.ReadTensorboardBlobDataResponse
google.cloud.aiplatform_v1.types.ReadTensorboardSizeRequest
ReadTensorboardSizeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.ReadTensorboardSize.
See more: google.cloud.aiplatform_v1.types.ReadTensorboardSizeRequest
google.cloud.aiplatform_v1.types.ReadTensorboardSizeResponse
ReadTensorboardSizeResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for TensorboardService.ReadTensorboardSize.
See more: google.cloud.aiplatform_v1.types.ReadTensorboardSizeResponse
google.cloud.aiplatform_v1.types.ReadTensorboardTimeSeriesDataRequest
ReadTensorboardTimeSeriesDataRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.ReadTensorboardTimeSeriesData.
See more: google.cloud.aiplatform_v1.types.ReadTensorboardTimeSeriesDataRequest
google.cloud.aiplatform_v1.types.ReadTensorboardTimeSeriesDataResponse
ReadTensorboardTimeSeriesDataResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.ReadTensorboardTimeSeriesData.
See more: google.cloud.aiplatform_v1.types.ReadTensorboardTimeSeriesDataResponse
google.cloud.aiplatform_v1.types.ReadTensorboardUsageRequest
ReadTensorboardUsageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.ReadTensorboardUsage.
See more: google.cloud.aiplatform_v1.types.ReadTensorboardUsageRequest
google.cloud.aiplatform_v1.types.ReadTensorboardUsageResponse
ReadTensorboardUsageResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.ReadTensorboardUsage.
See more: google.cloud.aiplatform_v1.types.ReadTensorboardUsageResponse
google.cloud.aiplatform_v1.types.ReadTensorboardUsageResponse.MonthlyUsageDataEntry
MonthlyUsageDataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.ReadTensorboardUsageResponse.MonthlyUsageDataEntry
google.cloud.aiplatform_v1.types.ReadTensorboardUsageResponse.PerMonthUsageData
PerMonthUsageData(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Per month usage data .
See more: google.cloud.aiplatform_v1.types.ReadTensorboardUsageResponse.PerMonthUsageData
google.cloud.aiplatform_v1.types.ReadTensorboardUsageResponse.PerUserUsageData
PerUserUsageData(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Per user usage data.
See more: google.cloud.aiplatform_v1.types.ReadTensorboardUsageResponse.PerUserUsageData
google.cloud.aiplatform_v1.types.RebootPersistentResourceOperationMetadata
RebootPersistentResourceOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform reboot PersistentResource.
See more: google.cloud.aiplatform_v1.types.RebootPersistentResourceOperationMetadata
google.cloud.aiplatform_v1.types.RebootPersistentResourceRequest
RebootPersistentResourceRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PersistentResourceService.RebootPersistentResource.
See more: google.cloud.aiplatform_v1.types.RebootPersistentResourceRequest
google.cloud.aiplatform_v1.types.RemoveContextChildrenRequest
RemoveContextChildrenRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for [MetadataService.DeleteContextChildrenRequest][].
See more: google.cloud.aiplatform_v1.types.RemoveContextChildrenRequest
google.cloud.aiplatform_v1.types.RemoveContextChildrenResponse
RemoveContextChildrenResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for MetadataService.RemoveContextChildren.
See more: google.cloud.aiplatform_v1.types.RemoveContextChildrenResponse
google.cloud.aiplatform_v1.types.RemoveDatapointsRequest
RemoveDatapointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.RemoveDatapoints .
See more: google.cloud.aiplatform_v1.types.RemoveDatapointsRequest
google.cloud.aiplatform_v1.types.RemoveDatapointsResponse
RemoveDatapointsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexService.RemoveDatapoints .
See more: google.cloud.aiplatform_v1.types.RemoveDatapointsResponse
google.cloud.aiplatform_v1.types.ResourcePool
ResourcePool(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.
google.cloud.aiplatform_v1.types.ResourcePool.AutoscalingSpec
AutoscalingSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The min/max number of replicas allowed if enabling autoscaling.
See more: google.cloud.aiplatform_v1.types.ResourcePool.AutoscalingSpec
google.cloud.aiplatform_v1.types.ResourceRuntime
ResourceRuntime(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Persistent Cluster runtime information as output.
google.cloud.aiplatform_v1.types.ResourceRuntimeSpec
ResourceRuntimeSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for the runtime on a PersistentResource instance, including but not limited to:.
See more: google.cloud.aiplatform_v1.types.ResourceRuntimeSpec
google.cloud.aiplatform_v1.types.ResourcesConsumed
ResourcesConsumed(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Statistics information about resource consumption.
See more: google.cloud.aiplatform_v1.types.ResourcesConsumed
google.cloud.aiplatform_v1.types.RestoreDatasetVersionOperationMetadata
RestoreDatasetVersionOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for DatasetService.RestoreDatasetVersion.
See more: google.cloud.aiplatform_v1.types.RestoreDatasetVersionOperationMetadata
google.cloud.aiplatform_v1.types.RestoreDatasetVersionRequest
RestoreDatasetVersionRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for DatasetService.RestoreDatasetVersion.
See more: google.cloud.aiplatform_v1.types.RestoreDatasetVersionRequest
google.cloud.aiplatform_v1.types.ResumeModelDeploymentMonitoringJobRequest
ResumeModelDeploymentMonitoringJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.ResumeModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1.types.ResumeModelDeploymentMonitoringJobRequest
google.cloud.aiplatform_v1.types.ResumeScheduleRequest
ResumeScheduleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.ResumeSchedule.
See more: google.cloud.aiplatform_v1.types.ResumeScheduleRequest
google.cloud.aiplatform_v1.types.Retrieval
Retrieval(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Defines a retrieval tool that model can call to access external knowledge.
google.cloud.aiplatform_v1.types.SafetyRating
SafetyRating(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Safety rating corresponding to the generated content.
google.cloud.aiplatform_v1.types.SafetyRating.HarmProbability
HarmProbability(value)
Harm probability levels in the content.
See more: google.cloud.aiplatform_v1.types.SafetyRating.HarmProbability
google.cloud.aiplatform_v1.types.SafetyRating.HarmSeverity
HarmSeverity(value)
Harm severity levels.
See more: google.cloud.aiplatform_v1.types.SafetyRating.HarmSeverity
google.cloud.aiplatform_v1.types.SafetySetting
SafetySetting(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Safety settings.
google.cloud.aiplatform_v1.types.SafetySetting.HarmBlockMethod
HarmBlockMethod(value)
Probability vs severity.
See more: google.cloud.aiplatform_v1.types.SafetySetting.HarmBlockMethod
google.cloud.aiplatform_v1.types.SafetySetting.HarmBlockThreshold
HarmBlockThreshold(value)
Probability based thresholds levels for blocking.
See more: google.cloud.aiplatform_v1.types.SafetySetting.HarmBlockThreshold
google.cloud.aiplatform_v1.types.SampleConfig
SampleConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Active learning data sampling config.
google.cloud.aiplatform_v1.types.SampleConfig.SampleStrategy
SampleStrategy(value)
Sample strategy decides which subset of DataItems should be selected for human labeling in every batch.
See more: google.cloud.aiplatform_v1.types.SampleConfig.SampleStrategy
google.cloud.aiplatform_v1.types.SampledShapleyAttribution
SampledShapleyAttribution(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An attribution method that approximates Shapley values for features that contribute to the label being predicted.
See more: google.cloud.aiplatform_v1.types.SampledShapleyAttribution
google.cloud.aiplatform_v1.types.SamplingStrategy
SamplingStrategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Sampling Strategy for logging, can be for both training and prediction dataset.
google.cloud.aiplatform_v1.types.SamplingStrategy.RandomSampleConfig
RandomSampleConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Requests are randomly selected.
See more: google.cloud.aiplatform_v1.types.SamplingStrategy.RandomSampleConfig
google.cloud.aiplatform_v1.types.SavedQuery
SavedQuery(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A SavedQuery is a view of the dataset.
google.cloud.aiplatform_v1.types.Scalar
Scalar(mapping=None, *, ignore_unknown_fields=False, **kwargs)
One point viewable on a scalar metric plot.
See more: google.cloud.aiplatform_v1.types.Scalar
google.cloud.aiplatform_v1.types.Schedule
Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
google.cloud.aiplatform_v1.types.Schedule.RunResponse
RunResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Status of a scheduled run.
See more: google.cloud.aiplatform_v1.types.Schedule.RunResponse
google.cloud.aiplatform_v1.types.Schedule.State
State(value)
Possible state of the schedule.
google.cloud.aiplatform_v1.types.Scheduling
Scheduling(mapping=None, *, ignore_unknown_fields=False, **kwargs)
All parameters related to queuing and scheduling of custom jobs.
google.cloud.aiplatform_v1.types.Schema
Schema(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Schema is used to define the format of input/output data.
See more: google.cloud.aiplatform_v1.types.Schema
google.cloud.aiplatform_v1.types.Schema.PropertiesEntry
PropertiesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Schema.PropertiesEntry
google.cloud.aiplatform_v1.types.SearchDataItemsRequest
SearchDataItemsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.SearchDataItems.
See more: google.cloud.aiplatform_v1.types.SearchDataItemsRequest
google.cloud.aiplatform_v1.types.SearchDataItemsRequest.OrderByAnnotation
OrderByAnnotation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Expression that allows ranking results based on annotation's property.
See more: google.cloud.aiplatform_v1.types.SearchDataItemsRequest.OrderByAnnotation
google.cloud.aiplatform_v1.types.SearchDataItemsResponse
SearchDataItemsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.SearchDataItems.
See more: google.cloud.aiplatform_v1.types.SearchDataItemsResponse
google.cloud.aiplatform_v1.types.SearchFeaturesRequest
SearchFeaturesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.SearchFeatures.
See more: google.cloud.aiplatform_v1.types.SearchFeaturesRequest
google.cloud.aiplatform_v1.types.SearchFeaturesResponse
SearchFeaturesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.SearchFeatures.
See more: google.cloud.aiplatform_v1.types.SearchFeaturesResponse
google.cloud.aiplatform_v1.types.SearchMigratableResourcesRequest
SearchMigratableResourcesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for MigrationService.SearchMigratableResources.
See more: google.cloud.aiplatform_v1.types.SearchMigratableResourcesRequest
google.cloud.aiplatform_v1.types.SearchMigratableResourcesResponse
SearchMigratableResourcesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for MigrationService.SearchMigratableResources.
See more: google.cloud.aiplatform_v1.types.SearchMigratableResourcesResponse
google.cloud.aiplatform_v1.types.SearchModelDeploymentMonitoringStatsAnomaliesRequest
SearchModelDeploymentMonitoringStatsAnomaliesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.
See more: google.cloud.aiplatform_v1.types.SearchModelDeploymentMonitoringStatsAnomaliesRequest
google.cloud.aiplatform_v1.types.SearchModelDeploymentMonitoringStatsAnomaliesRequest.StatsAnomaliesObjective
StatsAnomaliesObjective(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Stats requested for specific objective.
google.cloud.aiplatform_v1.types.SearchModelDeploymentMonitoringStatsAnomaliesResponse
SearchModelDeploymentMonitoringStatsAnomaliesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.
See more: google.cloud.aiplatform_v1.types.SearchModelDeploymentMonitoringStatsAnomaliesResponse
google.cloud.aiplatform_v1.types.SearchNearestEntitiesRequest
SearchNearestEntitiesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The request message for FeatureOnlineStoreService.SearchNearestEntities.
See more: google.cloud.aiplatform_v1.types.SearchNearestEntitiesRequest
google.cloud.aiplatform_v1.types.SearchNearestEntitiesResponse
SearchNearestEntitiesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for FeatureOnlineStoreService.SearchNearestEntities .
See more: google.cloud.aiplatform_v1.types.SearchNearestEntitiesResponse
google.cloud.aiplatform_v1.types.Segment
Segment(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Segment of the content.
See more: google.cloud.aiplatform_v1.types.Segment
google.cloud.aiplatform_v1.types.ServiceAccountSpec
ServiceAccountSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for the use of custom service account to run the workloads.
See more: google.cloud.aiplatform_v1.types.ServiceAccountSpec
google.cloud.aiplatform_v1.types.ShieldedVmConfig
ShieldedVmConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A set of Shielded Instance options.
google.cloud.aiplatform_v1.types.SmoothGradConfig
SmoothGradConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for SmoothGrad approximation of gradients.
google.cloud.aiplatform_v1.types.SpecialistPool
SpecialistPool(mapping=None, *, ignore_unknown_fields=False, **kwargs)
SpecialistPool represents customers' own workforce to work on their data labeling jobs.
google.cloud.aiplatform_v1.types.StartNotebookRuntimeOperationMetadata
StartNotebookRuntimeOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Metadata information for NotebookService.StartNotebookRuntime.
See more: google.cloud.aiplatform_v1.types.StartNotebookRuntimeOperationMetadata
google.cloud.aiplatform_v1.types.StartNotebookRuntimeRequest
StartNotebookRuntimeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for NotebookService.StartNotebookRuntime.
See more: google.cloud.aiplatform_v1.types.StartNotebookRuntimeRequest
google.cloud.aiplatform_v1.types.StartNotebookRuntimeResponse
StartNotebookRuntimeResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for NotebookService.StartNotebookRuntime.
See more: google.cloud.aiplatform_v1.types.StartNotebookRuntimeResponse
google.cloud.aiplatform_v1.types.StopTrialRequest
StopTrialRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.StopTrial.
google.cloud.aiplatform_v1.types.StratifiedSplit
StratifiedSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns input data to the training, validation, and test sets so
that the distribution of values found in the categorical column (as
specified by the key
field) is mirrored within each split.
google.cloud.aiplatform_v1.types.StreamDirectPredictRequest
StreamDirectPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.StreamDirectPredict.
See more: google.cloud.aiplatform_v1.types.StreamDirectPredictRequest
google.cloud.aiplatform_v1.types.StreamDirectPredictResponse
StreamDirectPredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.StreamDirectPredict.
See more: google.cloud.aiplatform_v1.types.StreamDirectPredictResponse
google.cloud.aiplatform_v1.types.StreamDirectRawPredictRequest
StreamDirectRawPredictRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PredictionService.StreamDirectRawPredict.
See more: google.cloud.aiplatform_v1.types.StreamDirectRawPredictRequest
google.cloud.aiplatform_v1.types.StreamDirectRawPredictResponse
StreamDirectRawPredictResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for PredictionService.StreamDirectRawPredict.
See more: google.cloud.aiplatform_v1.types.StreamDirectRawPredictResponse
google.cloud.aiplatform_v1.types.StreamRawPredictRequest
StreamRawPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.StreamRawPredict.
See more: google.cloud.aiplatform_v1.types.StreamRawPredictRequest
google.cloud.aiplatform_v1.types.StreamingPredictRequest
StreamingPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.StreamingPredict.
See more: google.cloud.aiplatform_v1.types.StreamingPredictRequest
google.cloud.aiplatform_v1.types.StreamingPredictResponse
StreamingPredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.StreamingPredict.
See more: google.cloud.aiplatform_v1.types.StreamingPredictResponse
google.cloud.aiplatform_v1.types.StreamingRawPredictRequest
StreamingRawPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.StreamingRawPredict.
See more: google.cloud.aiplatform_v1.types.StreamingRawPredictRequest
google.cloud.aiplatform_v1.types.StreamingRawPredictResponse
StreamingRawPredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.StreamingRawPredict.
See more: google.cloud.aiplatform_v1.types.StreamingRawPredictResponse
google.cloud.aiplatform_v1.types.StreamingReadFeatureValuesRequest
StreamingReadFeatureValuesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for [FeaturestoreOnlineServingService.StreamingFeatureValuesRead][].
See more: google.cloud.aiplatform_v1.types.StreamingReadFeatureValuesRequest
google.cloud.aiplatform_v1.types.StringArray
StringArray(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of string values.
google.cloud.aiplatform_v1.types.Study
Study(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A message representing a Study.
See more: google.cloud.aiplatform_v1.types.Study
google.cloud.aiplatform_v1.types.Study.State
State(value)
Describes the Study state.
google.cloud.aiplatform_v1.types.StudySpec
StudySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents specification of a Study.
google.cloud.aiplatform_v1.types.StudySpec.Algorithm
Algorithm(value)
The available search algorithms for the Study.
See more: google.cloud.aiplatform_v1.types.StudySpec.Algorithm
google.cloud.aiplatform_v1.types.StudySpec.ConvexAutomatedStoppingSpec
ConvexAutomatedStoppingSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for ConvexAutomatedStoppingSpec.
See more: google.cloud.aiplatform_v1.types.StudySpec.ConvexAutomatedStoppingSpec
google.cloud.aiplatform_v1.types.StudySpec.DecayCurveAutomatedStoppingSpec
DecayCurveAutomatedStoppingSpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The decay curve automated stopping rule builds a Gaussian Process Regressor to predict the final objective value of a Trial based on the already completed Trials and the intermediate measurements of the current Trial.
See more: google.cloud.aiplatform_v1.types.StudySpec.DecayCurveAutomatedStoppingSpec
google.cloud.aiplatform_v1.types.StudySpec.MeasurementSelectionType
MeasurementSelectionType(value)
This indicates which measurement to use if/when the service automatically selects the final measurement from previously reported intermediate measurements.
See more: google.cloud.aiplatform_v1.types.StudySpec.MeasurementSelectionType
google.cloud.aiplatform_v1.types.StudySpec.MedianAutomatedStoppingSpec
MedianAutomatedStoppingSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The median automated stopping rule stops a pending Trial if the Trial's best objective_value is strictly below the median 'performance' of all completed Trials reported up to the Trial's last measurement.
See more: google.cloud.aiplatform_v1.types.StudySpec.MedianAutomatedStoppingSpec
google.cloud.aiplatform_v1.types.StudySpec.MetricSpec
MetricSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a metric to optimize.
See more: google.cloud.aiplatform_v1.types.StudySpec.MetricSpec
google.cloud.aiplatform_v1.types.StudySpec.MetricSpec.GoalType
GoalType(value)
The available types of optimization goals.
See more: google.cloud.aiplatform_v1.types.StudySpec.MetricSpec.GoalType
google.cloud.aiplatform_v1.types.StudySpec.MetricSpec.SafetyMetricConfig
SafetyMetricConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Used in safe optimization to specify threshold levels and risk tolerance.
See more: google.cloud.aiplatform_v1.types.StudySpec.MetricSpec.SafetyMetricConfig
google.cloud.aiplatform_v1.types.StudySpec.ObservationNoise
ObservationNoise(value)
Describes the noise level of the repeated observations.
See more: google.cloud.aiplatform_v1.types.StudySpec.ObservationNoise
google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec
ParameterSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a single parameter to optimize.
See more: google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec
google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.CategoricalValueSpec
CategoricalValueSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Value specification for a parameter in CATEGORICAL
type.
See more: google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.CategoricalValueSpec
google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.ConditionalParameterSpec
ConditionalParameterSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a parameter spec with condition from its parent parameter.
See more: google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.ConditionalParameterSpec
google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.ConditionalParameterSpec.CategoricalValueCondition
CategoricalValueCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec to match categorical values from parent parameter.
google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.ConditionalParameterSpec.DiscreteValueCondition
DiscreteValueCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec to match discrete values from parent parameter.
google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.ConditionalParameterSpec.IntValueCondition
IntValueCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec to match integer values from parent parameter.
See more: google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.ConditionalParameterSpec.IntValueCondition
google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.DiscreteValueSpec
DiscreteValueSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Value specification for a parameter in DISCRETE
type.
See more: google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.DiscreteValueSpec
google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.DoubleValueSpec
DoubleValueSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Value specification for a parameter in DOUBLE
type.
See more: google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.DoubleValueSpec
google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.IntegerValueSpec
IntegerValueSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Value specification for a parameter in INTEGER
type.
See more: google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.IntegerValueSpec
google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.ScaleType
ScaleType(value)
The type of scaling that should be applied to this parameter.
See more: google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.ScaleType
google.cloud.aiplatform_v1.types.StudySpec.StudyStoppingConfig
StudyStoppingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The configuration (stopping conditions) for automated stopping of a Study.
See more: google.cloud.aiplatform_v1.types.StudySpec.StudyStoppingConfig
google.cloud.aiplatform_v1.types.StudyTimeConstraint
StudyTimeConstraint(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Time-based Constraint for Study.
See more: google.cloud.aiplatform_v1.types.StudyTimeConstraint
google.cloud.aiplatform_v1.types.SuggestTrialsMetadata
SuggestTrialsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Details of operations that perform Trials suggestion.
See more: google.cloud.aiplatform_v1.types.SuggestTrialsMetadata
google.cloud.aiplatform_v1.types.SuggestTrialsRequest
SuggestTrialsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.SuggestTrials.
See more: google.cloud.aiplatform_v1.types.SuggestTrialsRequest
google.cloud.aiplatform_v1.types.SuggestTrialsResponse
SuggestTrialsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VizierService.SuggestTrials.
See more: google.cloud.aiplatform_v1.types.SuggestTrialsResponse
google.cloud.aiplatform_v1.types.SupervisedHyperParameters
SupervisedHyperParameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Hyperparameters for SFT.
See more: google.cloud.aiplatform_v1.types.SupervisedHyperParameters
google.cloud.aiplatform_v1.types.SupervisedHyperParameters.AdapterSize
AdapterSize(value)
Supported adapter sizes for tuning.
See more: google.cloud.aiplatform_v1.types.SupervisedHyperParameters.AdapterSize
google.cloud.aiplatform_v1.types.SupervisedTuningDataStats
SupervisedTuningDataStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tuning data statistics for Supervised Tuning.
See more: google.cloud.aiplatform_v1.types.SupervisedTuningDataStats
google.cloud.aiplatform_v1.types.SupervisedTuningDatasetDistribution
SupervisedTuningDatasetDistribution(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Dataset distribution for Supervised Tuning.
See more: google.cloud.aiplatform_v1.types.SupervisedTuningDatasetDistribution
google.cloud.aiplatform_v1.types.SupervisedTuningDatasetDistribution.DatasetBucket
DatasetBucket(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Dataset bucket used to create a histogram for the distribution given a population of values.
See more: google.cloud.aiplatform_v1.types.SupervisedTuningDatasetDistribution.DatasetBucket
google.cloud.aiplatform_v1.types.SupervisedTuningSpec
SupervisedTuningSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tuning Spec for Supervised Tuning.
See more: google.cloud.aiplatform_v1.types.SupervisedTuningSpec
google.cloud.aiplatform_v1.types.SyncFeatureViewRequest
SyncFeatureViewRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.SyncFeatureView.
See more: google.cloud.aiplatform_v1.types.SyncFeatureViewRequest
google.cloud.aiplatform_v1.types.SyncFeatureViewResponse
SyncFeatureViewResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Respose message for FeatureOnlineStoreAdminService.SyncFeatureView.
See more: google.cloud.aiplatform_v1.types.SyncFeatureViewResponse
google.cloud.aiplatform_v1.types.TFRecordDestination
TFRecordDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The storage details for TFRecord output content.
See more: google.cloud.aiplatform_v1.types.TFRecordDestination
google.cloud.aiplatform_v1.types.Tensor
Tensor(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A tensor value type.
See more: google.cloud.aiplatform_v1.types.Tensor
google.cloud.aiplatform_v1.types.Tensor.DataType
DataType(value)
Data type of the tensor.
google.cloud.aiplatform_v1.types.Tensor.StructValEntry
StructValEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Tensor.StructValEntry
google.cloud.aiplatform_v1.types.Tensorboard
Tensorboard(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tensorboard is a physical database that stores users' training metrics.
google.cloud.aiplatform_v1.types.Tensorboard.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Tensorboard.LabelsEntry
google.cloud.aiplatform_v1.types.TensorboardBlob
TensorboardBlob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
One blob (e.g, image, graph) viewable on a blob metric plot.
google.cloud.aiplatform_v1.types.TensorboardBlobSequence
TensorboardBlobSequence(mapping=None, *, ignore_unknown_fields=False, **kwargs)
One point viewable on a blob metric plot, but mostly just a wrapper
message to work around repeated fields can't be used directly within
oneof
fields.
See more: google.cloud.aiplatform_v1.types.TensorboardBlobSequence
google.cloud.aiplatform_v1.types.TensorboardExperiment
TensorboardExperiment(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.
See more: google.cloud.aiplatform_v1.types.TensorboardExperiment
google.cloud.aiplatform_v1.types.TensorboardExperiment.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.TensorboardExperiment.LabelsEntry
google.cloud.aiplatform_v1.types.TensorboardRun
TensorboardRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)
TensorboardRun maps to a specific execution of a training job with a given set of hyperparameter values, model definition, dataset, etc .
google.cloud.aiplatform_v1.types.TensorboardRun.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.TensorboardRun.LabelsEntry
google.cloud.aiplatform_v1.types.TensorboardTensor
TensorboardTensor(mapping=None, *, ignore_unknown_fields=False, **kwargs)
One point viewable on a tensor metric plot.
See more: google.cloud.aiplatform_v1.types.TensorboardTensor
google.cloud.aiplatform_v1.types.TensorboardTimeSeries
TensorboardTimeSeries(mapping=None, *, ignore_unknown_fields=False, **kwargs)
TensorboardTimeSeries maps to times series produced in training runs .
See more: google.cloud.aiplatform_v1.types.TensorboardTimeSeries
google.cloud.aiplatform_v1.types.TensorboardTimeSeries.Metadata
Metadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes metadata for a TensorboardTimeSeries.
See more: google.cloud.aiplatform_v1.types.TensorboardTimeSeries.Metadata
google.cloud.aiplatform_v1.types.TensorboardTimeSeries.ValueType
ValueType(value)
An enum representing the value type of a TensorboardTimeSeries.
See more: google.cloud.aiplatform_v1.types.TensorboardTimeSeries.ValueType
google.cloud.aiplatform_v1.types.ThresholdConfig
ThresholdConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The config for feature monitoring threshold.
google.cloud.aiplatform_v1.types.TimeSeriesData
TimeSeriesData(mapping=None, *, ignore_unknown_fields=False, **kwargs)
All the data stored in a TensorboardTimeSeries.
google.cloud.aiplatform_v1.types.TimeSeriesDataPoint
TimeSeriesDataPoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TensorboardTimeSeries data point.
See more: google.cloud.aiplatform_v1.types.TimeSeriesDataPoint
google.cloud.aiplatform_v1.types.TimestampSplit
TimestampSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns input data to training, validation, and test sets based on a provided timestamps.
google.cloud.aiplatform_v1.types.TokensInfo
TokensInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tokens info with a list of tokens and the corresponding list of token ids.
google.cloud.aiplatform_v1.types.Tool
Tool(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tool details that the model may use to generate response.
See more: google.cloud.aiplatform_v1.types.Tool
google.cloud.aiplatform_v1.types.TrainingConfig
TrainingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
CMLE training config.
google.cloud.aiplatform_v1.types.TrainingPipeline
TrainingPipeline(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The TrainingPipeline orchestrates tasks associated with training a Model.
google.cloud.aiplatform_v1.types.TrainingPipeline.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.TrainingPipeline.LabelsEntry
google.cloud.aiplatform_v1.types.Trial
Trial(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A message representing a Trial.
See more: google.cloud.aiplatform_v1.types.Trial
google.cloud.aiplatform_v1.types.Trial.Parameter
Parameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A message representing a parameter to be tuned.
google.cloud.aiplatform_v1.types.Trial.State
State(value)
Describes a Trial state.
google.cloud.aiplatform_v1.types.Trial.WebAccessUrisEntry
WebAccessUrisEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.Trial.WebAccessUrisEntry
google.cloud.aiplatform_v1.types.TrialContext
TrialContext(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Next ID: 3 .
google.cloud.aiplatform_v1.types.TunedModel
TunedModel(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob.
google.cloud.aiplatform_v1.types.TuningDataStats
TuningDataStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The tuning data statistic values for TuningJob.
google.cloud.aiplatform_v1.types.TuningJob
TuningJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a TuningJob that runs with Google owned models.
google.cloud.aiplatform_v1.types.TuningJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.TuningJob.LabelsEntry
google.cloud.aiplatform_v1.types.Type
Type(value)
Type contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/.
See more: google.cloud.aiplatform_v1.types.Type
google.cloud.aiplatform_v1.types.UndeployIndexOperationMetadata
UndeployIndexOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for IndexEndpointService.UndeployIndex.
See more: google.cloud.aiplatform_v1.types.UndeployIndexOperationMetadata
google.cloud.aiplatform_v1.types.UndeployIndexRequest
UndeployIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.UndeployIndex.
See more: google.cloud.aiplatform_v1.types.UndeployIndexRequest
google.cloud.aiplatform_v1.types.UndeployIndexResponse
UndeployIndexResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexEndpointService.UndeployIndex.
See more: google.cloud.aiplatform_v1.types.UndeployIndexResponse
google.cloud.aiplatform_v1.types.UndeployModelOperationMetadata
UndeployModelOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for EndpointService.UndeployModel.
See more: google.cloud.aiplatform_v1.types.UndeployModelOperationMetadata
google.cloud.aiplatform_v1.types.UndeployModelRequest
UndeployModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.UndeployModel.
See more: google.cloud.aiplatform_v1.types.UndeployModelRequest
google.cloud.aiplatform_v1.types.UndeployModelRequest.TrafficSplitEntry
TrafficSplitEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.UndeployModelRequest.TrafficSplitEntry
google.cloud.aiplatform_v1.types.UndeployModelResponse
UndeployModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for EndpointService.UndeployModel.
See more: google.cloud.aiplatform_v1.types.UndeployModelResponse
google.cloud.aiplatform_v1.types.UnmanagedContainerModel
UnmanagedContainerModel(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains model information necessary to perform batch prediction without requiring a full model import.
See more: google.cloud.aiplatform_v1.types.UnmanagedContainerModel
google.cloud.aiplatform_v1.types.UpdateArtifactRequest
UpdateArtifactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.UpdateArtifact.
See more: google.cloud.aiplatform_v1.types.UpdateArtifactRequest
google.cloud.aiplatform_v1.types.UpdateContextRequest
UpdateContextRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.UpdateContext.
See more: google.cloud.aiplatform_v1.types.UpdateContextRequest
google.cloud.aiplatform_v1.types.UpdateDatasetRequest
UpdateDatasetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.UpdateDataset.
See more: google.cloud.aiplatform_v1.types.UpdateDatasetRequest
google.cloud.aiplatform_v1.types.UpdateDeploymentResourcePoolOperationMetadata
UpdateDeploymentResourcePoolOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for UpdateDeploymentResourcePool method.
See more: google.cloud.aiplatform_v1.types.UpdateDeploymentResourcePoolOperationMetadata
google.cloud.aiplatform_v1.types.UpdateEndpointRequest
UpdateEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.UpdateEndpoint.
See more: google.cloud.aiplatform_v1.types.UpdateEndpointRequest
google.cloud.aiplatform_v1.types.UpdateEntityTypeRequest
UpdateEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.UpdateEntityType.
See more: google.cloud.aiplatform_v1.types.UpdateEntityTypeRequest
google.cloud.aiplatform_v1.types.UpdateExecutionRequest
UpdateExecutionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.UpdateExecution.
See more: google.cloud.aiplatform_v1.types.UpdateExecutionRequest
google.cloud.aiplatform_v1.types.UpdateExplanationDatasetOperationMetadata
UpdateExplanationDatasetOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for ModelService.UpdateExplanationDataset.
See more: google.cloud.aiplatform_v1.types.UpdateExplanationDatasetOperationMetadata
google.cloud.aiplatform_v1.types.UpdateExplanationDatasetRequest
UpdateExplanationDatasetRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ModelService.UpdateExplanationDataset.
See more: google.cloud.aiplatform_v1.types.UpdateExplanationDatasetRequest
google.cloud.aiplatform_v1.types.UpdateExplanationDatasetResponse
UpdateExplanationDatasetResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message of ModelService.UpdateExplanationDataset operation.
See more: google.cloud.aiplatform_v1.types.UpdateExplanationDatasetResponse
google.cloud.aiplatform_v1.types.UpdateFeatureGroupOperationMetadata
UpdateFeatureGroupOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update FeatureGroup.
See more: google.cloud.aiplatform_v1.types.UpdateFeatureGroupOperationMetadata
google.cloud.aiplatform_v1.types.UpdateFeatureGroupRequest
UpdateFeatureGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureRegistryService.UpdateFeatureGroup.
See more: google.cloud.aiplatform_v1.types.UpdateFeatureGroupRequest
google.cloud.aiplatform_v1.types.UpdateFeatureOnlineStoreOperationMetadata
UpdateFeatureOnlineStoreOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update FeatureOnlineStore.
See more: google.cloud.aiplatform_v1.types.UpdateFeatureOnlineStoreOperationMetadata
google.cloud.aiplatform_v1.types.UpdateFeatureOnlineStoreRequest
UpdateFeatureOnlineStoreRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeatureOnlineStoreAdminService.UpdateFeatureOnlineStore.
See more: google.cloud.aiplatform_v1.types.UpdateFeatureOnlineStoreRequest
google.cloud.aiplatform_v1.types.UpdateFeatureOperationMetadata
UpdateFeatureOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update Feature.
See more: google.cloud.aiplatform_v1.types.UpdateFeatureOperationMetadata
google.cloud.aiplatform_v1.types.UpdateFeatureRequest
UpdateFeatureRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.UpdateFeature.
See more: google.cloud.aiplatform_v1.types.UpdateFeatureRequest
google.cloud.aiplatform_v1.types.UpdateFeatureViewOperationMetadata
UpdateFeatureViewOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update FeatureView.
See more: google.cloud.aiplatform_v1.types.UpdateFeatureViewOperationMetadata
google.cloud.aiplatform_v1.types.UpdateFeatureViewRequest
UpdateFeatureViewRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.UpdateFeatureView.
See more: google.cloud.aiplatform_v1.types.UpdateFeatureViewRequest
google.cloud.aiplatform_v1.types.UpdateFeaturestoreOperationMetadata
UpdateFeaturestoreOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update Featurestore.
See more: google.cloud.aiplatform_v1.types.UpdateFeaturestoreOperationMetadata
google.cloud.aiplatform_v1.types.UpdateFeaturestoreRequest
UpdateFeaturestoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.UpdateFeaturestore.
See more: google.cloud.aiplatform_v1.types.UpdateFeaturestoreRequest
google.cloud.aiplatform_v1.types.UpdateIndexEndpointRequest
UpdateIndexEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.UpdateIndexEndpoint.
See more: google.cloud.aiplatform_v1.types.UpdateIndexEndpointRequest
google.cloud.aiplatform_v1.types.UpdateIndexOperationMetadata
UpdateIndexOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for IndexService.UpdateIndex.
See more: google.cloud.aiplatform_v1.types.UpdateIndexOperationMetadata
google.cloud.aiplatform_v1.types.UpdateIndexRequest
UpdateIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.UpdateIndex.
See more: google.cloud.aiplatform_v1.types.UpdateIndexRequest
google.cloud.aiplatform_v1.types.UpdateModelDeploymentMonitoringJobOperationMetadata
UpdateModelDeploymentMonitoringJobOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for JobService.UpdateModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1.types.UpdateModelDeploymentMonitoringJobOperationMetadata
google.cloud.aiplatform_v1.types.UpdateModelDeploymentMonitoringJobRequest
UpdateModelDeploymentMonitoringJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.UpdateModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1.types.UpdateModelDeploymentMonitoringJobRequest
google.cloud.aiplatform_v1.types.UpdateModelRequest
UpdateModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.UpdateModel.
See more: google.cloud.aiplatform_v1.types.UpdateModelRequest
google.cloud.aiplatform_v1.types.UpdatePersistentResourceOperationMetadata
UpdatePersistentResourceOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update PersistentResource.
See more: google.cloud.aiplatform_v1.types.UpdatePersistentResourceOperationMetadata
google.cloud.aiplatform_v1.types.UpdatePersistentResourceRequest
UpdatePersistentResourceRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for UpdatePersistentResource method.
See more: google.cloud.aiplatform_v1.types.UpdatePersistentResourceRequest
google.cloud.aiplatform_v1.types.UpdateScheduleRequest
UpdateScheduleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.UpdateSchedule.
See more: google.cloud.aiplatform_v1.types.UpdateScheduleRequest
google.cloud.aiplatform_v1.types.UpdateSpecialistPoolOperationMetadata
UpdateSpecialistPoolOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation metadata for SpecialistPoolService.UpdateSpecialistPool.
See more: google.cloud.aiplatform_v1.types.UpdateSpecialistPoolOperationMetadata
google.cloud.aiplatform_v1.types.UpdateSpecialistPoolRequest
UpdateSpecialistPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for SpecialistPoolService.UpdateSpecialistPool.
See more: google.cloud.aiplatform_v1.types.UpdateSpecialistPoolRequest
google.cloud.aiplatform_v1.types.UpdateTensorboardExperimentRequest
UpdateTensorboardExperimentRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.UpdateTensorboardExperiment.
See more: google.cloud.aiplatform_v1.types.UpdateTensorboardExperimentRequest
google.cloud.aiplatform_v1.types.UpdateTensorboardOperationMetadata
UpdateTensorboardOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update Tensorboard.
See more: google.cloud.aiplatform_v1.types.UpdateTensorboardOperationMetadata
google.cloud.aiplatform_v1.types.UpdateTensorboardRequest
UpdateTensorboardRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.UpdateTensorboard.
See more: google.cloud.aiplatform_v1.types.UpdateTensorboardRequest
google.cloud.aiplatform_v1.types.UpdateTensorboardRunRequest
UpdateTensorboardRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.UpdateTensorboardRun.
See more: google.cloud.aiplatform_v1.types.UpdateTensorboardRunRequest
google.cloud.aiplatform_v1.types.UpdateTensorboardTimeSeriesRequest
UpdateTensorboardTimeSeriesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.UpdateTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1.types.UpdateTensorboardTimeSeriesRequest
google.cloud.aiplatform_v1.types.UpgradeNotebookRuntimeOperationMetadata
UpgradeNotebookRuntimeOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Metadata information for NotebookService.UpgradeNotebookRuntime.
See more: google.cloud.aiplatform_v1.types.UpgradeNotebookRuntimeOperationMetadata
google.cloud.aiplatform_v1.types.UpgradeNotebookRuntimeRequest
UpgradeNotebookRuntimeRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.UpgradeNotebookRuntime.
See more: google.cloud.aiplatform_v1.types.UpgradeNotebookRuntimeRequest
google.cloud.aiplatform_v1.types.UpgradeNotebookRuntimeResponse
UpgradeNotebookRuntimeResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for NotebookService.UpgradeNotebookRuntime.
See more: google.cloud.aiplatform_v1.types.UpgradeNotebookRuntimeResponse
google.cloud.aiplatform_v1.types.UploadModelOperationMetadata
UploadModelOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of ModelService.UploadModel operation.
See more: google.cloud.aiplatform_v1.types.UploadModelOperationMetadata
google.cloud.aiplatform_v1.types.UploadModelRequest
UploadModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.UploadModel.
See more: google.cloud.aiplatform_v1.types.UploadModelRequest
google.cloud.aiplatform_v1.types.UploadModelResponse
UploadModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message of ModelService.UploadModel operation.
See more: google.cloud.aiplatform_v1.types.UploadModelResponse
google.cloud.aiplatform_v1.types.UpsertDatapointsRequest
UpsertDatapointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.UpsertDatapoints .
See more: google.cloud.aiplatform_v1.types.UpsertDatapointsRequest
google.cloud.aiplatform_v1.types.UpsertDatapointsResponse
UpsertDatapointsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexService.UpsertDatapoints .
See more: google.cloud.aiplatform_v1.types.UpsertDatapointsResponse
google.cloud.aiplatform_v1.types.UserActionReference
UserActionReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)
References an API call.
See more: google.cloud.aiplatform_v1.types.UserActionReference
google.cloud.aiplatform_v1.types.Value
Value(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Value is the value of the field.
See more: google.cloud.aiplatform_v1.types.Value
google.cloud.aiplatform_v1.types.VertexAISearch
VertexAISearch(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Retrieve from Vertex AI Search datastore for grounding.
google.cloud.aiplatform_v1.types.VideoMetadata
VideoMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata describes the input video content.
google.cloud.aiplatform_v1.types.WorkerPoolSpec
WorkerPoolSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of a worker pool in a job.
google.cloud.aiplatform_v1.types.WriteFeatureValuesPayload
WriteFeatureValuesPayload(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains Feature values to be written for a specific entity.
See more: google.cloud.aiplatform_v1.types.WriteFeatureValuesPayload
google.cloud.aiplatform_v1.types.WriteFeatureValuesPayload.FeatureValuesEntry
FeatureValuesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1.types.WriteFeatureValuesPayload.FeatureValuesEntry
google.cloud.aiplatform_v1.types.WriteFeatureValuesRequest
WriteFeatureValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreOnlineServingService.WriteFeatureValues.
See more: google.cloud.aiplatform_v1.types.WriteFeatureValuesRequest
google.cloud.aiplatform_v1.types.WriteFeatureValuesResponse
WriteFeatureValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreOnlineServingService.WriteFeatureValues.
See more: google.cloud.aiplatform_v1.types.WriteFeatureValuesResponse
google.cloud.aiplatform_v1.types.WriteTensorboardExperimentDataRequest
WriteTensorboardExperimentDataRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.WriteTensorboardExperimentData.
See more: google.cloud.aiplatform_v1.types.WriteTensorboardExperimentDataRequest
google.cloud.aiplatform_v1.types.WriteTensorboardExperimentDataResponse
WriteTensorboardExperimentDataResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.WriteTensorboardExperimentData.
See more: google.cloud.aiplatform_v1.types.WriteTensorboardExperimentDataResponse
google.cloud.aiplatform_v1.types.WriteTensorboardRunDataRequest
WriteTensorboardRunDataRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.WriteTensorboardRunData.
See more: google.cloud.aiplatform_v1.types.WriteTensorboardRunDataRequest
google.cloud.aiplatform_v1.types.WriteTensorboardRunDataResponse
WriteTensorboardRunDataResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.WriteTensorboardRunData.
See more: google.cloud.aiplatform_v1.types.WriteTensorboardRunDataResponse
google.cloud.aiplatform_v1.types.XraiAttribution
XraiAttribution(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient
DatasetServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.dataset_service.transports.base.DatasetServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the dataset service async client.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.annotation_path
annotation_path(
project: str, location: str, dataset: str, data_item: str, annotation: str
) -> str
Returns a fully-qualified annotation string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.annotation_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.annotation_spec_path
annotation_spec_path(
project: str, location: str, dataset: str, annotation_spec: str
) -> str
Returns a fully-qualified annotation_spec string.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.create_dataset
create_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.CreateDatasetRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
dataset: typing.Optional[
google.cloud.aiplatform_v1beta1.types.dataset.Dataset
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.create_dataset
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.create_dataset_version
create_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.CreateDatasetVersionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
dataset_version: typing.Optional[
google.cloud.aiplatform_v1beta1.types.dataset_version.DatasetVersion
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Create a version from a Dataset.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.data_item_path
data_item_path(project: str, location: str, dataset: str, data_item: str) -> str
Returns a fully-qualified data_item string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.data_item_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.dataset_path
dataset_path(project: str, location: str, dataset: str) -> str
Returns a fully-qualified dataset string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.dataset_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.dataset_version_path
dataset_version_path(
project: str, location: str, dataset: str, dataset_version: str
) -> str
Returns a fully-qualified dataset_version string.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.delete_dataset
delete_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.DeleteDatasetRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.delete_dataset
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.delete_dataset_version
delete_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.DeleteDatasetVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a Dataset version.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.delete_saved_query
delete_saved_query(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.DeleteSavedQueryRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a SavedQuery.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.export_data
export_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ExportDataRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
export_config: typing.Optional[
google.cloud.aiplatform_v1beta1.types.dataset.ExportDataConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Exports data from a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.export_data
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.get_annotation_spec
get_annotation_spec(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.GetAnnotationSpecRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.annotation_spec.AnnotationSpec
Gets an AnnotationSpec.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.get_dataset
get_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.GetDatasetRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.dataset.Dataset
Gets a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.get_dataset
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.get_dataset_version
get_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.GetDatasetVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.dataset_version.DatasetVersion
Gets a Dataset version.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.get_operation
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.dataset_service.transports.base.DatasetServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.import_data
import_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ImportDataRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
import_configs: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.dataset.ImportDataConfig
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports data into a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.import_data
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.list_annotations
list_annotations(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListAnnotationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListAnnotationsAsyncPager
)
Lists Annotations belongs to a dataitem.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.list_annotations
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.list_data_items
list_data_items(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListDataItemsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDataItemsAsyncPager
)
Lists DataItems in a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.list_data_items
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.list_dataset_versions
list_dataset_versions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetVersionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDatasetVersionsAsyncPager
)
Lists DatasetVersions in a Dataset.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.list_datasets
list_datasets(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDatasetsAsyncPager
)
Lists Datasets in a Location.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.list_datasets
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.list_locations
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.list_operations
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.list_saved_queries
list_saved_queries(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListSavedQueriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListSavedQueriesAsyncPager
)
Lists SavedQueries in a Dataset.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.parse_annotation_path
parse_annotation_path(path: str) -> typing.Dict[str, str]
Parses a annotation path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.parse_annotation_spec_path
parse_annotation_spec_path(path: str) -> typing.Dict[str, str]
Parses a annotation_spec path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.parse_data_item_path
parse_data_item_path(path: str) -> typing.Dict[str, str]
Parses a data_item path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.parse_dataset_path
parse_dataset_path(path: str) -> typing.Dict[str, str]
Parses a dataset path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.parse_dataset_version_path
parse_dataset_version_path(path: str) -> typing.Dict[str, str]
Parses a dataset_version path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.parse_saved_query_path
parse_saved_query_path(path: str) -> typing.Dict[str, str]
Parses a saved_query path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.restore_dataset_version
restore_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.RestoreDatasetVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Restores a dataset version.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.saved_query_path
saved_query_path(
project: str, location: str, dataset: str, saved_query: str
) -> str
Returns a fully-qualified saved_query string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.saved_query_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.search_data_items
search_data_items(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.SearchDataItemsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.SearchDataItemsAsyncPager
)
Searches DataItems in a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.search_data_items
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.update_dataset
update_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.UpdateDatasetRequest,
dict,
]
] = None,
*,
dataset: typing.Optional[
google.cloud.aiplatform_v1beta1.types.dataset.Dataset
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.dataset.Dataset
Updates a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.update_dataset
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient
DatasetServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.dataset_service.transports.base.DatasetServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the dataset service client.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.exit
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.annotation_path
annotation_path(
project: str, location: str, dataset: str, data_item: str, annotation: str
) -> str
Returns a fully-qualified annotation string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.annotation_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.annotation_spec_path
annotation_spec_path(
project: str, location: str, dataset: str, annotation_spec: str
) -> str
Returns a fully-qualified annotation_spec string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.annotation_spec_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.common_location_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.common_project_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.create_dataset
create_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.CreateDatasetRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
dataset: typing.Optional[
google.cloud.aiplatform_v1beta1.types.dataset.Dataset
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.create_dataset
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.create_dataset_version
create_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.CreateDatasetVersionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
dataset_version: typing.Optional[
google.cloud.aiplatform_v1beta1.types.dataset_version.DatasetVersion
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Create a version from a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.create_dataset_version
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.data_item_path
data_item_path(project: str, location: str, dataset: str, data_item: str) -> str
Returns a fully-qualified data_item string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.data_item_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.dataset_path
dataset_path(project: str, location: str, dataset: str) -> str
Returns a fully-qualified dataset string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.dataset_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.dataset_version_path
dataset_version_path(
project: str, location: str, dataset: str, dataset_version: str
) -> str
Returns a fully-qualified dataset_version string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.dataset_version_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.delete_dataset
delete_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.DeleteDatasetRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.delete_dataset
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.delete_dataset_version
delete_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.DeleteDatasetVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a Dataset version.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.delete_dataset_version
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.delete_saved_query
delete_saved_query(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.DeleteSavedQueryRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a SavedQuery.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.delete_saved_query
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.export_data
export_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ExportDataRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
export_config: typing.Optional[
google.cloud.aiplatform_v1beta1.types.dataset.ExportDataConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Exports data from a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.export_data
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_annotation_spec
get_annotation_spec(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.GetAnnotationSpecRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.annotation_spec.AnnotationSpec
Gets an AnnotationSpec.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_annotation_spec
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_dataset
get_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.GetDatasetRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.dataset.Dataset
Gets a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_dataset
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_dataset_version
get_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.GetDatasetVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.dataset_version.DatasetVersion
Gets a Dataset version.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_dataset_version
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.import_data
import_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ImportDataRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
import_configs: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.dataset.ImportDataConfig
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Imports data into a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.import_data
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_annotations
list_annotations(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListAnnotationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListAnnotationsPager
)
Lists Annotations belongs to a dataitem.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_annotations
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_data_items
list_data_items(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListDataItemsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDataItemsPager
Lists DataItems in a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_data_items
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_dataset_versions
list_dataset_versions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetVersionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDatasetVersionsPager
)
Lists DatasetVersions in a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_dataset_versions
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_datasets
list_datasets(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDatasetsPager
Lists Datasets in a Location.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_datasets
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_saved_queries
list_saved_queries(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListSavedQueriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListSavedQueriesPager
)
Lists SavedQueries in a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.list_saved_queries
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_annotation_path
parse_annotation_path(path: str) -> typing.Dict[str, str]
Parses a annotation path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_annotation_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_annotation_spec_path
parse_annotation_spec_path(path: str) -> typing.Dict[str, str]
Parses a annotation_spec path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_data_item_path
parse_data_item_path(path: str) -> typing.Dict[str, str]
Parses a data_item path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_data_item_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_dataset_path
parse_dataset_path(path: str) -> typing.Dict[str, str]
Parses a dataset path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_dataset_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_dataset_version_path
parse_dataset_version_path(path: str) -> typing.Dict[str, str]
Parses a dataset_version path into its component segments.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_saved_query_path
parse_saved_query_path(path: str) -> typing.Dict[str, str]
Parses a saved_query path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.parse_saved_query_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.restore_dataset_version
restore_dataset_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.RestoreDatasetVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Restores a dataset version.
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.saved_query_path
saved_query_path(
project: str, location: str, dataset: str, saved_query: str
) -> str
Returns a fully-qualified saved_query string.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.saved_query_path
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.search_data_items
search_data_items(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.SearchDataItemsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.SearchDataItemsPager
)
Searches DataItems in a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.search_data_items
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.update_dataset
update_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.dataset_service.UpdateDatasetRequest,
dict,
]
] = None,
*,
dataset: typing.Optional[
google.cloud.aiplatform_v1beta1.types.dataset.Dataset
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.dataset.Dataset
Updates a Dataset.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.update_dataset
google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.DatasetServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListAnnotationsAsyncPager
ListAnnotationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListAnnotationsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.dataset_service.ListAnnotationsRequest,
response: google.cloud.aiplatform_v1beta1.types.dataset_service.ListAnnotationsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListAnnotationsAsyncPager
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListAnnotationsPager
ListAnnotationsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.dataset_service.ListAnnotationsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.dataset_service.ListAnnotationsRequest,
response: google.cloud.aiplatform_v1beta1.types.dataset_service.ListAnnotationsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListAnnotationsPager
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDataItemsAsyncPager
ListDataItemsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListDataItemsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.dataset_service.ListDataItemsRequest,
response: google.cloud.aiplatform_v1beta1.types.dataset_service.ListDataItemsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDataItemsAsyncPager
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDataItemsPager
ListDataItemsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.dataset_service.ListDataItemsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.dataset_service.ListDataItemsRequest,
response: google.cloud.aiplatform_v1beta1.types.dataset_service.ListDataItemsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDataItemsPager
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDatasetVersionsAsyncPager
ListDatasetVersionsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetVersionsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetVersionsRequest,
response: google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetVersionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDatasetVersionsAsyncPager
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDatasetVersionsPager
ListDatasetVersionsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetVersionsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetVersionsRequest,
response: google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetVersionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDatasetVersionsPager
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDatasetsAsyncPager
ListDatasetsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetsRequest,
response: google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDatasetsAsyncPager
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDatasetsPager
ListDatasetsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetsRequest,
response: google.cloud.aiplatform_v1beta1.types.dataset_service.ListDatasetsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListDatasetsPager
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListSavedQueriesAsyncPager
ListSavedQueriesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.dataset_service.ListSavedQueriesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.dataset_service.ListSavedQueriesRequest,
response: google.cloud.aiplatform_v1beta1.types.dataset_service.ListSavedQueriesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListSavedQueriesAsyncPager
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListSavedQueriesPager
ListSavedQueriesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.dataset_service.ListSavedQueriesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.dataset_service.ListSavedQueriesRequest,
response: google.cloud.aiplatform_v1beta1.types.dataset_service.ListSavedQueriesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.ListSavedQueriesPager
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.SearchDataItemsAsyncPager
SearchDataItemsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.dataset_service.SearchDataItemsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.dataset_service.SearchDataItemsRequest,
response: google.cloud.aiplatform_v1beta1.types.dataset_service.SearchDataItemsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.SearchDataItemsAsyncPager
google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.SearchDataItemsPager
SearchDataItemsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.dataset_service.SearchDataItemsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.dataset_service.SearchDataItemsRequest,
response: google.cloud.aiplatform_v1beta1.types.dataset_service.SearchDataItemsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.dataset_service.pagers.SearchDataItemsPager
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient
DeploymentResourcePoolServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.transports.base.DeploymentResourcePoolServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the deployment resource pool service async client.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.create_deployment_resource_pool
create_deployment_resource_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.CreateDeploymentResourcePoolRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
deployment_resource_pool: typing.Optional[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool.DeploymentResourcePool
] = None,
deployment_resource_pool_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Create a DeploymentResourcePool.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.delete_deployment_resource_pool
delete_deployment_resource_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.DeleteDeploymentResourcePoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Delete a DeploymentResourcePool.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.deployment_resource_pool_path
deployment_resource_pool_path(
project: str, location: str, deployment_resource_pool: str
) -> str
Returns a fully-qualified deployment_resource_pool string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.get_deployment_resource_pool
get_deployment_resource_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.GetDeploymentResourcePoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool.DeploymentResourcePool
)
Get a DeploymentResourcePool.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.transports.base.DeploymentResourcePoolServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.list_deployment_resource_pools
list_deployment_resource_pools(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.pagers.ListDeploymentResourcePoolsAsyncPager
)
List DeploymentResourcePools in a location.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_deployment_resource_pool_path
parse_deployment_resource_pool_path(path: str) -> typing.Dict[str, str]
Parses a deployment_resource_pool path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.query_deployed_models
query_deployed_models(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.QueryDeployedModelsRequest,
dict,
]
] = None,
*,
deployment_resource_pool: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.pagers.QueryDeployedModelsAsyncPager
)
List DeployedModels that have been deployed on this DeploymentResourcePool.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient
DeploymentResourcePoolServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.transports.base.DeploymentResourcePoolServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the deployment resource pool service client.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.create_deployment_resource_pool
create_deployment_resource_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.CreateDeploymentResourcePoolRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
deployment_resource_pool: typing.Optional[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool.DeploymentResourcePool
] = None,
deployment_resource_pool_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Create a DeploymentResourcePool.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.delete_deployment_resource_pool
delete_deployment_resource_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.DeleteDeploymentResourcePoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Delete a DeploymentResourcePool.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.deployment_resource_pool_path
deployment_resource_pool_path(
project: str, location: str, deployment_resource_pool: str
) -> str
Returns a fully-qualified deployment_resource_pool string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.get_deployment_resource_pool
get_deployment_resource_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.GetDeploymentResourcePoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool.DeploymentResourcePool
)
Get a DeploymentResourcePool.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.list_deployment_resource_pools
list_deployment_resource_pools(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.pagers.ListDeploymentResourcePoolsPager
)
List DeploymentResourcePools in a location.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_deployment_resource_pool_path
parse_deployment_resource_pool_path(path: str) -> typing.Dict[str, str]
Parses a deployment_resource_pool path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.query_deployed_models
query_deployed_models(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.QueryDeployedModelsRequest,
dict,
]
] = None,
*,
deployment_resource_pool: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.pagers.QueryDeployedModelsPager
)
List DeployedModels that have been deployed on this DeploymentResourcePool.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.DeploymentResourcePoolServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.pagers.ListDeploymentResourcePoolsAsyncPager
ListDeploymentResourcePoolsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsRequest,
response: google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.pagers.ListDeploymentResourcePoolsPager
ListDeploymentResourcePoolsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsRequest,
response: google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.ListDeploymentResourcePoolsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.pagers.QueryDeployedModelsAsyncPager
QueryDeployedModelsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.QueryDeployedModelsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.QueryDeployedModelsRequest,
response: google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.QueryDeployedModelsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.pagers.QueryDeployedModelsPager
QueryDeployedModelsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.QueryDeployedModelsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.QueryDeployedModelsRequest,
response: google.cloud.aiplatform_v1beta1.types.deployment_resource_pool_service.QueryDeployedModelsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient
EndpointServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.endpoint_service.transports.base.EndpointServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the endpoint service async client.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.create_endpoint
create_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.CreateEndpointRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
endpoint: typing.Optional[
google.cloud.aiplatform_v1beta1.types.endpoint.Endpoint
] = None,
endpoint_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates an Endpoint.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.create_endpoint
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.delete_endpoint
delete_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.DeleteEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes an Endpoint.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.delete_endpoint
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.deploy_model
deploy_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.DeployModelRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
deployed_model: typing.Optional[
google.cloud.aiplatform_v1beta1.types.endpoint.DeployedModel
] = None,
traffic_split: typing.Optional[typing.MutableMapping[str, int]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deploys a Model into this Endpoint, creating a DeployedModel within it.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.deploy_model
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.deployment_resource_pool_path
deployment_resource_pool_path(
project: str, location: str, deployment_resource_pool: str
) -> str
Returns a fully-qualified deployment_resource_pool string.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.endpoint_path
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.get_endpoint
get_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.GetEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.endpoint.Endpoint
Gets an Endpoint.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.get_endpoint
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.get_operation
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.endpoint_service.transports.base.EndpointServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.list_endpoints
list_endpoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.ListEndpointsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.endpoint_service.pagers.ListEndpointsAsyncPager
)
Lists Endpoints in a Location.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.list_endpoints
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.list_locations
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.list_operations
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.model_deployment_monitoring_job_path
model_deployment_monitoring_job_path(
project: str, location: str, model_deployment_monitoring_job: str
) -> str
Returns a fully-qualified model_deployment_monitoring_job string.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.model_path
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.mutate_deployed_model
mutate_deployed_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.MutateDeployedModelRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
deployed_model: typing.Optional[
google.cloud.aiplatform_v1beta1.types.endpoint.DeployedModel
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an existing deployed model.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.network_path
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.parse_deployment_resource_pool_path
parse_deployment_resource_pool_path(path: str) -> typing.Dict[str, str]
Parses a deployment_resource_pool path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.parse_model_deployment_monitoring_job_path
parse_model_deployment_monitoring_job_path(path: str) -> typing.Dict[str, str]
Parses a model_deployment_monitoring_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.undeploy_model
undeploy_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.UndeployModelRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
deployed_model_id: typing.Optional[str] = None,
traffic_split: typing.Optional[typing.MutableMapping[str, int]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.undeploy_model
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.update_endpoint
update_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.UpdateEndpointRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[
google.cloud.aiplatform_v1beta1.types.endpoint.Endpoint
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.endpoint.Endpoint
Updates an Endpoint.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.update_endpoint
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient
EndpointServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.endpoint_service.transports.base.EndpointServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the endpoint service client.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.exit
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.common_location_path
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.common_project_path
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.create_endpoint
create_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.CreateEndpointRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
endpoint: typing.Optional[
google.cloud.aiplatform_v1beta1.types.endpoint.Endpoint
] = None,
endpoint_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates an Endpoint.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.create_endpoint
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.delete_endpoint
delete_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.DeleteEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes an Endpoint.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.delete_endpoint
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.deploy_model
deploy_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.DeployModelRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
deployed_model: typing.Optional[
google.cloud.aiplatform_v1beta1.types.endpoint.DeployedModel
] = None,
traffic_split: typing.Optional[typing.MutableMapping[str, int]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deploys a Model into this Endpoint, creating a DeployedModel within it.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.deploy_model
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.deployment_resource_pool_path
deployment_resource_pool_path(
project: str, location: str, deployment_resource_pool: str
) -> str
Returns a fully-qualified deployment_resource_pool string.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.endpoint_path
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.get_endpoint
get_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.GetEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.endpoint.Endpoint
Gets an Endpoint.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.get_endpoint
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.list_endpoints
list_endpoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.ListEndpointsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.endpoint_service.pagers.ListEndpointsPager
)
Lists Endpoints in a Location.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.list_endpoints
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.model_deployment_monitoring_job_path
model_deployment_monitoring_job_path(
project: str, location: str, model_deployment_monitoring_job: str
) -> str
Returns a fully-qualified model_deployment_monitoring_job string.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.model_path
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.mutate_deployed_model
mutate_deployed_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.MutateDeployedModelRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
deployed_model: typing.Optional[
google.cloud.aiplatform_v1beta1.types.endpoint.DeployedModel
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates an existing deployed model.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.network_path
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_deployment_resource_pool_path
parse_deployment_resource_pool_path(path: str) -> typing.Dict[str, str]
Parses a deployment_resource_pool path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_endpoint_path
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_model_deployment_monitoring_job_path
parse_model_deployment_monitoring_job_path(path: str) -> typing.Dict[str, str]
Parses a model_deployment_monitoring_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_model_path
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.parse_network_path
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.undeploy_model
undeploy_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.UndeployModelRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
deployed_model_id: typing.Optional[str] = None,
traffic_split: typing.Optional[typing.MutableMapping[str, int]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.undeploy_model
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.update_endpoint
update_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.endpoint_service.UpdateEndpointRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[
google.cloud.aiplatform_v1beta1.types.endpoint.Endpoint
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.endpoint.Endpoint
Updates an Endpoint.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.update_endpoint
google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.EndpointServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.endpoint_service.pagers.ListEndpointsAsyncPager
ListEndpointsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.endpoint_service.ListEndpointsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.endpoint_service.ListEndpointsRequest,
response: google.cloud.aiplatform_v1beta1.types.endpoint_service.ListEndpointsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.pagers.ListEndpointsAsyncPager
google.cloud.aiplatform_v1beta1.services.endpoint_service.pagers.ListEndpointsPager
ListEndpointsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.endpoint_service.ListEndpointsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.endpoint_service.ListEndpointsRequest,
response: google.cloud.aiplatform_v1beta1.types.endpoint_service.ListEndpointsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.endpoint_service.pagers.ListEndpointsPager
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient
EvaluationServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.evaluation_service.transports.base.EvaluationServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the evaluation service async client.
See more: google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.evaluate_instances
evaluate_instances(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.evaluation_service.EvaluateInstancesRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.evaluation_service.EvaluateInstancesResponse
Evaluates instances based on a given metric.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.evaluation_service.transports.base.EvaluationServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient
EvaluationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.evaluation_service.transports.base.EvaluationServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the evaluation service client.
See more: google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.exit
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.evaluate_instances
evaluate_instances(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.evaluation_service.EvaluateInstancesRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.evaluation_service.EvaluateInstancesResponse
Evaluates instances based on a given metric.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.evaluation_service.EvaluationServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient
ExtensionExecutionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.extension_execution_service.transports.base.ExtensionExecutionServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the extension execution service async client.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.execute_extension
execute_extension(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_execution_service.ExecuteExtensionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
operation_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.extension_execution_service.ExecuteExtensionResponse
)
Executes the request against a given extension.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.extension_path
extension_path(project: str, location: str, extension: str) -> str
Returns a fully-qualified extension string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.extension_execution_service.transports.base.ExtensionExecutionServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.parse_extension_path
parse_extension_path(path: str) -> typing.Dict[str, str]
Parses a extension path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.parse_secret_version_path
parse_secret_version_path(path: str) -> typing.Dict[str, str]
Parses a secret_version path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.query_extension
query_extension(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_execution_service.QueryExtensionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
contents: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1beta1.types.content.Content]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.extension_execution_service.QueryExtensionResponse
)
Queries an extension with a default controller.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.secret_version_path
secret_version_path(project: str, secret: str, secret_version: str) -> str
Returns a fully-qualified secret_version string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient
ExtensionExecutionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.extension_execution_service.transports.base.ExtensionExecutionServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the extension execution service client.
See more: google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.execute_extension
execute_extension(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_execution_service.ExecuteExtensionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
operation_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.extension_execution_service.ExecuteExtensionResponse
)
Executes the request against a given extension.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.extension_path
extension_path(project: str, location: str, extension: str) -> str
Returns a fully-qualified extension string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.parse_extension_path
parse_extension_path(path: str) -> typing.Dict[str, str]
Parses a extension path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.parse_secret_version_path
parse_secret_version_path(path: str) -> typing.Dict[str, str]
Parses a secret_version path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.query_extension
query_extension(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_execution_service.QueryExtensionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
contents: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1beta1.types.content.Content]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.extension_execution_service.QueryExtensionResponse
)
Queries an extension with a default controller.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.secret_version_path
secret_version_path(project: str, secret: str, secret_version: str) -> str
Returns a fully-qualified secret_version string.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.extension_execution_service.ExtensionExecutionServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient
ExtensionRegistryServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.extension_registry_service.transports.base.ExtensionRegistryServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the extension registry service async client.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.delete_extension
delete_extension(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_registry_service.DeleteExtensionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes an Extension.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.extension_path
extension_path(project: str, location: str, extension: str) -> str
Returns a fully-qualified extension string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.get_extension
get_extension(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_registry_service.GetExtensionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.extension.Extension
Gets an Extension.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.extension_registry_service.transports.base.ExtensionRegistryServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.import_extension
import_extension(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_registry_service.ImportExtensionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
extension: typing.Optional[
google.cloud.aiplatform_v1beta1.types.extension.Extension
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports an Extension.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.list_extensions
list_extensions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_registry_service.ListExtensionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.extension_registry_service.pagers.ListExtensionsAsyncPager
)
Lists Extensions in a location.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.parse_extension_path
parse_extension_path(path: str) -> typing.Dict[str, str]
Parses a extension path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.parse_secret_version_path
parse_secret_version_path(path: str) -> typing.Dict[str, str]
Parses a secret_version path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.parse_service_path
parse_service_path(path: str) -> typing.Dict[str, str]
Parses a service path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.secret_version_path
secret_version_path(project: str, secret: str, secret_version: str) -> str
Returns a fully-qualified secret_version string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.service_path
service_path(project: str, location: str, namespace: str, service: str) -> str
Returns a fully-qualified service string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.update_extension
update_extension(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_registry_service.UpdateExtensionRequest,
dict,
]
] = None,
*,
extension: typing.Optional[
google.cloud.aiplatform_v1beta1.types.extension.Extension
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.extension.Extension
Updates an Extension.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient
ExtensionRegistryServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.extension_registry_service.transports.base.ExtensionRegistryServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the extension registry service client.
See more: google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.delete_extension
delete_extension(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_registry_service.DeleteExtensionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes an Extension.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.extension_path
extension_path(project: str, location: str, extension: str) -> str
Returns a fully-qualified extension string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.get_extension
get_extension(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_registry_service.GetExtensionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.extension.Extension
Gets an Extension.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.import_extension
import_extension(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_registry_service.ImportExtensionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
extension: typing.Optional[
google.cloud.aiplatform_v1beta1.types.extension.Extension
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Imports an Extension.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.list_extensions
list_extensions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_registry_service.ListExtensionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.extension_registry_service.pagers.ListExtensionsPager
)
Lists Extensions in a location.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.parse_extension_path
parse_extension_path(path: str) -> typing.Dict[str, str]
Parses a extension path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.parse_secret_version_path
parse_secret_version_path(path: str) -> typing.Dict[str, str]
Parses a secret_version path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.parse_service_path
parse_service_path(path: str) -> typing.Dict[str, str]
Parses a service path into its component segments.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.secret_version_path
secret_version_path(project: str, secret: str, secret_version: str) -> str
Returns a fully-qualified secret_version string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.service_path
service_path(project: str, location: str, namespace: str, service: str) -> str
Returns a fully-qualified service string.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.update_extension
update_extension(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.extension_registry_service.UpdateExtensionRequest,
dict,
]
] = None,
*,
extension: typing.Optional[
google.cloud.aiplatform_v1beta1.types.extension.Extension
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.extension.Extension
Updates an Extension.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.ExtensionRegistryServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.extension_registry_service.pagers.ListExtensionsAsyncPager
ListExtensionsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.extension_registry_service.ListExtensionsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.extension_registry_service.ListExtensionsRequest,
response: google.cloud.aiplatform_v1beta1.types.extension_registry_service.ListExtensionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.extension_registry_service.pagers.ListExtensionsAsyncPager
google.cloud.aiplatform_v1beta1.services.extension_registry_service.pagers.ListExtensionsPager
ListExtensionsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.extension_registry_service.ListExtensionsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.extension_registry_service.ListExtensionsRequest,
response: google.cloud.aiplatform_v1beta1.types.extension_registry_service.ListExtensionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.extension_registry_service.pagers.ListExtensionsPager
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient
FeatureOnlineStoreAdminServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.transports.base.FeatureOnlineStoreAdminServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the feature online store admin service async client.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.create_feature_online_store
create_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.CreateFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature_online_store: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_online_store.FeatureOnlineStore
] = None,
feature_online_store_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new FeatureOnlineStore in a given project and location.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.create_feature_view
create_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.CreateFeatureViewRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature_view: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_view.FeatureView
] = None,
feature_view_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new FeatureView in a given FeatureOnlineStore.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.delete_feature_online_store
delete_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.DeleteFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single FeatureOnlineStore.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.delete_feature_view
delete_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.DeleteFeatureViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.feature_online_store_path
feature_online_store_path(
project: str, location: str, feature_online_store: str
) -> str
Returns a fully-qualified feature_online_store string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.feature_view_path
feature_view_path(
project: str, location: str, feature_online_store: str, feature_view: str
) -> str
Returns a fully-qualified feature_view string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.feature_view_sync_path
feature_view_sync_path(
project: str, location: str, feature_online_store: str, feature_view: str
) -> str
Returns a fully-qualified feature_view_sync string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_feature_online_store
get_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.GetFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature_online_store.FeatureOnlineStore
Gets details of a single FeatureOnlineStore.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_feature_view
get_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.GetFeatureViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature_view.FeatureView
Gets details of a single FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_feature_view_sync
get_feature_view_sync(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.GetFeatureViewSyncRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature_view_sync.FeatureViewSync
Gets details of a single FeatureViewSync.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.transports.base.FeatureOnlineStoreAdminServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.list_feature_online_stores
list_feature_online_stores(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureOnlineStoresRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.pagers.ListFeatureOnlineStoresAsyncPager
)
Lists FeatureOnlineStores in a given project and location.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.list_feature_view_syncs
list_feature_view_syncs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewSyncsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.pagers.ListFeatureViewSyncsAsyncPager
)
Lists FeatureViewSyncs in a given FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.list_feature_views
list_feature_views(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.pagers.ListFeatureViewsAsyncPager
)
Lists FeatureViews in a given FeatureOnlineStore.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_feature_online_store_path
parse_feature_online_store_path(path: str) -> typing.Dict[str, str]
Parses a feature_online_store path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_feature_view_path
parse_feature_view_path(path: str) -> typing.Dict[str, str]
Parses a feature_view path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.parse_feature_view_sync_path
parse_feature_view_sync_path(path: str) -> typing.Dict[str, str]
Parses a feature_view_sync path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.sync_feature_view
sync_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.SyncFeatureViewRequest,
dict,
]
] = None,
*,
feature_view: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.SyncFeatureViewResponse
)
Triggers on-demand sync for the FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.update_feature_online_store
update_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.UpdateFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
feature_online_store: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_online_store.FeatureOnlineStore
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single FeatureOnlineStore.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.update_feature_view
update_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.UpdateFeatureViewRequest,
dict,
]
] = None,
*,
feature_view: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_view.FeatureView
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient
FeatureOnlineStoreAdminServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.transports.base.FeatureOnlineStoreAdminServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the feature online store admin service client.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.create_feature_online_store
create_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.CreateFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature_online_store: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_online_store.FeatureOnlineStore
] = None,
feature_online_store_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new FeatureOnlineStore in a given project and location.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.create_feature_view
create_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.CreateFeatureViewRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature_view: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_view.FeatureView
] = None,
feature_view_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new FeatureView in a given FeatureOnlineStore.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.delete_feature_online_store
delete_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.DeleteFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single FeatureOnlineStore.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.delete_feature_view
delete_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.DeleteFeatureViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.feature_online_store_path
feature_online_store_path(
project: str, location: str, feature_online_store: str
) -> str
Returns a fully-qualified feature_online_store string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.feature_view_path
feature_view_path(
project: str, location: str, feature_online_store: str, feature_view: str
) -> str
Returns a fully-qualified feature_view string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.feature_view_sync_path
feature_view_sync_path(
project: str, location: str, feature_online_store: str, feature_view: str
) -> str
Returns a fully-qualified feature_view_sync string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_feature_online_store
get_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.GetFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature_online_store.FeatureOnlineStore
Gets details of a single FeatureOnlineStore.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_feature_view
get_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.GetFeatureViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature_view.FeatureView
Gets details of a single FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_feature_view_sync
get_feature_view_sync(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.GetFeatureViewSyncRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature_view_sync.FeatureViewSync
Gets details of a single FeatureViewSync.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.list_feature_online_stores
list_feature_online_stores(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureOnlineStoresRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.pagers.ListFeatureOnlineStoresPager
)
Lists FeatureOnlineStores in a given project and location.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.list_feature_view_syncs
list_feature_view_syncs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewSyncsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.pagers.ListFeatureViewSyncsPager
)
Lists FeatureViewSyncs in a given FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.list_feature_views
list_feature_views(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.pagers.ListFeatureViewsPager
)
Lists FeatureViews in a given FeatureOnlineStore.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_feature_online_store_path
parse_feature_online_store_path(path: str) -> typing.Dict[str, str]
Parses a feature_online_store path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_feature_view_path
parse_feature_view_path(path: str) -> typing.Dict[str, str]
Parses a feature_view path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.parse_feature_view_sync_path
parse_feature_view_sync_path(path: str) -> typing.Dict[str, str]
Parses a feature_view_sync path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.sync_feature_view
sync_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.SyncFeatureViewRequest,
dict,
]
] = None,
*,
feature_view: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.SyncFeatureViewResponse
)
Triggers on-demand sync for the FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.update_feature_online_store
update_feature_online_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.UpdateFeatureOnlineStoreRequest,
dict,
]
] = None,
*,
feature_online_store: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_online_store.FeatureOnlineStore
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single FeatureOnlineStore.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.update_feature_view
update_feature_view(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.UpdateFeatureViewRequest,
dict,
]
] = None,
*,
feature_view: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_view.FeatureView
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.FeatureOnlineStoreAdminServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.pagers.ListFeatureOnlineStoresAsyncPager
ListFeatureOnlineStoresAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureOnlineStoresResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureOnlineStoresRequest,
response: google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureOnlineStoresResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.pagers.ListFeatureOnlineStoresPager
ListFeatureOnlineStoresPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureOnlineStoresResponse,
],
request: google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureOnlineStoresRequest,
response: google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureOnlineStoresResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.pagers.ListFeatureViewSyncsAsyncPager
ListFeatureViewSyncsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewSyncsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewSyncsRequest,
response: google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewSyncsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.pagers.ListFeatureViewSyncsPager
ListFeatureViewSyncsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewSyncsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewSyncsRequest,
response: google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewSyncsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.pagers.ListFeatureViewsAsyncPager
ListFeatureViewsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewsRequest,
response: google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.feature_online_store_admin_service.pagers.ListFeatureViewsPager
ListFeatureViewsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewsRequest,
response: google.cloud.aiplatform_v1beta1.types.feature_online_store_admin_service.ListFeatureViewsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient
FeatureOnlineStoreServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.feature_online_store_service.transports.base.FeatureOnlineStoreServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the feature online store service async client.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.feature_view_path
feature_view_path(
project: str, location: str, feature_online_store: str, feature_view: str
) -> str
Returns a fully-qualified feature_view string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.fetch_feature_values
fetch_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.FetchFeatureValuesRequest,
dict,
]
] = None,
*,
feature_view: typing.Optional[str] = None,
data_key: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.FeatureViewDataKey
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.FetchFeatureValuesResponse
)
Fetch feature values under a FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.transports.base.FeatureOnlineStoreServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.parse_feature_view_path
parse_feature_view_path(path: str) -> typing.Dict[str, str]
Parses a feature_view path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.search_nearest_entities
search_nearest_entities(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.SearchNearestEntitiesRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.SearchNearestEntitiesResponse
)
Search the nearest entities under a FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.streaming_fetch_feature_values
streaming_fetch_feature_values(
requests: typing.Optional[
typing.AsyncIterator[
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.StreamingFetchFeatureValuesRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.StreamingFetchFeatureValuesResponse
]
]
Bidirectional streaming RPC to fetch feature values under a FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient
FeatureOnlineStoreServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.feature_online_store_service.transports.base.FeatureOnlineStoreServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the feature online store service client.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.feature_view_path
feature_view_path(
project: str, location: str, feature_online_store: str, feature_view: str
) -> str
Returns a fully-qualified feature_view string.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.fetch_feature_values
fetch_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.FetchFeatureValuesRequest,
dict,
]
] = None,
*,
feature_view: typing.Optional[str] = None,
data_key: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.FeatureViewDataKey
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.FetchFeatureValuesResponse
)
Fetch feature values under a FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.parse_feature_view_path
parse_feature_view_path(path: str) -> typing.Dict[str, str]
Parses a feature_view path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.search_nearest_entities
search_nearest_entities(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.SearchNearestEntitiesRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.SearchNearestEntitiesResponse
)
Search the nearest entities under a FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.streaming_fetch_feature_values
streaming_fetch_feature_values(
requests: typing.Optional[
typing.Iterator[
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.StreamingFetchFeatureValuesRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1beta1.types.feature_online_store_service.StreamingFetchFeatureValuesResponse
]
Bidirectional streaming RPC to fetch feature values under a FeatureView.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.feature_online_store_service.FeatureOnlineStoreServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient
FeatureRegistryServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.feature_registry_service.transports.base.FeatureRegistryServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the feature registry service async client.
See more: google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.create_feature
create_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.CreateFeatureRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature.Feature
] = None,
feature_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Feature in a given FeatureGroup.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.create_feature_group
create_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_registry_service.CreateFeatureGroupRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature_group: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_group.FeatureGroup
] = None,
feature_group_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new FeatureGroup in a given project and location.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.delete_feature
delete_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.DeleteFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Feature.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.delete_feature_group
delete_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_registry_service.DeleteFeatureGroupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single FeatureGroup.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.feature_group_path
feature_group_path(project: str, location: str, feature_group: str) -> str
Returns a fully-qualified feature_group string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.feature_path
feature_path(
project: str, location: str, featurestore: str, entity_type: str, feature: str
) -> str
Returns a fully-qualified feature string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_feature
get_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.GetFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature.Feature
Gets details of a single Feature.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_feature_group
get_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_registry_service.GetFeatureGroupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature_group.FeatureGroup
Gets details of a single FeatureGroup.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.feature_registry_service.transports.base.FeatureRegistryServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.list_feature_groups
list_feature_groups(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_registry_service.ListFeatureGroupsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.feature_registry_service.pagers.ListFeatureGroupsAsyncPager
)
Lists FeatureGroups in a given project and location.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.list_features
list_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.feature_registry_service.pagers.ListFeaturesAsyncPager
)
Lists Features in a given FeatureGroup.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_feature_group_path
parse_feature_group_path(path: str) -> typing.Dict[str, str]
Parses a feature_group path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.parse_feature_path
parse_feature_path(path: str) -> typing.Dict[str, str]
Parses a feature path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.update_feature
update_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.UpdateFeatureRequest,
dict,
]
] = None,
*,
feature: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature.Feature
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Feature.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.update_feature_group
update_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_registry_service.UpdateFeatureGroupRequest,
dict,
]
] = None,
*,
feature_group: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_group.FeatureGroup
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single FeatureGroup.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient
FeatureRegistryServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.feature_registry_service.transports.base.FeatureRegistryServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the feature registry service client.
See more: google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.exit
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.create_feature
create_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.CreateFeatureRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature.Feature
] = None,
feature_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Feature in a given FeatureGroup.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.create_feature_group
create_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_registry_service.CreateFeatureGroupRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature_group: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_group.FeatureGroup
] = None,
feature_group_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new FeatureGroup in a given project and location.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.delete_feature
delete_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.DeleteFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single Feature.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.delete_feature_group
delete_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_registry_service.DeleteFeatureGroupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single FeatureGroup.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.feature_group_path
feature_group_path(project: str, location: str, feature_group: str) -> str
Returns a fully-qualified feature_group string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.feature_path
feature_path(
project: str, location: str, featurestore: str, entity_type: str, feature: str
) -> str
Returns a fully-qualified feature string.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.get_feature
get_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.GetFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature.Feature
Gets details of a single Feature.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.get_feature_group
get_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_registry_service.GetFeatureGroupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature_group.FeatureGroup
Gets details of a single FeatureGroup.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.list_feature_groups
list_feature_groups(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_registry_service.ListFeatureGroupsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.feature_registry_service.pagers.ListFeatureGroupsPager
)
Lists FeatureGroups in a given project and location.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.list_features
list_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.feature_registry_service.pagers.ListFeaturesPager
)
Lists Features in a given FeatureGroup.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.parse_feature_group_path
parse_feature_group_path(path: str) -> typing.Dict[str, str]
Parses a feature_group path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.parse_feature_path
parse_feature_path(path: str) -> typing.Dict[str, str]
Parses a feature path into its component segments.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.update_feature
update_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.UpdateFeatureRequest,
dict,
]
] = None,
*,
feature: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature.Feature
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Feature.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.update_feature_group
update_feature_group(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.feature_registry_service.UpdateFeatureGroupRequest,
dict,
]
] = None,
*,
feature_group: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature_group.FeatureGroup
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single FeatureGroup.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.FeatureRegistryServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.feature_registry_service.pagers.ListFeatureGroupsAsyncPager
ListFeatureGroupsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.feature_registry_service.ListFeatureGroupsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.feature_registry_service.ListFeatureGroupsRequest,
response: google.cloud.aiplatform_v1beta1.types.feature_registry_service.ListFeatureGroupsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.feature_registry_service.pagers.ListFeatureGroupsAsyncPager
google.cloud.aiplatform_v1beta1.services.feature_registry_service.pagers.ListFeatureGroupsPager
ListFeatureGroupsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.feature_registry_service.ListFeatureGroupsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.feature_registry_service.ListFeatureGroupsRequest,
response: google.cloud.aiplatform_v1beta1.types.feature_registry_service.ListFeatureGroupsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.feature_registry_service.pagers.ListFeatureGroupsPager
google.cloud.aiplatform_v1beta1.services.feature_registry_service.pagers.ListFeaturesAsyncPager
ListFeaturesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesRequest,
response: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.feature_registry_service.pagers.ListFeaturesAsyncPager
google.cloud.aiplatform_v1beta1.services.feature_registry_service.pagers.ListFeaturesPager
ListFeaturesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesRequest,
response: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.feature_registry_service.pagers.ListFeaturesPager
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient
FeaturestoreOnlineServingServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.transports.base.FeaturestoreOnlineServingServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the featurestore online serving service async client.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.entity_type_path
entity_type_path(
project: str, location: str, featurestore: str, entity_type: str
) -> str
Returns a fully-qualified entity_type string.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.transports.base.FeaturestoreOnlineServingServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.parse_entity_type_path
parse_entity_type_path(path: str) -> typing.Dict[str, str]
Parses a entity_type path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.read_feature_values
read_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.ReadFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.ReadFeatureValuesResponse
)
Reads Feature values of a specific entity of an EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.streaming_read_feature_values
streaming_read_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.StreamingReadFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.ReadFeatureValuesResponse
]
]
Reads Feature values for multiple entities.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceAsyncClient.write_feature_values
write_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.WriteFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
payloads: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.WriteFeatureValuesPayload
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.WriteFeatureValuesResponse
)
Writes Feature values of one or more entities of an EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient
FeaturestoreOnlineServingServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.transports.base.FeaturestoreOnlineServingServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the featurestore online serving service client.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.entity_type_path
entity_type_path(
project: str, location: str, featurestore: str, entity_type: str
) -> str
Returns a fully-qualified entity_type string.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.parse_entity_type_path
parse_entity_type_path(path: str) -> typing.Dict[str, str]
Parses a entity_type path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.read_feature_values
read_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.ReadFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.ReadFeatureValuesResponse
)
Reads Feature values of a specific entity of an EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.streaming_read_feature_values
streaming_read_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.StreamingReadFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.ReadFeatureValuesResponse
]
Reads Feature values for multiple entities.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.FeaturestoreOnlineServingServiceClient.write_feature_values
write_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.WriteFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
payloads: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.WriteFeatureValuesPayload
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.featurestore_online_service.WriteFeatureValuesResponse
)
Writes Feature values of one or more entities of an EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient
FeaturestoreServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.featurestore_service.transports.base.FeaturestoreServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the featurestore service async client.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.batch_create_features
batch_create_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.BatchCreateFeaturesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.featurestore_service.CreateFeatureRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a batch of Features in a given EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.batch_read_feature_values
batch_read_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.BatchReadFeatureValuesRequest,
dict,
]
] = None,
*,
featurestore: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Batch reads Feature values from a Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.create_entity_type
create_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.CreateEntityTypeRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
entity_type: typing.Optional[
google.cloud.aiplatform_v1beta1.types.entity_type.EntityType
] = None,
entity_type_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new EntityType in a given Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.create_feature
create_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.CreateFeatureRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature.Feature
] = None,
feature_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Feature in a given EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.create_featurestore
create_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.CreateFeaturestoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
featurestore: typing.Optional[
google.cloud.aiplatform_v1beta1.types.featurestore.Featurestore
] = None,
featurestore_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Featurestore in a given project and location.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.delete_entity_type
delete_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.DeleteEntityTypeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.delete_feature
delete_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.DeleteFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Feature.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.delete_feature_values
delete_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.DeleteFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Delete Feature values from Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.delete_featurestore
delete_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.DeleteFeaturestoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.entity_type_path
entity_type_path(
project: str, location: str, featurestore: str, entity_type: str
) -> str
Returns a fully-qualified entity_type string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.export_feature_values
export_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ExportFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Exports Feature values from all the entities of a target EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.feature_path
feature_path(
project: str, location: str, featurestore: str, entity_type: str, feature: str
) -> str
Returns a fully-qualified feature string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.featurestore_path
featurestore_path(project: str, location: str, featurestore: str) -> str
Returns a fully-qualified featurestore string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_entity_type
get_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.GetEntityTypeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.entity_type.EntityType
Gets details of a single EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_feature
get_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.GetFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature.Feature
Gets details of a single Feature.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_featurestore
get_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.GetFeaturestoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.featurestore.Featurestore
Gets details of a single Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.featurestore_service.transports.base.FeaturestoreServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.import_feature_values
import_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ImportFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports Feature values into the Featurestore from a source storage.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.list_entity_types
list_entity_types(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListEntityTypesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListEntityTypesAsyncPager
)
Lists EntityTypes in a given Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.list_features
list_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListFeaturesAsyncPager
)
Lists Features in a given EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.list_featurestores
list_featurestores(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturestoresRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListFeaturestoresAsyncPager
)
Lists Featurestores in a given project and location.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_entity_type_path
parse_entity_type_path(path: str) -> typing.Dict[str, str]
Parses a entity_type path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_feature_path
parse_feature_path(path: str) -> typing.Dict[str, str]
Parses a feature path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.parse_featurestore_path
parse_featurestore_path(path: str) -> typing.Dict[str, str]
Parses a featurestore path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.search_features
search_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.SearchFeaturesRequest,
dict,
]
] = None,
*,
location: typing.Optional[str] = None,
query: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.SearchFeaturesAsyncPager
)
Searches Features matching a query in a given project.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.update_entity_type
update_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.UpdateEntityTypeRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[
google.cloud.aiplatform_v1beta1.types.entity_type.EntityType
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.entity_type.EntityType
Updates the parameters of a single EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.update_feature
update_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.UpdateFeatureRequest,
dict,
]
] = None,
*,
feature: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature.Feature
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature.Feature
Updates the parameters of a single Feature.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.update_featurestore
update_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.UpdateFeaturestoreRequest,
dict,
]
] = None,
*,
featurestore: typing.Optional[
google.cloud.aiplatform_v1beta1.types.featurestore.Featurestore
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient
FeaturestoreServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.featurestore_service.transports.base.FeaturestoreServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the featurestore service client.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.exit
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.batch_create_features
batch_create_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.BatchCreateFeaturesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.featurestore_service.CreateFeatureRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a batch of Features in a given EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.batch_read_feature_values
batch_read_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.BatchReadFeatureValuesRequest,
dict,
]
] = None,
*,
featurestore: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Batch reads Feature values from a Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.create_entity_type
create_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.CreateEntityTypeRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
entity_type: typing.Optional[
google.cloud.aiplatform_v1beta1.types.entity_type.EntityType
] = None,
entity_type_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new EntityType in a given Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.create_feature
create_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.CreateFeatureRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
feature: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature.Feature
] = None,
feature_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Feature in a given EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.create_featurestore
create_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.CreateFeaturestoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
featurestore: typing.Optional[
google.cloud.aiplatform_v1beta1.types.featurestore.Featurestore
] = None,
featurestore_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Featurestore in a given project and location.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.delete_entity_type
delete_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.DeleteEntityTypeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.delete_feature
delete_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.DeleteFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single Feature.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.delete_feature_values
delete_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.DeleteFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Delete Feature values from Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.delete_featurestore
delete_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.DeleteFeaturestoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.entity_type_path
entity_type_path(
project: str, location: str, featurestore: str, entity_type: str
) -> str
Returns a fully-qualified entity_type string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.export_feature_values
export_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ExportFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Exports Feature values from all the entities of a target EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.feature_path
feature_path(
project: str, location: str, featurestore: str, entity_type: str, feature: str
) -> str
Returns a fully-qualified feature string.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.feature_path
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.featurestore_path
featurestore_path(project: str, location: str, featurestore: str) -> str
Returns a fully-qualified featurestore string.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.get_entity_type
get_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.GetEntityTypeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.entity_type.EntityType
Gets details of a single EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.get_feature
get_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.GetFeatureRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature.Feature
Gets details of a single Feature.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.get_feature
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.get_featurestore
get_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.GetFeaturestoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.featurestore.Featurestore
Gets details of a single Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.import_feature_values
import_feature_values(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ImportFeatureValuesRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Imports Feature values into the Featurestore from a source storage.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.list_entity_types
list_entity_types(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListEntityTypesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListEntityTypesPager
)
Lists EntityTypes in a given Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.list_features
list_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListFeaturesPager
)
Lists Features in a given EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.list_featurestores
list_featurestores(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturestoresRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListFeaturestoresPager
)
Lists Featurestores in a given project and location.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.parse_entity_type_path
parse_entity_type_path(path: str) -> typing.Dict[str, str]
Parses a entity_type path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.parse_feature_path
parse_feature_path(path: str) -> typing.Dict[str, str]
Parses a feature path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.parse_featurestore_path
parse_featurestore_path(path: str) -> typing.Dict[str, str]
Parses a featurestore path into its component segments.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.search_features
search_features(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.SearchFeaturesRequest,
dict,
]
] = None,
*,
location: typing.Optional[str] = None,
query: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.SearchFeaturesPager
)
Searches Features matching a query in a given project.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.update_entity_type
update_entity_type(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.UpdateEntityTypeRequest,
dict,
]
] = None,
*,
entity_type: typing.Optional[
google.cloud.aiplatform_v1beta1.types.entity_type.EntityType
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.entity_type.EntityType
Updates the parameters of a single EntityType.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.update_feature
update_feature(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.UpdateFeatureRequest,
dict,
]
] = None,
*,
feature: typing.Optional[
google.cloud.aiplatform_v1beta1.types.feature.Feature
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.feature.Feature
Updates the parameters of a single Feature.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.update_featurestore
update_featurestore(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.featurestore_service.UpdateFeaturestoreRequest,
dict,
]
] = None,
*,
featurestore: typing.Optional[
google.cloud.aiplatform_v1beta1.types.featurestore.Featurestore
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Featurestore.
google.cloud.aiplatform_v1beta1.services.featurestore_service.FeaturestoreServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListEntityTypesAsyncPager
ListEntityTypesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListEntityTypesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListEntityTypesRequest,
response: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListEntityTypesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListEntityTypesAsyncPager
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListEntityTypesPager
ListEntityTypesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListEntityTypesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListEntityTypesRequest,
response: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListEntityTypesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListEntityTypesPager
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListFeaturesAsyncPager
ListFeaturesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesRequest,
response: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListFeaturesAsyncPager
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListFeaturesPager
ListFeaturesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesRequest,
response: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListFeaturesPager
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListFeaturestoresAsyncPager
ListFeaturestoresAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturestoresResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturestoresRequest,
response: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturestoresResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListFeaturestoresAsyncPager
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListFeaturestoresPager
ListFeaturestoresPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturestoresResponse,
],
request: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturestoresRequest,
response: google.cloud.aiplatform_v1beta1.types.featurestore_service.ListFeaturestoresResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.ListFeaturestoresPager
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.SearchFeaturesAsyncPager
SearchFeaturesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.featurestore_service.SearchFeaturesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.featurestore_service.SearchFeaturesRequest,
response: google.cloud.aiplatform_v1beta1.types.featurestore_service.SearchFeaturesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.SearchFeaturesAsyncPager
google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.SearchFeaturesPager
SearchFeaturesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.featurestore_service.SearchFeaturesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.featurestore_service.SearchFeaturesRequest,
response: google.cloud.aiplatform_v1beta1.types.featurestore_service.SearchFeaturesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.featurestore_service.pagers.SearchFeaturesPager
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient
IndexEndpointServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.index_endpoint_service.transports.base.IndexEndpointServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the index endpoint service async client.
See more: google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.create_index_endpoint
create_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.CreateIndexEndpointRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
index_endpoint: typing.Optional[
google.cloud.aiplatform_v1beta1.types.index_endpoint.IndexEndpoint
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates an IndexEndpoint.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.delete_index_endpoint
delete_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.DeleteIndexEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes an IndexEndpoint.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.deploy_index
deploy_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.DeployIndexRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[str] = None,
deployed_index: typing.Optional[
google.cloud.aiplatform_v1beta1.types.index_endpoint.DeployedIndex
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.get_index_endpoint
get_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.GetIndexEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.index_endpoint.IndexEndpoint
Gets an IndexEndpoint.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.transports.base.IndexEndpointServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.index_endpoint_path
index_endpoint_path(project: str, location: str, index_endpoint: str) -> str
Returns a fully-qualified index_endpoint string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.index_path
index_path(project: str, location: str, index: str) -> str
Returns a fully-qualified index string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.list_index_endpoints
list_index_endpoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.ListIndexEndpointsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.pagers.ListIndexEndpointsAsyncPager
)
Lists IndexEndpoints in a Location.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.mutate_deployed_index
mutate_deployed_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.MutateDeployedIndexRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[str] = None,
deployed_index: typing.Optional[
google.cloud.aiplatform_v1beta1.types.index_endpoint.DeployedIndex
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Update an existing DeployedIndex under an IndexEndpoint.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_index_endpoint_path
parse_index_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a index_endpoint path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.parse_index_path
parse_index_path(path: str) -> typing.Dict[str, str]
Parses a index path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.undeploy_index
undeploy_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.UndeployIndexRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[str] = None,
deployed_index_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.update_index_endpoint
update_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.UpdateIndexEndpointRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[
google.cloud.aiplatform_v1beta1.types.index_endpoint.IndexEndpoint
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.index_endpoint.IndexEndpoint
Updates an IndexEndpoint.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient
IndexEndpointServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.index_endpoint_service.transports.base.IndexEndpointServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the index endpoint service client.
See more: google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.exit
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.create_index_endpoint
create_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.CreateIndexEndpointRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
index_endpoint: typing.Optional[
google.cloud.aiplatform_v1beta1.types.index_endpoint.IndexEndpoint
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates an IndexEndpoint.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.delete_index_endpoint
delete_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.DeleteIndexEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes an IndexEndpoint.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.deploy_index
deploy_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.DeployIndexRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[str] = None,
deployed_index: typing.Optional[
google.cloud.aiplatform_v1beta1.types.index_endpoint.DeployedIndex
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.get_index_endpoint
get_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.GetIndexEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.index_endpoint.IndexEndpoint
Gets an IndexEndpoint.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.index_endpoint_path
index_endpoint_path(project: str, location: str, index_endpoint: str) -> str
Returns a fully-qualified index_endpoint string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.index_path
index_path(project: str, location: str, index: str) -> str
Returns a fully-qualified index string.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.list_index_endpoints
list_index_endpoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.ListIndexEndpointsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.pagers.ListIndexEndpointsPager
)
Lists IndexEndpoints in a Location.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.mutate_deployed_index
mutate_deployed_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.MutateDeployedIndexRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[str] = None,
deployed_index: typing.Optional[
google.cloud.aiplatform_v1beta1.types.index_endpoint.DeployedIndex
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Update an existing DeployedIndex under an IndexEndpoint.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.parse_index_endpoint_path
parse_index_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a index_endpoint path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.parse_index_path
parse_index_path(path: str) -> typing.Dict[str, str]
Parses a index path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.undeploy_index
undeploy_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.UndeployIndexRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[str] = None,
deployed_index_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.update_index_endpoint
update_index_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.UpdateIndexEndpointRequest,
dict,
]
] = None,
*,
index_endpoint: typing.Optional[
google.cloud.aiplatform_v1beta1.types.index_endpoint.IndexEndpoint
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.index_endpoint.IndexEndpoint
Updates an IndexEndpoint.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.IndexEndpointServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.pagers.ListIndexEndpointsAsyncPager
ListIndexEndpointsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.ListIndexEndpointsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.index_endpoint_service.ListIndexEndpointsRequest,
response: google.cloud.aiplatform_v1beta1.types.index_endpoint_service.ListIndexEndpointsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.index_endpoint_service.pagers.ListIndexEndpointsAsyncPager
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.pagers.ListIndexEndpointsPager
ListIndexEndpointsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.index_endpoint_service.ListIndexEndpointsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.index_endpoint_service.ListIndexEndpointsRequest,
response: google.cloud.aiplatform_v1beta1.types.index_endpoint_service.ListIndexEndpointsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.index_endpoint_service.pagers.ListIndexEndpointsPager
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient
IndexServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.index_service.transports.base.IndexServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the index service async client.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.create_index
create_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.CreateIndexRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
index: typing.Optional[google.cloud.aiplatform_v1beta1.types.index.Index] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates an Index.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.create_index
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.delete_index
delete_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.DeleteIndexRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes an Index.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.delete_index
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.get_index
get_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.GetIndexRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.index.Index
Gets an Index.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.get_index
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.get_operation
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.index_service.transports.base.IndexServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.index_endpoint_path
index_endpoint_path(project: str, location: str, index_endpoint: str) -> str
Returns a fully-qualified index_endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.index_endpoint_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.index_path
index_path(project: str, location: str, index: str) -> str
Returns a fully-qualified index string.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.index_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.list_indexes
list_indexes(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.index_service.pagers.ListIndexesAsyncPager
)
Lists Indexes in a Location.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.list_indexes
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.list_locations
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.list_operations
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.parse_index_endpoint_path
parse_index_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a index_endpoint path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.parse_index_path
parse_index_path(path: str) -> typing.Dict[str, str]
Parses a index path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.parse_index_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.remove_datapoints
remove_datapoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.RemoveDatapointsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.index_service.RemoveDatapointsResponse
Remove Datapoints from an Index.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.remove_datapoints
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.update_index
update_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.UpdateIndexRequest, dict
]
] = None,
*,
index: typing.Optional[google.cloud.aiplatform_v1beta1.types.index.Index] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an Index.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.update_index
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.upsert_datapoints
upsert_datapoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.UpsertDatapointsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.index_service.UpsertDatapointsResponse
Add/update Datapoints into an Index.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.upsert_datapoints
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient
IndexServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.index_service.transports.base.IndexServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the index service client.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.exit
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.common_location_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.common_organization_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.common_project_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.create_index
create_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.CreateIndexRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
index: typing.Optional[google.cloud.aiplatform_v1beta1.types.index.Index] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates an Index.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.create_index
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.delete_index
delete_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.DeleteIndexRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes an Index.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.delete_index
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.from_service_account_file
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.from_service_account_info
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.from_service_account_json
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.get_index
get_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.GetIndexRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.index.Index
Gets an Index.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.get_index
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.index_endpoint_path
index_endpoint_path(project: str, location: str, index_endpoint: str) -> str
Returns a fully-qualified index_endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.index_endpoint_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.index_path
index_path(project: str, location: str, index: str) -> str
Returns a fully-qualified index string.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.index_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.list_indexes
list_indexes(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.services.index_service.pagers.ListIndexesPager
Lists Indexes in a Location.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.list_indexes
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.parse_common_location_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.parse_common_project_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.parse_index_endpoint_path
parse_index_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a index_endpoint path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.parse_index_endpoint_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.parse_index_path
parse_index_path(path: str) -> typing.Dict[str, str]
Parses a index path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.parse_index_path
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.remove_datapoints
remove_datapoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.RemoveDatapointsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.index_service.RemoveDatapointsResponse
Remove Datapoints from an Index.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.remove_datapoints
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.update_index
update_index(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.UpdateIndexRequest, dict
]
] = None,
*,
index: typing.Optional[google.cloud.aiplatform_v1beta1.types.index.Index] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates an Index.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.update_index
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.upsert_datapoints
upsert_datapoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.index_service.UpsertDatapointsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.index_service.UpsertDatapointsResponse
Add/update Datapoints into an Index.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.upsert_datapoints
google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.index_service.IndexServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.index_service.pagers.ListIndexesAsyncPager
ListIndexesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesRequest,
response: google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.index_service.pagers.ListIndexesAsyncPager
google.cloud.aiplatform_v1beta1.services.index_service.pagers.ListIndexesPager
ListIndexesPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesResponse
],
request: google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesRequest,
response: google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.index_service.pagers.ListIndexesPager
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient
JobServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.job_service.transports.base.JobServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the job service async client.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.batch_prediction_job_path
batch_prediction_job_path(
project: str, location: str, batch_prediction_job: str
) -> str
Returns a fully-qualified batch_prediction_job string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.batch_prediction_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.cancel_batch_prediction_job
cancel_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CancelBatchPredictionJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a BatchPredictionJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.cancel_custom_job
cancel_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CancelCustomJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a CustomJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.cancel_custom_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.cancel_data_labeling_job
cancel_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CancelDataLabelingJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a DataLabelingJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.cancel_data_labeling_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.cancel_hyperparameter_tuning_job
cancel_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CancelHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a HyperparameterTuningJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.cancel_nas_job
cancel_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CancelNasJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a NasJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.cancel_nas_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.common_organization_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.context_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.create_batch_prediction_job
create_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CreateBatchPredictionJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
batch_prediction_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.batch_prediction_job.BatchPredictionJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.batch_prediction_job.BatchPredictionJob
Creates a BatchPredictionJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.create_custom_job
create_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CreateCustomJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
custom_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.custom_job.CustomJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.custom_job.CustomJob
Creates a CustomJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.create_custom_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.create_data_labeling_job
create_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CreateDataLabelingJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
data_labeling_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.data_labeling_job.DataLabelingJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.data_labeling_job.DataLabelingJob
Creates a DataLabelingJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.create_data_labeling_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.create_hyperparameter_tuning_job
create_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CreateHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
hyperparameter_tuning_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.hyperparameter_tuning_job.HyperparameterTuningJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.hyperparameter_tuning_job.HyperparameterTuningJob
)
Creates a HyperparameterTuningJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.create_model_deployment_monitoring_job
create_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CreateModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
model_deployment_monitoring_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
)
Creates a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.create_nas_job
create_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CreateNasJobRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
nas_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.nas_job.NasJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.nas_job.NasJob
Creates a NasJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.create_nas_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.custom_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.data_labeling_job_path
data_labeling_job_path(project: str, location: str, data_labeling_job: str) -> str
Returns a fully-qualified data_labeling_job string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.data_labeling_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.dataset_path
dataset_path(project: str, location: str, dataset: str) -> str
Returns a fully-qualified dataset string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.dataset_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.delete_batch_prediction_job
delete_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.DeleteBatchPredictionJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a BatchPredictionJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.delete_custom_job
delete_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.DeleteCustomJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a CustomJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.delete_custom_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.delete_data_labeling_job
delete_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.DeleteDataLabelingJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a DataLabelingJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.delete_data_labeling_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.delete_hyperparameter_tuning_job
delete_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.DeleteHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a HyperparameterTuningJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.delete_model_deployment_monitoring_job
delete_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.DeleteModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.delete_nas_job
delete_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.DeleteNasJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a NasJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.delete_nas_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.endpoint_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.from_service_account_file
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.from_service_account_info
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.from_service_account_json
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_batch_prediction_job
get_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetBatchPredictionJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.batch_prediction_job.BatchPredictionJob
Gets a BatchPredictionJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_batch_prediction_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_custom_job
get_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetCustomJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.custom_job.CustomJob
Gets a CustomJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_custom_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_data_labeling_job
get_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetDataLabelingJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.data_labeling_job.DataLabelingJob
Gets a DataLabelingJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_data_labeling_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_hyperparameter_tuning_job
get_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.hyperparameter_tuning_job.HyperparameterTuningJob
)
Gets a HyperparameterTuningJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_model_deployment_monitoring_job
get_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
)
Gets a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_nas_job
get_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetNasJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.nas_job.NasJob
Gets a NasJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_nas_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_nas_trial_detail
get_nas_trial_detail(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetNasTrialDetailRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.nas_job.NasTrialDetail
Gets a NasTrialDetail.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_nas_trial_detail
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_operation
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.job_service.transports.base.JobServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.hyperparameter_tuning_job_path
hyperparameter_tuning_job_path(
project: str, location: str, hyperparameter_tuning_job: str
) -> str
Returns a fully-qualified hyperparameter_tuning_job string.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_batch_prediction_jobs
list_batch_prediction_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListBatchPredictionJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListBatchPredictionJobsAsyncPager
)
Lists BatchPredictionJobs in a Location.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_custom_jobs
list_custom_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListCustomJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListCustomJobsAsyncPager
)
Lists CustomJobs in a Location.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_custom_jobs
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_data_labeling_jobs
list_data_labeling_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListDataLabelingJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListDataLabelingJobsAsyncPager
)
Lists DataLabelingJobs in a Location.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_data_labeling_jobs
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_hyperparameter_tuning_jobs
list_hyperparameter_tuning_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListHyperparameterTuningJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListHyperparameterTuningJobsAsyncPager
)
Lists HyperparameterTuningJobs in a Location.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_locations
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_model_deployment_monitoring_jobs
list_model_deployment_monitoring_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListModelDeploymentMonitoringJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListModelDeploymentMonitoringJobsAsyncPager
)
Lists ModelDeploymentMonitoringJobs in a Location.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_nas_jobs
list_nas_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListNasJobsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListNasJobsAsyncPager
Lists NasJobs in a Location.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_nas_jobs
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_nas_trial_details
list_nas_trial_details(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListNasTrialDetailsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListNasTrialDetailsAsyncPager
)
List top NasTrialDetails of a NasJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_nas_trial_details
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.list_operations
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.model_deployment_monitoring_job_path
model_deployment_monitoring_job_path(
project: str, location: str, model_deployment_monitoring_job: str
) -> str
Returns a fully-qualified model_deployment_monitoring_job string.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.model_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.nas_job_path
nas_job_path(project: str, location: str, nas_job: str) -> str
Returns a fully-qualified nas_job string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.nas_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.nas_trial_detail_path
nas_trial_detail_path(
project: str, location: str, nas_job: str, nas_trial_detail: str
) -> str
Returns a fully-qualified nas_trial_detail string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.nas_trial_detail_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.network_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.notification_channel_path
notification_channel_path(project: str, notification_channel: str) -> str
Returns a fully-qualified notification_channel string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.notification_channel_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_batch_prediction_job_path
parse_batch_prediction_job_path(path: str) -> typing.Dict[str, str]
Parses a batch_prediction_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_common_folder_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_common_project_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_context_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_custom_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_data_labeling_job_path
parse_data_labeling_job_path(path: str) -> typing.Dict[str, str]
Parses a data_labeling_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_dataset_path
parse_dataset_path(path: str) -> typing.Dict[str, str]
Parses a dataset path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_dataset_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_endpoint_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_hyperparameter_tuning_job_path
parse_hyperparameter_tuning_job_path(path: str) -> typing.Dict[str, str]
Parses a hyperparameter_tuning_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_model_deployment_monitoring_job_path
parse_model_deployment_monitoring_job_path(path: str) -> typing.Dict[str, str]
Parses a model_deployment_monitoring_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_model_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_nas_job_path
parse_nas_job_path(path: str) -> typing.Dict[str, str]
Parses a nas_job path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_nas_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_nas_trial_detail_path
parse_nas_trial_detail_path(path: str) -> typing.Dict[str, str]
Parses a nas_trial_detail path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_network_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_notification_channel_path
parse_notification_channel_path(path: str) -> typing.Dict[str, str]
Parses a notification_channel path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_persistent_resource_path
parse_persistent_resource_path(path: str) -> typing.Dict[str, str]
Parses a persistent_resource path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_tensorboard_path
parse_tensorboard_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_tensorboard_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_trial_path
parse_trial_path(path: str) -> typing.Dict[str, str]
Parses a trial path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.parse_trial_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.pause_model_deployment_monitoring_job
pause_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.PauseModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Pauses a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.persistent_resource_path
persistent_resource_path(
project: str, location: str, persistent_resource: str
) -> str
Returns a fully-qualified persistent_resource string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.persistent_resource_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.resume_model_deployment_monitoring_job
resume_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ResumeModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Resumes a paused ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.search_model_deployment_monitoring_stats_anomalies
search_model_deployment_monitoring_stats_anomalies(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesRequest,
dict,
]
] = None,
*,
model_deployment_monitoring_job: typing.Optional[str] = None,
deployed_model_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.SearchModelDeploymentMonitoringStatsAnomaliesAsyncPager
)
Searches Model Monitoring Statistics generated within a given time window.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.tensorboard_path
tensorboard_path(project: str, location: str, tensorboard: str) -> str
Returns a fully-qualified tensorboard string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.tensorboard_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.trial_path
trial_path(project: str, location: str, study: str, trial: str) -> str
Returns a fully-qualified trial string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.trial_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.update_model_deployment_monitoring_job
update_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.UpdateModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
model_deployment_monitoring_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient
JobServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.job_service.transports.base.JobServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the job service client.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.exit
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.batch_prediction_job_path
batch_prediction_job_path(
project: str, location: str, batch_prediction_job: str
) -> str
Returns a fully-qualified batch_prediction_job string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.batch_prediction_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.cancel_batch_prediction_job
cancel_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CancelBatchPredictionJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a BatchPredictionJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.cancel_batch_prediction_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.cancel_custom_job
cancel_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CancelCustomJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a CustomJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.cancel_custom_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.cancel_data_labeling_job
cancel_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CancelDataLabelingJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a DataLabelingJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.cancel_data_labeling_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.cancel_hyperparameter_tuning_job
cancel_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CancelHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a HyperparameterTuningJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.cancel_nas_job
cancel_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CancelNasJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a NasJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.cancel_nas_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.common_billing_account_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.common_location_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.common_organization_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.common_project_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.context_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.create_batch_prediction_job
create_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CreateBatchPredictionJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
batch_prediction_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.batch_prediction_job.BatchPredictionJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.batch_prediction_job.BatchPredictionJob
Creates a BatchPredictionJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.create_batch_prediction_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.create_custom_job
create_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CreateCustomJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
custom_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.custom_job.CustomJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.custom_job.CustomJob
Creates a CustomJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.create_custom_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.create_data_labeling_job
create_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CreateDataLabelingJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
data_labeling_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.data_labeling_job.DataLabelingJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.data_labeling_job.DataLabelingJob
Creates a DataLabelingJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.create_data_labeling_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.create_hyperparameter_tuning_job
create_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CreateHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
hyperparameter_tuning_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.hyperparameter_tuning_job.HyperparameterTuningJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.hyperparameter_tuning_job.HyperparameterTuningJob
)
Creates a HyperparameterTuningJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.create_model_deployment_monitoring_job
create_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CreateModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
model_deployment_monitoring_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
)
Creates a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.create_nas_job
create_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.CreateNasJobRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
nas_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.nas_job.NasJob
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.nas_job.NasJob
Creates a NasJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.create_nas_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.custom_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.data_labeling_job_path
data_labeling_job_path(project: str, location: str, data_labeling_job: str) -> str
Returns a fully-qualified data_labeling_job string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.data_labeling_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.dataset_path
dataset_path(project: str, location: str, dataset: str) -> str
Returns a fully-qualified dataset string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.dataset_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.delete_batch_prediction_job
delete_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.DeleteBatchPredictionJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a BatchPredictionJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.delete_batch_prediction_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.delete_custom_job
delete_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.DeleteCustomJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a CustomJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.delete_custom_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.delete_data_labeling_job
delete_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.DeleteDataLabelingJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a DataLabelingJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.delete_data_labeling_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.delete_hyperparameter_tuning_job
delete_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.DeleteHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a HyperparameterTuningJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.delete_model_deployment_monitoring_job
delete_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.DeleteModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.delete_nas_job
delete_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.DeleteNasJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a NasJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.delete_nas_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.endpoint_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.from_service_account_file
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.from_service_account_info
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.from_service_account_json
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_batch_prediction_job
get_batch_prediction_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetBatchPredictionJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.batch_prediction_job.BatchPredictionJob
Gets a BatchPredictionJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_batch_prediction_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_custom_job
get_custom_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetCustomJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.custom_job.CustomJob
Gets a CustomJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_custom_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_data_labeling_job
get_data_labeling_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetDataLabelingJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.data_labeling_job.DataLabelingJob
Gets a DataLabelingJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_data_labeling_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_hyperparameter_tuning_job
get_hyperparameter_tuning_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetHyperparameterTuningJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.hyperparameter_tuning_job.HyperparameterTuningJob
)
Gets a HyperparameterTuningJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_hyperparameter_tuning_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_model_deployment_monitoring_job
get_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
)
Gets a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_nas_job
get_nas_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetNasJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.nas_job.NasJob
Gets a NasJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_nas_job
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_nas_trial_detail
get_nas_trial_detail(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.GetNasTrialDetailRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.nas_job.NasTrialDetail
Gets a NasTrialDetail.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_nas_trial_detail
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.hyperparameter_tuning_job_path
hyperparameter_tuning_job_path(
project: str, location: str, hyperparameter_tuning_job: str
) -> str
Returns a fully-qualified hyperparameter_tuning_job string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.hyperparameter_tuning_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_batch_prediction_jobs
list_batch_prediction_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListBatchPredictionJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListBatchPredictionJobsPager
)
Lists BatchPredictionJobs in a Location.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_batch_prediction_jobs
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_custom_jobs
list_custom_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListCustomJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListCustomJobsPager
Lists CustomJobs in a Location.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_custom_jobs
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_data_labeling_jobs
list_data_labeling_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListDataLabelingJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListDataLabelingJobsPager
)
Lists DataLabelingJobs in a Location.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_data_labeling_jobs
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_hyperparameter_tuning_jobs
list_hyperparameter_tuning_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListHyperparameterTuningJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListHyperparameterTuningJobsPager
)
Lists HyperparameterTuningJobs in a Location.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_model_deployment_monitoring_jobs
list_model_deployment_monitoring_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListModelDeploymentMonitoringJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListModelDeploymentMonitoringJobsPager
)
Lists ModelDeploymentMonitoringJobs in a Location.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_nas_jobs
list_nas_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListNasJobsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListNasJobsPager
Lists NasJobs in a Location.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_nas_jobs
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_nas_trial_details
list_nas_trial_details(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ListNasTrialDetailsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListNasTrialDetailsPager
)
List top NasTrialDetails of a NasJob.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_nas_trial_details
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.model_deployment_monitoring_job_path
model_deployment_monitoring_job_path(
project: str, location: str, model_deployment_monitoring_job: str
) -> str
Returns a fully-qualified model_deployment_monitoring_job string.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.model_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.nas_job_path
nas_job_path(project: str, location: str, nas_job: str) -> str
Returns a fully-qualified nas_job string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.nas_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.nas_trial_detail_path
nas_trial_detail_path(
project: str, location: str, nas_job: str, nas_trial_detail: str
) -> str
Returns a fully-qualified nas_trial_detail string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.nas_trial_detail_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.network_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.notification_channel_path
notification_channel_path(project: str, notification_channel: str) -> str
Returns a fully-qualified notification_channel string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.notification_channel_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_batch_prediction_job_path
parse_batch_prediction_job_path(path: str) -> typing.Dict[str, str]
Parses a batch_prediction_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_common_location_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_common_organization_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_common_project_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_context_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_custom_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_data_labeling_job_path
parse_data_labeling_job_path(path: str) -> typing.Dict[str, str]
Parses a data_labeling_job path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_data_labeling_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_dataset_path
parse_dataset_path(path: str) -> typing.Dict[str, str]
Parses a dataset path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_dataset_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_endpoint_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_hyperparameter_tuning_job_path
parse_hyperparameter_tuning_job_path(path: str) -> typing.Dict[str, str]
Parses a hyperparameter_tuning_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_model_deployment_monitoring_job_path
parse_model_deployment_monitoring_job_path(path: str) -> typing.Dict[str, str]
Parses a model_deployment_monitoring_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_model_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_nas_job_path
parse_nas_job_path(path: str) -> typing.Dict[str, str]
Parses a nas_job path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_nas_job_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_nas_trial_detail_path
parse_nas_trial_detail_path(path: str) -> typing.Dict[str, str]
Parses a nas_trial_detail path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_nas_trial_detail_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_network_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_notification_channel_path
parse_notification_channel_path(path: str) -> typing.Dict[str, str]
Parses a notification_channel path into its component segments.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_persistent_resource_path
parse_persistent_resource_path(path: str) -> typing.Dict[str, str]
Parses a persistent_resource path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_persistent_resource_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_tensorboard_path
parse_tensorboard_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_tensorboard_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_trial_path
parse_trial_path(path: str) -> typing.Dict[str, str]
Parses a trial path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.parse_trial_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.pause_model_deployment_monitoring_job
pause_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.PauseModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Pauses a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.persistent_resource_path
persistent_resource_path(
project: str, location: str, persistent_resource: str
) -> str
Returns a fully-qualified persistent_resource string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.persistent_resource_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.resume_model_deployment_monitoring_job
resume_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.ResumeModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Resumes a paused ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.search_model_deployment_monitoring_stats_anomalies
search_model_deployment_monitoring_stats_anomalies(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesRequest,
dict,
]
] = None,
*,
model_deployment_monitoring_job: typing.Optional[str] = None,
deployed_model_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.job_service.pagers.SearchModelDeploymentMonitoringStatsAnomaliesPager
)
Searches Model Monitoring Statistics generated within a given time window.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.tensorboard_path
tensorboard_path(project: str, location: str, tensorboard: str) -> str
Returns a fully-qualified tensorboard string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.tensorboard_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.trial_path
trial_path(project: str, location: str, study: str, trial: str) -> str
Returns a fully-qualified trial string.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.trial_path
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.update_model_deployment_monitoring_job
update_model_deployment_monitoring_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.job_service.UpdateModelDeploymentMonitoringJobRequest,
dict,
]
] = None,
*,
model_deployment_monitoring_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.model_deployment_monitoring_job.ModelDeploymentMonitoringJob
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates a ModelDeploymentMonitoringJob.
google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.job_service.JobServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListBatchPredictionJobsAsyncPager
ListBatchPredictionJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.job_service.ListBatchPredictionJobsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListBatchPredictionJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListBatchPredictionJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListBatchPredictionJobsAsyncPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListBatchPredictionJobsPager
ListBatchPredictionJobsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.job_service.ListBatchPredictionJobsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListBatchPredictionJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListBatchPredictionJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListBatchPredictionJobsPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListCustomJobsAsyncPager
ListCustomJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.job_service.ListCustomJobsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListCustomJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListCustomJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListCustomJobsAsyncPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListCustomJobsPager
ListCustomJobsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1beta1.types.job_service.ListCustomJobsResponse
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListCustomJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListCustomJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListCustomJobsPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListDataLabelingJobsAsyncPager
ListDataLabelingJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.job_service.ListDataLabelingJobsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListDataLabelingJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListDataLabelingJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListDataLabelingJobsAsyncPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListDataLabelingJobsPager
ListDataLabelingJobsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.job_service.ListDataLabelingJobsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListDataLabelingJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListDataLabelingJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListDataLabelingJobsPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListHyperparameterTuningJobsAsyncPager
ListHyperparameterTuningJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.job_service.ListHyperparameterTuningJobsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListHyperparameterTuningJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListHyperparameterTuningJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListHyperparameterTuningJobsAsyncPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListHyperparameterTuningJobsPager
ListHyperparameterTuningJobsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.job_service.ListHyperparameterTuningJobsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListHyperparameterTuningJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListHyperparameterTuningJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListHyperparameterTuningJobsPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListModelDeploymentMonitoringJobsAsyncPager
ListModelDeploymentMonitoringJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.job_service.ListModelDeploymentMonitoringJobsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListModelDeploymentMonitoringJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListModelDeploymentMonitoringJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListModelDeploymentMonitoringJobsPager
ListModelDeploymentMonitoringJobsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.job_service.ListModelDeploymentMonitoringJobsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListModelDeploymentMonitoringJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListModelDeploymentMonitoringJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListModelDeploymentMonitoringJobsPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListNasJobsAsyncPager
ListNasJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.job_service.ListNasJobsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListNasJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListNasJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListNasJobsAsyncPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListNasJobsPager
ListNasJobsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1beta1.types.job_service.ListNasJobsResponse
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListNasJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListNasJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListNasJobsPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListNasTrialDetailsAsyncPager
ListNasTrialDetailsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.job_service.ListNasTrialDetailsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListNasTrialDetailsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListNasTrialDetailsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListNasTrialDetailsAsyncPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListNasTrialDetailsPager
ListNasTrialDetailsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.job_service.ListNasTrialDetailsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.job_service.ListNasTrialDetailsRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.ListNasTrialDetailsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.job_service.pagers.ListNasTrialDetailsPager
google.cloud.aiplatform_v1beta1.services.job_service.pagers.SearchModelDeploymentMonitoringStatsAnomaliesAsyncPager
SearchModelDeploymentMonitoringStatsAnomaliesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.job_service.pagers.SearchModelDeploymentMonitoringStatsAnomaliesPager
SearchModelDeploymentMonitoringStatsAnomaliesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesRequest,
response: google.cloud.aiplatform_v1beta1.types.job_service.SearchModelDeploymentMonitoringStatsAnomaliesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient
LlmUtilityServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.llm_utility_service.transports.base.LlmUtilityServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the llm utility service async client.
See more: google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.compute_tokens
compute_tokens(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.llm_utility_service.ComputeTokensRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.llm_utility_service.ComputeTokensResponse
Return a list of tokens based on the input text.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.llm_utility_service.transports.base.LlmUtilityServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient
LlmUtilityServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.llm_utility_service.transports.base.LlmUtilityServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the llm utility service client.
See more: google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.exit
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.compute_tokens
compute_tokens(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.llm_utility_service.ComputeTokensRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.llm_utility_service.ComputeTokensResponse
Return a list of tokens based on the input text.
See more: google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.compute_tokens
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.endpoint_path
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.llm_utility_service.LlmUtilityServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient
MatchServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.match_service.transports.base.MatchServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the match service async client.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.find_neighbors
find_neighbors(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.match_service.FindNeighborsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.match_service.FindNeighborsResponse
Finds the nearest neighbors of each vector within the request.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.find_neighbors
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.get_operation
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.match_service.transports.base.MatchServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.index_endpoint_path
index_endpoint_path(project: str, location: str, index_endpoint: str) -> str
Returns a fully-qualified index_endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.index_endpoint_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.list_locations
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.list_operations
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.parse_index_endpoint_path
parse_index_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a index_endpoint path into its component segments.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.read_index_datapoints
read_index_datapoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.match_service.ReadIndexDatapointsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.match_service.ReadIndexDatapointsResponse
Reads the datapoints/vectors of the given IDs.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.read_index_datapoints
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient
MatchServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.match_service.transports.base.MatchServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the match service client.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.exit
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.common_location_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.common_organization_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.common_project_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.find_neighbors
find_neighbors(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.match_service.FindNeighborsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.match_service.FindNeighborsResponse
Finds the nearest neighbors of each vector within the request.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.find_neighbors
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.from_service_account_file
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.from_service_account_info
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.from_service_account_json
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.index_endpoint_path
index_endpoint_path(project: str, location: str, index_endpoint: str) -> str
Returns a fully-qualified index_endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.index_endpoint_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.parse_common_location_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.parse_common_project_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.parse_index_endpoint_path
parse_index_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a index_endpoint path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.parse_index_endpoint_path
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.read_index_datapoints
read_index_datapoints(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.match_service.ReadIndexDatapointsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.match_service.ReadIndexDatapointsResponse
Reads the datapoints/vectors of the given IDs.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.read_index_datapoints
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.match_service.MatchServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient
MetadataServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.metadata_service.transports.base.MetadataServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the metadata service async client.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.add_context_artifacts_and_executions
add_context_artifacts_and_executions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.AddContextArtifactsAndExecutionsRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
artifacts: typing.Optional[typing.MutableSequence[str]] = None,
executions: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.metadata_service.AddContextArtifactsAndExecutionsResponse
)
Adds a set of Artifacts and Executions to a Context.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.add_context_children
add_context_children(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.AddContextChildrenRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
child_contexts: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.metadata_service.AddContextChildrenResponse
Adds a set of Contexts as children to a parent Context.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.add_execution_events
add_execution_events(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.AddExecutionEventsRequest,
dict,
]
] = None,
*,
execution: typing.Optional[str] = None,
events: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1beta1.types.event.Event]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.metadata_service.AddExecutionEventsResponse
Adds Events to the specified Execution.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.artifact_path
artifact_path(
project: str, location: str, metadata_store: str, artifact: str
) -> str
Returns a fully-qualified artifact string.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.artifact_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.context_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.create_artifact
create_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.CreateArtifactRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
artifact: typing.Optional[
google.cloud.aiplatform_v1beta1.types.artifact.Artifact
] = None,
artifact_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.artifact.Artifact
Creates an Artifact associated with a MetadataStore.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.create_artifact
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.create_context
create_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.CreateContextRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
context: typing.Optional[
google.cloud.aiplatform_v1beta1.types.context.Context
] = None,
context_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.context.Context
Creates a Context associated with a MetadataStore.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.create_context
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.create_execution
create_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.CreateExecutionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
execution: typing.Optional[
google.cloud.aiplatform_v1beta1.types.execution.Execution
] = None,
execution_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.execution.Execution
Creates an Execution associated with a MetadataStore.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.create_metadata_schema
create_metadata_schema(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.CreateMetadataSchemaRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
metadata_schema: typing.Optional[
google.cloud.aiplatform_v1beta1.types.metadata_schema.MetadataSchema
] = None,
metadata_schema_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.metadata_schema.MetadataSchema
Creates a MetadataSchema.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.create_metadata_store
create_metadata_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.CreateMetadataStoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
metadata_store: typing.Optional[
google.cloud.aiplatform_v1beta1.types.metadata_store.MetadataStore
] = None,
metadata_store_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Initializes a MetadataStore, including allocation of resources.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.delete_artifact
delete_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.DeleteArtifactRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes an Artifact.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.delete_artifact
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.delete_context
delete_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.DeleteContextRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a stored Context.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.delete_context
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.delete_execution
delete_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.DeleteExecutionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes an Execution.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.delete_metadata_store
delete_metadata_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.DeleteMetadataStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.execution_path
execution_path(
project: str, location: str, metadata_store: str, execution: str
) -> str
Returns a fully-qualified execution string.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.execution_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_artifact
get_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.GetArtifactRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.artifact.Artifact
Retrieves a specific Artifact.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_artifact
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_context
get_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.GetContextRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.context.Context
Retrieves a specific Context.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_context
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_execution
get_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.GetExecutionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.execution.Execution
Retrieves a specific Execution.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_execution
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_metadata_schema
get_metadata_schema(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.GetMetadataSchemaRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.metadata_schema.MetadataSchema
Retrieves a specific MetadataSchema.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_metadata_store
get_metadata_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.GetMetadataStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.metadata_store.MetadataStore
Retrieves a specific MetadataStore.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_operation
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.metadata_service.transports.base.MetadataServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.list_artifacts
list_artifacts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListArtifactsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListArtifactsAsyncPager
)
Lists Artifacts in the MetadataStore.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.list_artifacts
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.list_contexts
list_contexts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListContextsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListContextsAsyncPager
)
Lists Contexts on the MetadataStore.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.list_contexts
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.list_executions
list_executions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListExecutionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListExecutionsAsyncPager
)
Lists Executions in the MetadataStore.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.list_executions
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.list_locations
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.list_metadata_schemas
list_metadata_schemas(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataSchemasRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataSchemasAsyncPager
)
Lists MetadataSchemas.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.list_metadata_stores
list_metadata_stores(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataStoresRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataStoresAsyncPager
)
Lists MetadataStores for a Location.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.list_operations
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.metadata_schema_path
metadata_schema_path(
project: str, location: str, metadata_store: str, metadata_schema: str
) -> str
Returns a fully-qualified metadata_schema string.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.metadata_store_path
metadata_store_path(project: str, location: str, metadata_store: str) -> str
Returns a fully-qualified metadata_store string.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.parse_artifact_path
parse_artifact_path(path: str) -> typing.Dict[str, str]
Parses a artifact path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.parse_metadata_schema_path
parse_metadata_schema_path(path: str) -> typing.Dict[str, str]
Parses a metadata_schema path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.parse_metadata_store_path
parse_metadata_store_path(path: str) -> typing.Dict[str, str]
Parses a metadata_store path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.purge_artifacts
purge_artifacts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.PurgeArtifactsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Purges Artifacts.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.purge_artifacts
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.purge_contexts
purge_contexts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.PurgeContextsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Purges Contexts.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.purge_contexts
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.purge_executions
purge_executions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.PurgeExecutionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Purges Executions.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.query_artifact_lineage_subgraph
query_artifact_lineage_subgraph(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.QueryArtifactLineageSubgraphRequest,
dict,
]
] = None,
*,
artifact: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.lineage_subgraph.LineageSubgraph
Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.query_context_lineage_subgraph
query_context_lineage_subgraph(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.QueryContextLineageSubgraphRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.lineage_subgraph.LineageSubgraph
Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.query_execution_inputs_and_outputs
query_execution_inputs_and_outputs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.QueryExecutionInputsAndOutputsRequest,
dict,
]
] = None,
*,
execution: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.lineage_subgraph.LineageSubgraph
Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.remove_context_children
remove_context_children(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.RemoveContextChildrenRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
child_contexts: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.metadata_service.RemoveContextChildrenResponse
)
Remove a set of children contexts from a parent Context.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.update_artifact
update_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.UpdateArtifactRequest,
dict,
]
] = None,
*,
artifact: typing.Optional[
google.cloud.aiplatform_v1beta1.types.artifact.Artifact
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.artifact.Artifact
Updates a stored Artifact.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.update_artifact
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.update_context
update_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.UpdateContextRequest,
dict,
]
] = None,
*,
context: typing.Optional[
google.cloud.aiplatform_v1beta1.types.context.Context
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.context.Context
Updates a stored Context.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.update_context
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.update_execution
update_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.UpdateExecutionRequest,
dict,
]
] = None,
*,
execution: typing.Optional[
google.cloud.aiplatform_v1beta1.types.execution.Execution
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.execution.Execution
Updates a stored Execution.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient
MetadataServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.metadata_service.transports.base.MetadataServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the metadata service client.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.exit
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.add_context_artifacts_and_executions
add_context_artifacts_and_executions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.AddContextArtifactsAndExecutionsRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
artifacts: typing.Optional[typing.MutableSequence[str]] = None,
executions: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.metadata_service.AddContextArtifactsAndExecutionsResponse
)
Adds a set of Artifacts and Executions to a Context.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.add_context_children
add_context_children(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.AddContextChildrenRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
child_contexts: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.metadata_service.AddContextChildrenResponse
Adds a set of Contexts as children to a parent Context.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.add_context_children
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.add_execution_events
add_execution_events(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.AddExecutionEventsRequest,
dict,
]
] = None,
*,
execution: typing.Optional[str] = None,
events: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1beta1.types.event.Event]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.metadata_service.AddExecutionEventsResponse
Adds Events to the specified Execution.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.add_execution_events
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.artifact_path
artifact_path(
project: str, location: str, metadata_store: str, artifact: str
) -> str
Returns a fully-qualified artifact string.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.artifact_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.common_location_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.common_project_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.context_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.create_artifact
create_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.CreateArtifactRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
artifact: typing.Optional[
google.cloud.aiplatform_v1beta1.types.artifact.Artifact
] = None,
artifact_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.artifact.Artifact
Creates an Artifact associated with a MetadataStore.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.create_artifact
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.create_context
create_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.CreateContextRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
context: typing.Optional[
google.cloud.aiplatform_v1beta1.types.context.Context
] = None,
context_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.context.Context
Creates a Context associated with a MetadataStore.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.create_context
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.create_execution
create_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.CreateExecutionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
execution: typing.Optional[
google.cloud.aiplatform_v1beta1.types.execution.Execution
] = None,
execution_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.execution.Execution
Creates an Execution associated with a MetadataStore.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.create_execution
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.create_metadata_schema
create_metadata_schema(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.CreateMetadataSchemaRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
metadata_schema: typing.Optional[
google.cloud.aiplatform_v1beta1.types.metadata_schema.MetadataSchema
] = None,
metadata_schema_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.metadata_schema.MetadataSchema
Creates a MetadataSchema.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.create_metadata_store
create_metadata_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.CreateMetadataStoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
metadata_store: typing.Optional[
google.cloud.aiplatform_v1beta1.types.metadata_store.MetadataStore
] = None,
metadata_store_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Initializes a MetadataStore, including allocation of resources.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.delete_artifact
delete_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.DeleteArtifactRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes an Artifact.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.delete_artifact
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.delete_context
delete_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.DeleteContextRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a stored Context.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.delete_context
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.delete_execution
delete_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.DeleteExecutionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes an Execution.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.delete_execution
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.delete_metadata_store
delete_metadata_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.DeleteMetadataStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.execution_path
execution_path(
project: str, location: str, metadata_store: str, execution: str
) -> str
Returns a fully-qualified execution string.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.execution_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_artifact
get_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.GetArtifactRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.artifact.Artifact
Retrieves a specific Artifact.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_artifact
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_context
get_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.GetContextRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.context.Context
Retrieves a specific Context.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_context
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_execution
get_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.GetExecutionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.execution.Execution
Retrieves a specific Execution.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_execution
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_metadata_schema
get_metadata_schema(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.GetMetadataSchemaRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.metadata_schema.MetadataSchema
Retrieves a specific MetadataSchema.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_metadata_schema
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_metadata_store
get_metadata_store(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.GetMetadataStoreRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.metadata_store.MetadataStore
Retrieves a specific MetadataStore.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_metadata_store
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_artifacts
list_artifacts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListArtifactsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListArtifactsPager
)
Lists Artifacts in the MetadataStore.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_artifacts
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_contexts
list_contexts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListContextsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListContextsPager
Lists Contexts on the MetadataStore.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_contexts
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_executions
list_executions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListExecutionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListExecutionsPager
)
Lists Executions in the MetadataStore.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_executions
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_metadata_schemas
list_metadata_schemas(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataSchemasRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataSchemasPager
)
Lists MetadataSchemas.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_metadata_stores
list_metadata_stores(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataStoresRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataStoresPager
)
Lists MetadataStores for a Location.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_metadata_stores
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.metadata_schema_path
metadata_schema_path(
project: str, location: str, metadata_store: str, metadata_schema: str
) -> str
Returns a fully-qualified metadata_schema string.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.metadata_schema_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.metadata_store_path
metadata_store_path(project: str, location: str, metadata_store: str) -> str
Returns a fully-qualified metadata_store string.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.metadata_store_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_artifact_path
parse_artifact_path(path: str) -> typing.Dict[str, str]
Parses a artifact path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_artifact_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_context_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_execution_path
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_metadata_schema_path
parse_metadata_schema_path(path: str) -> typing.Dict[str, str]
Parses a metadata_schema path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.parse_metadata_store_path
parse_metadata_store_path(path: str) -> typing.Dict[str, str]
Parses a metadata_store path into its component segments.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.purge_artifacts
purge_artifacts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.PurgeArtifactsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Purges Artifacts.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.purge_artifacts
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.purge_contexts
purge_contexts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.PurgeContextsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Purges Contexts.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.purge_contexts
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.purge_executions
purge_executions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.PurgeExecutionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Purges Executions.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.purge_executions
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.query_artifact_lineage_subgraph
query_artifact_lineage_subgraph(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.QueryArtifactLineageSubgraphRequest,
dict,
]
] = None,
*,
artifact: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.lineage_subgraph.LineageSubgraph
Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.query_context_lineage_subgraph
query_context_lineage_subgraph(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.QueryContextLineageSubgraphRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.lineage_subgraph.LineageSubgraph
Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.query_execution_inputs_and_outputs
query_execution_inputs_and_outputs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.QueryExecutionInputsAndOutputsRequest,
dict,
]
] = None,
*,
execution: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.lineage_subgraph.LineageSubgraph
Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.remove_context_children
remove_context_children(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.RemoveContextChildrenRequest,
dict,
]
] = None,
*,
context: typing.Optional[str] = None,
child_contexts: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.metadata_service.RemoveContextChildrenResponse
)
Remove a set of children contexts from a parent Context.
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.update_artifact
update_artifact(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.UpdateArtifactRequest,
dict,
]
] = None,
*,
artifact: typing.Optional[
google.cloud.aiplatform_v1beta1.types.artifact.Artifact
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.artifact.Artifact
Updates a stored Artifact.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.update_artifact
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.update_context
update_context(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.UpdateContextRequest,
dict,
]
] = None,
*,
context: typing.Optional[
google.cloud.aiplatform_v1beta1.types.context.Context
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.context.Context
Updates a stored Context.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.update_context
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.update_execution
update_execution(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.metadata_service.UpdateExecutionRequest,
dict,
]
] = None,
*,
execution: typing.Optional[
google.cloud.aiplatform_v1beta1.types.execution.Execution
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.execution.Execution
Updates a stored Execution.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.update_execution
google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.MetadataServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListArtifactsAsyncPager
ListArtifactsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListArtifactsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.metadata_service.ListArtifactsRequest,
response: google.cloud.aiplatform_v1beta1.types.metadata_service.ListArtifactsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListArtifactsAsyncPager
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListArtifactsPager
ListArtifactsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.metadata_service.ListArtifactsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.metadata_service.ListArtifactsRequest,
response: google.cloud.aiplatform_v1beta1.types.metadata_service.ListArtifactsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListArtifactsPager
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListContextsAsyncPager
ListContextsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListContextsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.metadata_service.ListContextsRequest,
response: google.cloud.aiplatform_v1beta1.types.metadata_service.ListContextsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListContextsAsyncPager
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListContextsPager
ListContextsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.metadata_service.ListContextsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.metadata_service.ListContextsRequest,
response: google.cloud.aiplatform_v1beta1.types.metadata_service.ListContextsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListContextsPager
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListExecutionsAsyncPager
ListExecutionsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListExecutionsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.metadata_service.ListExecutionsRequest,
response: google.cloud.aiplatform_v1beta1.types.metadata_service.ListExecutionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListExecutionsAsyncPager
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListExecutionsPager
ListExecutionsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.metadata_service.ListExecutionsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.metadata_service.ListExecutionsRequest,
response: google.cloud.aiplatform_v1beta1.types.metadata_service.ListExecutionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListExecutionsPager
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataSchemasAsyncPager
ListMetadataSchemasAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataSchemasResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataSchemasRequest,
response: google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataSchemasResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataSchemasAsyncPager
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataSchemasPager
ListMetadataSchemasPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataSchemasResponse,
],
request: google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataSchemasRequest,
response: google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataSchemasResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataSchemasPager
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataStoresAsyncPager
ListMetadataStoresAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataStoresResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataStoresRequest,
response: google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataStoresResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataStoresAsyncPager
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataStoresPager
ListMetadataStoresPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataStoresResponse,
],
request: google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataStoresRequest,
response: google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataStoresResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataStoresPager
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient
MigrationServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.migration_service.transports.base.MigrationServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the migration service async client.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.annotated_dataset_path
annotated_dataset_path(project: str, dataset: str, annotated_dataset: str) -> str
Returns a fully-qualified annotated_dataset string.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.batch_migrate_resources
batch_migrate_resources(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.migration_service.BatchMigrateResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
migrate_resource_requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.migration_service.MigrateResourceRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.dataset_path
dataset_path(project: str, location: str, dataset: str) -> str
Returns a fully-qualified dataset string.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.dataset_path
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.get_operation
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.migration_service.transports.base.MigrationServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.model_path
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.parse_annotated_dataset_path
parse_annotated_dataset_path(path: str) -> typing.Dict[str, str]
Parses a annotated_dataset path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.parse_dataset_path
parse_dataset_path(path: str) -> typing.Dict[str, str]
Parses a dataset path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.parse_version_path
parse_version_path(path: str) -> typing.Dict[str, str]
Parses a version path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.search_migratable_resources
search_migratable_resources(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.migration_service.SearchMigratableResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.migration_service.pagers.SearchMigratableResourcesAsyncPager
)
Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.version_path
version_path(project: str, model: str, version: str) -> str
Returns a fully-qualified version string.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.version_path
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient
MigrationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.migration_service.transports.base.MigrationServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the migration service client.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.exit
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.annotated_dataset_path
annotated_dataset_path(project: str, dataset: str, annotated_dataset: str) -> str
Returns a fully-qualified annotated_dataset string.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.batch_migrate_resources
batch_migrate_resources(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.migration_service.BatchMigrateResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
migrate_resource_requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.migration_service.MigrateResourceRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.dataset_path
dataset_path(project: str, location: str, dataset: str) -> str
Returns a fully-qualified dataset string.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.dataset_path
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.model_path
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.parse_annotated_dataset_path
parse_annotated_dataset_path(path: str) -> typing.Dict[str, str]
Parses a annotated_dataset path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.parse_dataset_path
parse_dataset_path(path: str) -> typing.Dict[str, str]
Parses a dataset path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.parse_dataset_path
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.parse_model_path
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.parse_version_path
parse_version_path(path: str) -> typing.Dict[str, str]
Parses a version path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.parse_version_path
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.search_migratable_resources
search_migratable_resources(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.migration_service.SearchMigratableResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.migration_service.pagers.SearchMigratableResourcesPager
)
Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.version_path
version_path(project: str, model: str, version: str) -> str
Returns a fully-qualified version string.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.version_path
google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.MigrationServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.migration_service.pagers.SearchMigratableResourcesAsyncPager
SearchMigratableResourcesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.migration_service.SearchMigratableResourcesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.migration_service.SearchMigratableResourcesRequest,
response: google.cloud.aiplatform_v1beta1.types.migration_service.SearchMigratableResourcesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.migration_service.pagers.SearchMigratableResourcesPager
SearchMigratableResourcesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.migration_service.SearchMigratableResourcesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.migration_service.SearchMigratableResourcesRequest,
response: google.cloud.aiplatform_v1beta1.types.migration_service.SearchMigratableResourcesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.migration_service.pagers.SearchMigratableResourcesPager
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient
ModelGardenServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.model_garden_service.transports.base.ModelGardenServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the model garden service async client.
See more: google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.get_publisher_model
get_publisher_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_garden_service.GetPublisherModelRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.publisher_model.PublisherModel
Gets a Model Garden publisher model.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.model_garden_service.transports.base.ModelGardenServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.list_publisher_models
list_publisher_models(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_garden_service.ListPublisherModelsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.model_garden_service.pagers.ListPublisherModelsAsyncPager
)
Lists publisher models in Model Garden.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.parse_publisher_model_path
parse_publisher_model_path(path: str) -> typing.Dict[str, str]
Parses a publisher_model path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.publisher_model_path
publisher_model_path(publisher: str, model: str) -> str
Returns a fully-qualified publisher_model string.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient
ModelGardenServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.model_garden_service.transports.base.ModelGardenServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the model garden service client.
See more: google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.exit
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.get_publisher_model
get_publisher_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_garden_service.GetPublisherModelRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.publisher_model.PublisherModel
Gets a Model Garden publisher model.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.list_publisher_models
list_publisher_models(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_garden_service.ListPublisherModelsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.model_garden_service.pagers.ListPublisherModelsPager
)
Lists publisher models in Model Garden.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.parse_publisher_model_path
parse_publisher_model_path(path: str) -> typing.Dict[str, str]
Parses a publisher_model path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.publisher_model_path
publisher_model_path(publisher: str, model: str) -> str
Returns a fully-qualified publisher_model string.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.model_garden_service.ModelGardenServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.model_garden_service.pagers.ListPublisherModelsAsyncPager
ListPublisherModelsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.model_garden_service.ListPublisherModelsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.model_garden_service.ListPublisherModelsRequest,
response: google.cloud.aiplatform_v1beta1.types.model_garden_service.ListPublisherModelsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.model_garden_service.pagers.ListPublisherModelsAsyncPager
google.cloud.aiplatform_v1beta1.services.model_garden_service.pagers.ListPublisherModelsPager
ListPublisherModelsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.model_garden_service.ListPublisherModelsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.model_garden_service.ListPublisherModelsRequest,
response: google.cloud.aiplatform_v1beta1.types.model_garden_service.ListPublisherModelsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.model_garden_service.pagers.ListPublisherModelsPager
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient
ModelServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.model_service.transports.base.ModelServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the model service async client.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.batch_import_evaluated_annotations
batch_import_evaluated_annotations(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.BatchImportEvaluatedAnnotationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
evaluated_annotations: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.evaluated_annotation.EvaluatedAnnotation
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.model_service.BatchImportEvaluatedAnnotationsResponse
)
Imports a list of externally generated EvaluatedAnnotations.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.batch_import_model_evaluation_slices
batch_import_model_evaluation_slices(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.BatchImportModelEvaluationSlicesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
model_evaluation_slices: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.model_evaluation_slice.ModelEvaluationSlice
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.model_service.BatchImportModelEvaluationSlicesResponse
)
Imports a list of externally generated ModelEvaluationSlice.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.common_location_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.copy_model
copy_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.CopyModelRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
source_model: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Copies an already existing Vertex AI Model into the specified Location.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.copy_model
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.delete_model
delete_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.DeleteModelRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a Model.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.delete_model
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.delete_model_version
delete_model_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.DeleteModelVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a Model version.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.delete_model_version
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.endpoint_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.export_model
export_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.ExportModelRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
output_config: typing.Optional[
google.cloud.aiplatform_v1beta1.types.model_service.ExportModelRequest.OutputConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Exports a trained, exportable Model to a location specified by the user.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.export_model
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_model
get_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.GetModelRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.model.Model
Gets a Model.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_model
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_model_evaluation
get_model_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.GetModelEvaluationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.model_evaluation.ModelEvaluation
Gets a ModelEvaluation.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_model_evaluation
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_model_evaluation_slice
get_model_evaluation_slice(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.GetModelEvaluationSliceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.model_evaluation_slice.ModelEvaluationSlice
Gets a ModelEvaluationSlice.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_operation
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.model_service.transports.base.ModelServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.import_model_evaluation
import_model_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.ImportModelEvaluationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
model_evaluation: typing.Optional[
google.cloud.aiplatform_v1beta1.types.model_evaluation.ModelEvaluation
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.model_evaluation.ModelEvaluation
Imports an externally generated ModelEvaluation.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.list_locations
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.list_model_evaluation_slices
list_model_evaluation_slices(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationSlicesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelEvaluationSlicesAsyncPager
)
Lists ModelEvaluationSlices in a ModelEvaluation.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.list_model_evaluations
list_model_evaluations(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelEvaluationsAsyncPager
)
Lists ModelEvaluations in a Model.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.list_model_versions
list_model_versions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.ListModelVersionsRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelVersionsAsyncPager
)
Lists versions of the specified model.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.list_model_versions
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.list_models
list_models(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.ListModelsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelsAsyncPager
Lists Models in a Location.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.list_models
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.list_operations
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.merge_version_aliases
merge_version_aliases(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.MergeVersionAliasesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
version_aliases: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.model.Model
Merges a set of aliases for a Model version.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.merge_version_aliases
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.model_evaluation_path
model_evaluation_path(
project: str, location: str, model: str, evaluation: str
) -> str
Returns a fully-qualified model_evaluation string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.model_evaluation_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.model_evaluation_slice_path
model_evaluation_slice_path(
project: str, location: str, model: str, evaluation: str, slice: str
) -> str
Returns a fully-qualified model_evaluation_slice string.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.model_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.parse_endpoint_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.parse_model_evaluation_path
parse_model_evaluation_path(path: str) -> typing.Dict[str, str]
Parses a model_evaluation path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.parse_model_evaluation_slice_path
parse_model_evaluation_slice_path(path: str) -> typing.Dict[str, str]
Parses a model_evaluation_slice path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.parse_model_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.parse_training_pipeline_path
parse_training_pipeline_path(path: str) -> typing.Dict[str, str]
Parses a training_pipeline path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.training_pipeline_path
training_pipeline_path(project: str, location: str, training_pipeline: str) -> str
Returns a fully-qualified training_pipeline string.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.update_explanation_dataset
update_explanation_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.UpdateExplanationDatasetRequest,
dict,
]
] = None,
*,
model: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Incrementally update the dataset used for an examples model.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.update_model
update_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.UpdateModelRequest, dict
]
] = None,
*,
model: typing.Optional[google.cloud.aiplatform_v1beta1.types.model.Model] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.model.Model
Updates a Model.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.update_model
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.upload_model
upload_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.UploadModelRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
model: typing.Optional[google.cloud.aiplatform_v1beta1.types.model.Model] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Uploads a Model artifact into Vertex AI.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.upload_model
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient
ModelServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.model_service.transports.base.ModelServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the model service client.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.exit
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.batch_import_evaluated_annotations
batch_import_evaluated_annotations(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.BatchImportEvaluatedAnnotationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
evaluated_annotations: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.evaluated_annotation.EvaluatedAnnotation
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.model_service.BatchImportEvaluatedAnnotationsResponse
)
Imports a list of externally generated EvaluatedAnnotations.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.batch_import_model_evaluation_slices
batch_import_model_evaluation_slices(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.BatchImportModelEvaluationSlicesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
model_evaluation_slices: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.model_evaluation_slice.ModelEvaluationSlice
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.model_service.BatchImportModelEvaluationSlicesResponse
)
Imports a list of externally generated ModelEvaluationSlice.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.common_location_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.common_organization_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.common_project_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.copy_model
copy_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.CopyModelRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
source_model: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Copies an already existing Vertex AI Model into the specified Location.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.copy_model
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.delete_model
delete_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.DeleteModelRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a Model.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.delete_model
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.delete_model_version
delete_model_version(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.DeleteModelVersionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a Model version.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.delete_model_version
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.endpoint_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.export_model
export_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.ExportModelRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
output_config: typing.Optional[
google.cloud.aiplatform_v1beta1.types.model_service.ExportModelRequest.OutputConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Exports a trained, exportable Model to a location specified by the user.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.export_model
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.from_service_account_file
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.from_service_account_info
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.from_service_account_json
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_model
get_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.GetModelRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.model.Model
Gets a Model.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_model
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_model_evaluation
get_model_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.GetModelEvaluationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.model_evaluation.ModelEvaluation
Gets a ModelEvaluation.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_model_evaluation
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_model_evaluation_slice
get_model_evaluation_slice(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.GetModelEvaluationSliceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.model_evaluation_slice.ModelEvaluationSlice
Gets a ModelEvaluationSlice.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_model_evaluation_slice
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.import_model_evaluation
import_model_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.ImportModelEvaluationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
model_evaluation: typing.Optional[
google.cloud.aiplatform_v1beta1.types.model_evaluation.ModelEvaluation
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.model_evaluation.ModelEvaluation
Imports an externally generated ModelEvaluation.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.import_model_evaluation
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.list_model_evaluation_slices
list_model_evaluation_slices(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationSlicesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelEvaluationSlicesPager
)
Lists ModelEvaluationSlices in a ModelEvaluation.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.list_model_evaluations
list_model_evaluations(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelEvaluationsPager
)
Lists ModelEvaluations in a Model.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.list_model_evaluations
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.list_model_versions
list_model_versions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.ListModelVersionsRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelVersionsPager
)
Lists versions of the specified model.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.list_model_versions
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.list_models
list_models(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.ListModelsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelsPager
Lists Models in a Location.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.list_models
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.merge_version_aliases
merge_version_aliases(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.MergeVersionAliasesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
version_aliases: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.model.Model
Merges a set of aliases for a Model version.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.merge_version_aliases
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.model_evaluation_path
model_evaluation_path(
project: str, location: str, model: str, evaluation: str
) -> str
Returns a fully-qualified model_evaluation string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.model_evaluation_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.model_evaluation_slice_path
model_evaluation_slice_path(
project: str, location: str, model: str, evaluation: str, slice: str
) -> str
Returns a fully-qualified model_evaluation_slice string.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.model_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_common_location_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_common_project_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_endpoint_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_model_evaluation_path
parse_model_evaluation_path(path: str) -> typing.Dict[str, str]
Parses a model_evaluation path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_model_evaluation_slice_path
parse_model_evaluation_slice_path(path: str) -> typing.Dict[str, str]
Parses a model_evaluation_slice path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_model_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.parse_training_pipeline_path
parse_training_pipeline_path(path: str) -> typing.Dict[str, str]
Parses a training_pipeline path into its component segments.
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.training_pipeline_path
training_pipeline_path(project: str, location: str, training_pipeline: str) -> str
Returns a fully-qualified training_pipeline string.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.training_pipeline_path
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.update_explanation_dataset
update_explanation_dataset(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.UpdateExplanationDatasetRequest,
dict,
]
] = None,
*,
model: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Incrementally update the dataset used for an examples model.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.update_explanation_dataset
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.update_model
update_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.UpdateModelRequest, dict
]
] = None,
*,
model: typing.Optional[google.cloud.aiplatform_v1beta1.types.model.Model] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.model.Model
Updates a Model.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.update_model
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.upload_model
upload_model(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.model_service.UploadModelRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
model: typing.Optional[google.cloud.aiplatform_v1beta1.types.model.Model] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Uploads a Model artifact into Vertex AI.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.upload_model
google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.model_service.ModelServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelEvaluationSlicesAsyncPager
ListModelEvaluationSlicesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationSlicesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationSlicesRequest,
response: google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationSlicesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelEvaluationSlicesAsyncPager
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelEvaluationSlicesPager
ListModelEvaluationSlicesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationSlicesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationSlicesRequest,
response: google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationSlicesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelEvaluationSlicesPager
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelEvaluationsAsyncPager
ListModelEvaluationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationsRequest,
response: google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelEvaluationsAsyncPager
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelEvaluationsPager
ListModelEvaluationsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationsRequest,
response: google.cloud.aiplatform_v1beta1.types.model_service.ListModelEvaluationsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelEvaluationsPager
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelVersionsAsyncPager
ListModelVersionsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.model_service.ListModelVersionsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.model_service.ListModelVersionsRequest,
response: google.cloud.aiplatform_v1beta1.types.model_service.ListModelVersionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelVersionsAsyncPager
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelVersionsPager
ListModelVersionsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.model_service.ListModelVersionsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.model_service.ListModelVersionsRequest,
response: google.cloud.aiplatform_v1beta1.types.model_service.ListModelVersionsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelVersionsPager
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelsAsyncPager
ListModelsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.model_service.ListModelsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.model_service.ListModelsRequest,
response: google.cloud.aiplatform_v1beta1.types.model_service.ListModelsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelsAsyncPager
google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelsPager
ListModelsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1beta1.types.model_service.ListModelsResponse
],
request: google.cloud.aiplatform_v1beta1.types.model_service.ListModelsRequest,
response: google.cloud.aiplatform_v1beta1.types.model_service.ListModelsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.model_service.pagers.ListModelsPager
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient
NotebookServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.notebook_service.transports.base.NotebookServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the notebook service async client.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.assign_notebook_runtime
assign_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.AssignNotebookRuntimeRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
notebook_runtime_template: typing.Optional[str] = None,
notebook_runtime: typing.Optional[
google.cloud.aiplatform_v1beta1.types.notebook_runtime.NotebookRuntime
] = None,
notebook_runtime_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Assigns a NotebookRuntime to a user for a particular Notebook file.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.create_notebook_runtime_template
create_notebook_runtime_template(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.CreateNotebookRuntimeTemplateRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
notebook_runtime_template: typing.Optional[
google.cloud.aiplatform_v1beta1.types.notebook_runtime.NotebookRuntimeTemplate
] = None,
notebook_runtime_template_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a NotebookRuntimeTemplate.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.delete_notebook_runtime
delete_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.DeleteNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a NotebookRuntime.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.delete_notebook_runtime_template
delete_notebook_runtime_template(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.DeleteNotebookRuntimeTemplateRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a NotebookRuntimeTemplate.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_notebook_runtime
get_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.GetNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.notebook_runtime.NotebookRuntime
Gets a NotebookRuntime.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_notebook_runtime_template
get_notebook_runtime_template(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.GetNotebookRuntimeTemplateRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.notebook_runtime.NotebookRuntimeTemplate
Gets a NotebookRuntimeTemplate.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_operation
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.notebook_service.transports.base.NotebookServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_locations
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_notebook_runtime_templates
list_notebook_runtime_templates(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimeTemplatesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.notebook_service.pagers.ListNotebookRuntimeTemplatesAsyncPager
)
Lists NotebookRuntimeTemplates in a Location.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_notebook_runtimes
list_notebook_runtimes(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.notebook_service.pagers.ListNotebookRuntimesAsyncPager
)
Lists NotebookRuntimes in a Location.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_operations
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.network_path
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.notebook_runtime_path
notebook_runtime_path(project: str, location: str, notebook_runtime: str) -> str
Returns a fully-qualified notebook_runtime string.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.notebook_runtime_template_path
notebook_runtime_template_path(
project: str, location: str, notebook_runtime_template: str
) -> str
Returns a fully-qualified notebook_runtime_template string.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_notebook_runtime_path
parse_notebook_runtime_path(path: str) -> typing.Dict[str, str]
Parses a notebook_runtime path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_notebook_runtime_template_path
parse_notebook_runtime_template_path(path: str) -> typing.Dict[str, str]
Parses a notebook_runtime_template path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_subnetwork_path
parse_subnetwork_path(path: str) -> typing.Dict[str, str]
Parses a subnetwork path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.start_notebook_runtime
start_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.StartNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Starts a NotebookRuntime.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.subnetwork_path
subnetwork_path(project: str, region: str, subnetwork: str) -> str
Returns a fully-qualified subnetwork string.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.subnetwork_path
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.upgrade_notebook_runtime
upgrade_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.UpgradeNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Upgrades a NotebookRuntime.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient
NotebookServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.notebook_service.transports.base.NotebookServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the notebook service client.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.exit
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.assign_notebook_runtime
assign_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.AssignNotebookRuntimeRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
notebook_runtime_template: typing.Optional[str] = None,
notebook_runtime: typing.Optional[
google.cloud.aiplatform_v1beta1.types.notebook_runtime.NotebookRuntime
] = None,
notebook_runtime_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Assigns a NotebookRuntime to a user for a particular Notebook file.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.common_location_path
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.common_project_path
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.create_notebook_runtime_template
create_notebook_runtime_template(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.CreateNotebookRuntimeTemplateRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
notebook_runtime_template: typing.Optional[
google.cloud.aiplatform_v1beta1.types.notebook_runtime.NotebookRuntimeTemplate
] = None,
notebook_runtime_template_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a NotebookRuntimeTemplate.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.delete_notebook_runtime
delete_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.DeleteNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a NotebookRuntime.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.delete_notebook_runtime_template
delete_notebook_runtime_template(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.DeleteNotebookRuntimeTemplateRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a NotebookRuntimeTemplate.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.get_notebook_runtime
get_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.GetNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.notebook_runtime.NotebookRuntime
Gets a NotebookRuntime.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.get_notebook_runtime
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.get_notebook_runtime_template
get_notebook_runtime_template(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.GetNotebookRuntimeTemplateRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.notebook_runtime.NotebookRuntimeTemplate
Gets a NotebookRuntimeTemplate.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.list_notebook_runtime_templates
list_notebook_runtime_templates(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimeTemplatesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.notebook_service.pagers.ListNotebookRuntimeTemplatesPager
)
Lists NotebookRuntimeTemplates in a Location.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.list_notebook_runtimes
list_notebook_runtimes(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.notebook_service.pagers.ListNotebookRuntimesPager
)
Lists NotebookRuntimes in a Location.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.network_path
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.notebook_runtime_path
notebook_runtime_path(project: str, location: str, notebook_runtime: str) -> str
Returns a fully-qualified notebook_runtime string.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.notebook_runtime_template_path
notebook_runtime_template_path(
project: str, location: str, notebook_runtime_template: str
) -> str
Returns a fully-qualified notebook_runtime_template string.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.parse_network_path
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.parse_notebook_runtime_path
parse_notebook_runtime_path(path: str) -> typing.Dict[str, str]
Parses a notebook_runtime path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.parse_notebook_runtime_template_path
parse_notebook_runtime_template_path(path: str) -> typing.Dict[str, str]
Parses a notebook_runtime_template path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.parse_subnetwork_path
parse_subnetwork_path(path: str) -> typing.Dict[str, str]
Parses a subnetwork path into its component segments.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.start_notebook_runtime
start_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.StartNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Starts a NotebookRuntime.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.subnetwork_path
subnetwork_path(project: str, region: str, subnetwork: str) -> str
Returns a fully-qualified subnetwork string.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.subnetwork_path
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.upgrade_notebook_runtime
upgrade_notebook_runtime(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.notebook_service.UpgradeNotebookRuntimeRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Upgrades a NotebookRuntime.
google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.NotebookServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.notebook_service.pagers.ListNotebookRuntimeTemplatesAsyncPager
ListNotebookRuntimeTemplatesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimeTemplatesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimeTemplatesRequest,
response: google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimeTemplatesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.notebook_service.pagers.ListNotebookRuntimeTemplatesPager
ListNotebookRuntimeTemplatesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimeTemplatesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimeTemplatesRequest,
response: google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimeTemplatesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.pagers.ListNotebookRuntimeTemplatesPager
google.cloud.aiplatform_v1beta1.services.notebook_service.pagers.ListNotebookRuntimesAsyncPager
ListNotebookRuntimesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimesRequest,
response: google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.pagers.ListNotebookRuntimesAsyncPager
google.cloud.aiplatform_v1beta1.services.notebook_service.pagers.ListNotebookRuntimesPager
ListNotebookRuntimesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimesRequest,
response: google.cloud.aiplatform_v1beta1.types.notebook_service.ListNotebookRuntimesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.notebook_service.pagers.ListNotebookRuntimesPager
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient
PersistentResourceServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.persistent_resource_service.transports.base.PersistentResourceServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the persistent resource service async client.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.create_persistent_resource
create_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.CreatePersistentResourceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
persistent_resource: typing.Optional[
google.cloud.aiplatform_v1beta1.types.persistent_resource.PersistentResource
] = None,
persistent_resource_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a PersistentResource.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.delete_persistent_resource
delete_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.DeletePersistentResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a PersistentResource.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.get_persistent_resource
get_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.GetPersistentResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.persistent_resource.PersistentResource
Gets a PersistentResource.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.transports.base.PersistentResourceServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.list_persistent_resources
list_persistent_resources(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.ListPersistentResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.pagers.ListPersistentResourcesAsyncPager
)
Lists PersistentResources in a Location.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.notebook_runtime_template_path
notebook_runtime_template_path(
project: str, location: str, notebook_runtime_template: str
) -> str
Returns a fully-qualified notebook_runtime_template string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_notebook_runtime_template_path
parse_notebook_runtime_template_path(path: str) -> typing.Dict[str, str]
Parses a notebook_runtime_template path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.parse_persistent_resource_path
parse_persistent_resource_path(path: str) -> typing.Dict[str, str]
Parses a persistent_resource path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.persistent_resource_path
persistent_resource_path(
project: str, location: str, persistent_resource: str
) -> str
Returns a fully-qualified persistent_resource string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.reboot_persistent_resource
reboot_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.RebootPersistentResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Reboots a PersistentResource.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.update_persistent_resource
update_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.UpdatePersistentResourceRequest,
dict,
]
] = None,
*,
persistent_resource: typing.Optional[
google.cloud.aiplatform_v1beta1.types.persistent_resource.PersistentResource
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a PersistentResource.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient
PersistentResourceServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.persistent_resource_service.transports.base.PersistentResourceServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the persistent resource service client.
See more: google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.create_persistent_resource
create_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.CreatePersistentResourceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
persistent_resource: typing.Optional[
google.cloud.aiplatform_v1beta1.types.persistent_resource.PersistentResource
] = None,
persistent_resource_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a PersistentResource.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.delete_persistent_resource
delete_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.DeletePersistentResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a PersistentResource.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.get_persistent_resource
get_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.GetPersistentResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.persistent_resource.PersistentResource
Gets a PersistentResource.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.list_persistent_resources
list_persistent_resources(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.ListPersistentResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.pagers.ListPersistentResourcesPager
)
Lists PersistentResources in a Location.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.notebook_runtime_template_path
notebook_runtime_template_path(
project: str, location: str, notebook_runtime_template: str
) -> str
Returns a fully-qualified notebook_runtime_template string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.parse_notebook_runtime_template_path
parse_notebook_runtime_template_path(path: str) -> typing.Dict[str, str]
Parses a notebook_runtime_template path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.parse_persistent_resource_path
parse_persistent_resource_path(path: str) -> typing.Dict[str, str]
Parses a persistent_resource path into its component segments.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.persistent_resource_path
persistent_resource_path(
project: str, location: str, persistent_resource: str
) -> str
Returns a fully-qualified persistent_resource string.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.reboot_persistent_resource
reboot_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.RebootPersistentResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Reboots a PersistentResource.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.update_persistent_resource
update_persistent_resource(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.UpdatePersistentResourceRequest,
dict,
]
] = None,
*,
persistent_resource: typing.Optional[
google.cloud.aiplatform_v1beta1.types.persistent_resource.PersistentResource
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates a PersistentResource.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.PersistentResourceServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.pagers.ListPersistentResourcesAsyncPager
ListPersistentResourcesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.ListPersistentResourcesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.persistent_resource_service.ListPersistentResourcesRequest,
response: google.cloud.aiplatform_v1beta1.types.persistent_resource_service.ListPersistentResourcesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.persistent_resource_service.pagers.ListPersistentResourcesPager
ListPersistentResourcesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.persistent_resource_service.ListPersistentResourcesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.persistent_resource_service.ListPersistentResourcesRequest,
response: google.cloud.aiplatform_v1beta1.types.persistent_resource_service.ListPersistentResourcesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient
PipelineServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.pipeline_service.transports.base.PipelineServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the pipeline service async client.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.artifact_path
artifact_path(
project: str, location: str, metadata_store: str, artifact: str
) -> str
Returns a fully-qualified artifact string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.artifact_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.batch_cancel_pipeline_jobs
batch_cancel_pipeline_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.BatchCancelPipelineJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
names: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Batch cancel PipelineJobs.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.batch_delete_pipeline_jobs
batch_delete_pipeline_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.BatchDeletePipelineJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
names: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Batch deletes PipelineJobs The Operation is atomic.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.cancel_pipeline_job
cancel_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.CancelPipelineJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a PipelineJob.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.cancel_training_pipeline
cancel_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.CancelTrainingPipelineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a TrainingPipeline.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.context_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.create_pipeline_job
create_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.CreatePipelineJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
pipeline_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.pipeline_job.PipelineJob
] = None,
pipeline_job_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.pipeline_job.PipelineJob
Creates a PipelineJob.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.create_training_pipeline
create_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.CreateTrainingPipelineRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
training_pipeline: typing.Optional[
google.cloud.aiplatform_v1beta1.types.training_pipeline.TrainingPipeline
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.training_pipeline.TrainingPipeline
Creates a TrainingPipeline.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.custom_job_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.delete_pipeline_job
delete_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.DeletePipelineJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a PipelineJob.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.delete_training_pipeline
delete_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.DeleteTrainingPipelineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a TrainingPipeline.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.endpoint_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.execution_path
execution_path(
project: str, location: str, metadata_store: str, execution: str
) -> str
Returns a fully-qualified execution string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.execution_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.get_operation
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.get_pipeline_job
get_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.GetPipelineJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.pipeline_job.PipelineJob
Gets a PipelineJob.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.get_training_pipeline
get_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.GetTrainingPipelineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.training_pipeline.TrainingPipeline
Gets a TrainingPipeline.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.pipeline_service.transports.base.PipelineServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.list_locations
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.list_operations
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.list_pipeline_jobs
list_pipeline_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.ListPipelineJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.pipeline_service.pagers.ListPipelineJobsAsyncPager
)
Lists PipelineJobs in a Location.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.list_training_pipelines
list_training_pipelines(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.ListTrainingPipelinesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.pipeline_service.pagers.ListTrainingPipelinesAsyncPager
)
Lists TrainingPipelines in a Location.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.model_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.network_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_artifact_path
parse_artifact_path(path: str) -> typing.Dict[str, str]
Parses a artifact path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_pipeline_job_path
parse_pipeline_job_path(path: str) -> typing.Dict[str, str]
Parses a pipeline_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.parse_training_pipeline_path
parse_training_pipeline_path(path: str) -> typing.Dict[str, str]
Parses a training_pipeline path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.pipeline_job_path
pipeline_job_path(project: str, location: str, pipeline_job: str) -> str
Returns a fully-qualified pipeline_job string.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.training_pipeline_path
training_pipeline_path(project: str, location: str, training_pipeline: str) -> str
Returns a fully-qualified training_pipeline string.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient
PipelineServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.pipeline_service.transports.base.PipelineServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the pipeline service client.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.exit
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.artifact_path
artifact_path(
project: str, location: str, metadata_store: str, artifact: str
) -> str
Returns a fully-qualified artifact string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.artifact_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.batch_cancel_pipeline_jobs
batch_cancel_pipeline_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.BatchCancelPipelineJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
names: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Batch cancel PipelineJobs.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.batch_delete_pipeline_jobs
batch_delete_pipeline_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.BatchDeletePipelineJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
names: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Batch deletes PipelineJobs The Operation is atomic.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.cancel_pipeline_job
cancel_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.CancelPipelineJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a PipelineJob.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.cancel_pipeline_job
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.cancel_training_pipeline
cancel_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.CancelTrainingPipelineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Cancels a TrainingPipeline.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.common_location_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.common_project_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.context_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.create_pipeline_job
create_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.CreatePipelineJobRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
pipeline_job: typing.Optional[
google.cloud.aiplatform_v1beta1.types.pipeline_job.PipelineJob
] = None,
pipeline_job_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.pipeline_job.PipelineJob
Creates a PipelineJob.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.create_pipeline_job
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.create_training_pipeline
create_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.CreateTrainingPipelineRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
training_pipeline: typing.Optional[
google.cloud.aiplatform_v1beta1.types.training_pipeline.TrainingPipeline
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.training_pipeline.TrainingPipeline
Creates a TrainingPipeline.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.custom_job_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.delete_pipeline_job
delete_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.DeletePipelineJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a PipelineJob.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.delete_pipeline_job
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.delete_training_pipeline
delete_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.DeleteTrainingPipelineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a TrainingPipeline.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.endpoint_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.execution_path
execution_path(
project: str, location: str, metadata_store: str, execution: str
) -> str
Returns a fully-qualified execution string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.execution_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.get_pipeline_job
get_pipeline_job(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.GetPipelineJobRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.pipeline_job.PipelineJob
Gets a PipelineJob.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.get_pipeline_job
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.get_training_pipeline
get_training_pipeline(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.GetTrainingPipelineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.training_pipeline.TrainingPipeline
Gets a TrainingPipeline.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.list_pipeline_jobs
list_pipeline_jobs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.ListPipelineJobsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.pipeline_service.pagers.ListPipelineJobsPager
)
Lists PipelineJobs in a Location.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.list_pipeline_jobs
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.list_training_pipelines
list_training_pipelines(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.pipeline_service.ListTrainingPipelinesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.pipeline_service.pagers.ListTrainingPipelinesPager
)
Lists TrainingPipelines in a Location.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.model_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.network_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_artifact_path
parse_artifact_path(path: str) -> typing.Dict[str, str]
Parses a artifact path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_artifact_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_context_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_endpoint_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_execution_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_model_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_network_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_pipeline_job_path
parse_pipeline_job_path(path: str) -> typing.Dict[str, str]
Parses a pipeline_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.parse_training_pipeline_path
parse_training_pipeline_path(path: str) -> typing.Dict[str, str]
Parses a training_pipeline path into its component segments.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.pipeline_job_path
pipeline_job_path(project: str, location: str, pipeline_job: str) -> str
Returns a fully-qualified pipeline_job string.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.pipeline_job_path
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.training_pipeline_path
training_pipeline_path(project: str, location: str, training_pipeline: str) -> str
Returns a fully-qualified training_pipeline string.
google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.PipelineServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.pipeline_service.pagers.ListPipelineJobsAsyncPager
ListPipelineJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.pipeline_service.ListPipelineJobsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.pipeline_service.ListPipelineJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.pipeline_service.ListPipelineJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.pagers.ListPipelineJobsAsyncPager
google.cloud.aiplatform_v1beta1.services.pipeline_service.pagers.ListPipelineJobsPager
ListPipelineJobsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.pipeline_service.ListPipelineJobsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.pipeline_service.ListPipelineJobsRequest,
response: google.cloud.aiplatform_v1beta1.types.pipeline_service.ListPipelineJobsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.pagers.ListPipelineJobsPager
google.cloud.aiplatform_v1beta1.services.pipeline_service.pagers.ListTrainingPipelinesAsyncPager
ListTrainingPipelinesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.pipeline_service.ListTrainingPipelinesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.pipeline_service.ListTrainingPipelinesRequest,
response: google.cloud.aiplatform_v1beta1.types.pipeline_service.ListTrainingPipelinesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.pagers.ListTrainingPipelinesAsyncPager
google.cloud.aiplatform_v1beta1.services.pipeline_service.pagers.ListTrainingPipelinesPager
ListTrainingPipelinesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.pipeline_service.ListTrainingPipelinesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.pipeline_service.ListTrainingPipelinesRequest,
response: google.cloud.aiplatform_v1beta1.types.pipeline_service.ListTrainingPipelinesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.pipeline_service.pagers.ListTrainingPipelinesPager
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient
PredictionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.prediction_service.transports.base.PredictionServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the prediction service async client.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.chat_completions
chat_completions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.ChatCompletionsRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
http_body: typing.Optional[google.api.httpbody_pb2.HttpBody] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[typing.AsyncIterable[google.api.httpbody_pb2.HttpBody]]
Exposes an OpenAI-compatible endpoint for chat completions.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.count_tokens
count_tokens(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.CountTokensRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.CountTokensResponse
Perform a token counting.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.direct_predict
direct_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.DirectPredictRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.DirectPredictResponse
Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.direct_raw_predict
direct_raw_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.DirectRawPredictRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.DirectRawPredictResponse
Perform an unary online prediction request to a gRPC model server for custom containers.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.explain
explain(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.ExplainRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
parameters: typing.Optional[google.protobuf.struct_pb2.Value] = None,
deployed_model_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.ExplainResponse
Perform an online explanation.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.explain
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.generate_content
generate_content(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.GenerateContentRequest,
dict,
]
] = None,
*,
model: typing.Optional[str] = None,
contents: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1beta1.types.content.Content]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.GenerateContentResponse
Generate content with multimodal inputs.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.prediction_service.transports.base.PredictionServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.model_path
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_rag_corpus_path
parse_rag_corpus_path(path: str) -> typing.Dict[str, str]
Parses a rag_corpus path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.predict
predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.PredictRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
parameters: typing.Optional[google.protobuf.struct_pb2.Value] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.PredictResponse
Perform an online prediction.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.predict
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.rag_corpus_path
rag_corpus_path(project: str, location: str, rag_corpus: str) -> str
Returns a fully-qualified rag_corpus string.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.raw_predict
raw_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.RawPredictRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
http_body: typing.Optional[google.api.httpbody_pb2.HttpBody] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api.httpbody_pb2.HttpBody
Perform an online prediction with an arbitrary HTTP payload.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.raw_predict
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.server_streaming_predict
server_streaming_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamingPredictRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamingPredictResponse
]
]
Perform a server-side streaming online prediction request for Vertex LLM streaming.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.stream_direct_predict
stream_direct_predict(
requests: typing.Optional[
typing.AsyncIterator[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamDirectPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamDirectPredictResponse
]
]
Perform a streaming online prediction request to a gRPC model server for Vertex first-party products and frameworks.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.stream_direct_raw_predict
stream_direct_raw_predict(
requests: typing.Optional[
typing.AsyncIterator[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamDirectRawPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamDirectRawPredictResponse
]
]
Perform a streaming online prediction request to a gRPC model server for custom containers.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.stream_generate_content
stream_generate_content(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.GenerateContentRequest,
dict,
]
] = None,
*,
model: typing.Optional[str] = None,
contents: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1beta1.types.content.Content]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1beta1.types.prediction_service.GenerateContentResponse
]
]
Generate content with multimodal inputs with streaming support.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.streaming_predict
streaming_predict(
requests: typing.Optional[
typing.AsyncIterator[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamingPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamingPredictResponse
]
]
Perform a streaming online prediction request for Vertex first-party products and frameworks.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.streaming_raw_predict
streaming_raw_predict(
requests: typing.Optional[
typing.AsyncIterator[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamingRawPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamingRawPredictResponse
]
]
Perform a streaming online prediction request through gRPC.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient
PredictionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.prediction_service.transports.base.PredictionServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the prediction service client.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.exit
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.chat_completions
chat_completions(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.ChatCompletionsRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
http_body: typing.Optional[google.api.httpbody_pb2.HttpBody] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[google.api.httpbody_pb2.HttpBody]
Exposes an OpenAI-compatible endpoint for chat completions.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.chat_completions
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.count_tokens
count_tokens(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.CountTokensRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.CountTokensResponse
Perform a token counting.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.count_tokens
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.direct_predict
direct_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.DirectPredictRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.DirectPredictResponse
Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.direct_predict
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.direct_raw_predict
direct_raw_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.DirectRawPredictRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.DirectRawPredictResponse
Perform an unary online prediction request to a gRPC model server for custom containers.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> str
Returns a fully-qualified endpoint string.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.endpoint_path
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.explain
explain(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.ExplainRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
parameters: typing.Optional[google.protobuf.struct_pb2.Value] = None,
deployed_model_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.ExplainResponse
Perform an online explanation.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.explain
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.generate_content
generate_content(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.GenerateContentRequest,
dict,
]
] = None,
*,
model: typing.Optional[str] = None,
contents: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1beta1.types.content.Content]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.GenerateContentResponse
Generate content with multimodal inputs.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.generate_content
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.model_path
model_path(project: str, location: str, model: str) -> str
Returns a fully-qualified model string.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.model_path
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]
Parses a endpoint path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.parse_model_path
parse_model_path(path: str) -> typing.Dict[str, str]
Parses a model path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.parse_model_path
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.parse_rag_corpus_path
parse_rag_corpus_path(path: str) -> typing.Dict[str, str]
Parses a rag_corpus path into its component segments.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.predict
predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.PredictRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
instances: typing.Optional[
typing.MutableSequence[google.protobuf.struct_pb2.Value]
] = None,
parameters: typing.Optional[google.protobuf.struct_pb2.Value] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.PredictResponse
Perform an online prediction.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.predict
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.rag_corpus_path
rag_corpus_path(project: str, location: str, rag_corpus: str) -> str
Returns a fully-qualified rag_corpus string.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.rag_corpus_path
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.raw_predict
raw_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.RawPredictRequest,
dict,
]
] = None,
*,
endpoint: typing.Optional[str] = None,
http_body: typing.Optional[google.api.httpbody_pb2.HttpBody] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api.httpbody_pb2.HttpBody
Perform an online prediction with an arbitrary HTTP payload.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.raw_predict
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.server_streaming_predict
server_streaming_predict(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamingPredictRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamingPredictResponse
]
Perform a server-side streaming online prediction request for Vertex LLM streaming.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.stream_direct_predict
stream_direct_predict(
requests: typing.Optional[
typing.Iterator[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamDirectPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamDirectPredictResponse
]
Perform a streaming online prediction request to a gRPC model server for Vertex first-party products and frameworks.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.stream_direct_raw_predict
stream_direct_raw_predict(
requests: typing.Optional[
typing.Iterator[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamDirectRawPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamDirectRawPredictResponse
]
Perform a streaming online prediction request to a gRPC model server for custom containers.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.stream_generate_content
stream_generate_content(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.prediction_service.GenerateContentRequest,
dict,
]
] = None,
*,
model: typing.Optional[str] = None,
contents: typing.Optional[
typing.MutableSequence[google.cloud.aiplatform_v1beta1.types.content.Content]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1beta1.types.prediction_service.GenerateContentResponse
]
Generate content with multimodal inputs with streaming support.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.streaming_predict
streaming_predict(
requests: typing.Optional[
typing.Iterator[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamingPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamingPredictResponse
]
Perform a streaming online prediction request for Vertex first-party products and frameworks.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.streaming_raw_predict
streaming_raw_predict(
requests: typing.Optional[
typing.Iterator[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamingRawPredictRequest
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1beta1.types.prediction_service.StreamingRawPredictResponse
]
Perform a streaming online prediction request through gRPC.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.prediction_service.PredictionServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient
ReasoningEngineExecutionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.transports.base.ReasoningEngineExecutionServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the reasoning engine execution service async client.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.transports.base.ReasoningEngineExecutionServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.parse_reasoning_engine_path
parse_reasoning_engine_path(path: str) -> typing.Dict[str, str]
Parses a reasoning_engine path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.query_reasoning_engine
query_reasoning_engine(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.reasoning_engine_execution_service.QueryReasoningEngineRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.reasoning_engine_execution_service.QueryReasoningEngineResponse
)
Queries using a reasoning engine.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.reasoning_engine_path
reasoning_engine_path(project: str, location: str, reasoning_engine: str) -> str
Returns a fully-qualified reasoning_engine string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient
ReasoningEngineExecutionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.transports.base.ReasoningEngineExecutionServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the reasoning engine execution service client.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.parse_reasoning_engine_path
parse_reasoning_engine_path(path: str) -> typing.Dict[str, str]
Parses a reasoning_engine path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.query_reasoning_engine
query_reasoning_engine(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.reasoning_engine_execution_service.QueryReasoningEngineRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.reasoning_engine_execution_service.QueryReasoningEngineResponse
)
Queries using a reasoning engine.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.reasoning_engine_path
reasoning_engine_path(project: str, location: str, reasoning_engine: str) -> str
Returns a fully-qualified reasoning_engine string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_execution_service.ReasoningEngineExecutionServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient
ReasoningEngineServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.transports.base.ReasoningEngineServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the reasoning engine service async client.
See more: google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.create_reasoning_engine
create_reasoning_engine(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.CreateReasoningEngineRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
reasoning_engine: typing.Optional[
google.cloud.aiplatform_v1beta1.types.reasoning_engine.ReasoningEngine
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a reasoning engine.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.delete_reasoning_engine
delete_reasoning_engine(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.DeleteReasoningEngineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a reasoning engine.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.get_reasoning_engine
get_reasoning_engine(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.GetReasoningEngineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.reasoning_engine.ReasoningEngine
Gets a reasoning engine.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.transports.base.ReasoningEngineServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.list_reasoning_engines
list_reasoning_engines(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.ListReasoningEnginesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.pagers.ListReasoningEnginesAsyncPager
)
Lists reasoning engines in a location.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.parse_reasoning_engine_path
parse_reasoning_engine_path(path: str) -> typing.Dict[str, str]
Parses a reasoning_engine path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.reasoning_engine_path
reasoning_engine_path(project: str, location: str, reasoning_engine: str) -> str
Returns a fully-qualified reasoning_engine string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient
ReasoningEngineServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.transports.base.ReasoningEngineServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the reasoning engine service client.
See more: google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.exit
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.create_reasoning_engine
create_reasoning_engine(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.CreateReasoningEngineRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
reasoning_engine: typing.Optional[
google.cloud.aiplatform_v1beta1.types.reasoning_engine.ReasoningEngine
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a reasoning engine.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.delete_reasoning_engine
delete_reasoning_engine(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.DeleteReasoningEngineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a reasoning engine.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.get_reasoning_engine
get_reasoning_engine(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.GetReasoningEngineRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.reasoning_engine.ReasoningEngine
Gets a reasoning engine.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.list_reasoning_engines
list_reasoning_engines(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.ListReasoningEnginesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.pagers.ListReasoningEnginesPager
)
Lists reasoning engines in a location.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.parse_reasoning_engine_path
parse_reasoning_engine_path(path: str) -> typing.Dict[str, str]
Parses a reasoning_engine path into its component segments.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.reasoning_engine_path
reasoning_engine_path(project: str, location: str, reasoning_engine: str) -> str
Returns a fully-qualified reasoning_engine string.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.ReasoningEngineServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.pagers.ListReasoningEnginesAsyncPager
ListReasoningEnginesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.ListReasoningEnginesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.ListReasoningEnginesRequest,
response: google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.ListReasoningEnginesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.pagers.ListReasoningEnginesPager
ListReasoningEnginesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.ListReasoningEnginesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.ListReasoningEnginesRequest,
response: google.cloud.aiplatform_v1beta1.types.reasoning_engine_service.ListReasoningEnginesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.reasoning_engine_service.pagers.ListReasoningEnginesPager
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient
ScheduleServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.schedule_service.transports.base.ScheduleServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the schedule service async client.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.artifact_path
artifact_path(
project: str, location: str, metadata_store: str, artifact: str
) -> str
Returns a fully-qualified artifact string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.artifact_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.context_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.create_schedule
create_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.CreateScheduleRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
schedule: typing.Optional[
google.cloud.aiplatform_v1beta1.types.schedule.Schedule
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.schedule.Schedule
Creates a Schedule.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.create_schedule
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.custom_job_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.delete_schedule
delete_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.DeleteScheduleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a Schedule.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.delete_schedule
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.execution_path
execution_path(
project: str, location: str, metadata_store: str, execution: str
) -> str
Returns a fully-qualified execution string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.execution_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.get_operation
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.get_schedule
get_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.GetScheduleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.schedule.Schedule
Gets a Schedule.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.get_schedule
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.schedule_service.transports.base.ScheduleServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.list_locations
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.list_operations
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.list_schedules
list_schedules(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.ListSchedulesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.schedule_service.pagers.ListSchedulesAsyncPager
)
Lists Schedules in a Location.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.list_schedules
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.network_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.parse_artifact_path
parse_artifact_path(path: str) -> typing.Dict[str, str]
Parses a artifact path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.parse_pipeline_job_path
parse_pipeline_job_path(path: str) -> typing.Dict[str, str]
Parses a pipeline_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.parse_schedule_path
parse_schedule_path(path: str) -> typing.Dict[str, str]
Parses a schedule path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.pause_schedule
pause_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.PauseScheduleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Pauses a Schedule.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.pause_schedule
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.pipeline_job_path
pipeline_job_path(project: str, location: str, pipeline_job: str) -> str
Returns a fully-qualified pipeline_job string.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.resume_schedule
resume_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.ResumeScheduleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
catch_up: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Resumes a paused Schedule to start scheduling new runs.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.resume_schedule
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.schedule_path
schedule_path(project: str, location: str, schedule: str) -> str
Returns a fully-qualified schedule string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.schedule_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.update_schedule
update_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.UpdateScheduleRequest,
dict,
]
] = None,
*,
schedule: typing.Optional[
google.cloud.aiplatform_v1beta1.types.schedule.Schedule
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.schedule.Schedule
Updates an active or paused Schedule.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.update_schedule
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient
ScheduleServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.schedule_service.transports.base.ScheduleServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the schedule service client.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.exit
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.artifact_path
artifact_path(
project: str, location: str, metadata_store: str, artifact: str
) -> str
Returns a fully-qualified artifact string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.artifact_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.common_location_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.common_project_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.context_path
context_path(project: str, location: str, metadata_store: str, context: str) -> str
Returns a fully-qualified context string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.context_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.create_schedule
create_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.CreateScheduleRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
schedule: typing.Optional[
google.cloud.aiplatform_v1beta1.types.schedule.Schedule
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.schedule.Schedule
Creates a Schedule.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.create_schedule
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.custom_job_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.delete_schedule
delete_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.DeleteScheduleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a Schedule.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.delete_schedule
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.execution_path
execution_path(
project: str, location: str, metadata_store: str, execution: str
) -> str
Returns a fully-qualified execution string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.execution_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.get_schedule
get_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.GetScheduleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.schedule.Schedule
Gets a Schedule.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.get_schedule
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.list_schedules
list_schedules(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.ListSchedulesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.schedule_service.pagers.ListSchedulesPager
)
Lists Schedules in a Location.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.list_schedules
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.network_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_artifact_path
parse_artifact_path(path: str) -> typing.Dict[str, str]
Parses a artifact path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_artifact_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_context_path
parse_context_path(path: str) -> typing.Dict[str, str]
Parses a context path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_context_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_execution_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_network_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_pipeline_job_path
parse_pipeline_job_path(path: str) -> typing.Dict[str, str]
Parses a pipeline_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_schedule_path
parse_schedule_path(path: str) -> typing.Dict[str, str]
Parses a schedule path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.parse_schedule_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.pause_schedule
pause_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.PauseScheduleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Pauses a Schedule.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.pause_schedule
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.pipeline_job_path
pipeline_job_path(project: str, location: str, pipeline_job: str) -> str
Returns a fully-qualified pipeline_job string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.pipeline_job_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.resume_schedule
resume_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.ResumeScheduleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
catch_up: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Resumes a paused Schedule to start scheduling new runs.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.resume_schedule
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.schedule_path
schedule_path(project: str, location: str, schedule: str) -> str
Returns a fully-qualified schedule string.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.schedule_path
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.update_schedule
update_schedule(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.schedule_service.UpdateScheduleRequest,
dict,
]
] = None,
*,
schedule: typing.Optional[
google.cloud.aiplatform_v1beta1.types.schedule.Schedule
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.schedule.Schedule
Updates an active or paused Schedule.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.update_schedule
google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.ScheduleServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.schedule_service.pagers.ListSchedulesAsyncPager
ListSchedulesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.schedule_service.ListSchedulesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.schedule_service.ListSchedulesRequest,
response: google.cloud.aiplatform_v1beta1.types.schedule_service.ListSchedulesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.pagers.ListSchedulesAsyncPager
google.cloud.aiplatform_v1beta1.services.schedule_service.pagers.ListSchedulesPager
ListSchedulesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.schedule_service.ListSchedulesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.schedule_service.ListSchedulesRequest,
response: google.cloud.aiplatform_v1beta1.types.schedule_service.ListSchedulesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.schedule_service.pagers.ListSchedulesPager
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient
SpecialistPoolServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.specialist_pool_service.transports.base.SpecialistPoolServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the specialist pool service async client.
See more: google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.create_specialist_pool
create_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.specialist_pool_service.CreateSpecialistPoolRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
specialist_pool: typing.Optional[
google.cloud.aiplatform_v1beta1.types.specialist_pool.SpecialistPool
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a SpecialistPool.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.delete_specialist_pool
delete_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.specialist_pool_service.DeleteSpecialistPoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a SpecialistPool as well as all Specialists in the pool.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.get_specialist_pool
get_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.specialist_pool_service.GetSpecialistPoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.specialist_pool.SpecialistPool
Gets a SpecialistPool.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.transports.base.SpecialistPoolServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.list_specialist_pools
list_specialist_pools(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.specialist_pool_service.ListSpecialistPoolsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.pagers.ListSpecialistPoolsAsyncPager
)
Lists SpecialistPools in a Location.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.parse_specialist_pool_path
parse_specialist_pool_path(path: str) -> typing.Dict[str, str]
Parses a specialist_pool path into its component segments.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.specialist_pool_path
specialist_pool_path(project: str, location: str, specialist_pool: str) -> str
Returns a fully-qualified specialist_pool string.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.update_specialist_pool
update_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.specialist_pool_service.UpdateSpecialistPoolRequest,
dict,
]
] = None,
*,
specialist_pool: typing.Optional[
google.cloud.aiplatform_v1beta1.types.specialist_pool.SpecialistPool
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a SpecialistPool.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient
SpecialistPoolServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.specialist_pool_service.transports.base.SpecialistPoolServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the specialist pool service client.
See more: google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.exit
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.create_specialist_pool
create_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.specialist_pool_service.CreateSpecialistPoolRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
specialist_pool: typing.Optional[
google.cloud.aiplatform_v1beta1.types.specialist_pool.SpecialistPool
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a SpecialistPool.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.delete_specialist_pool
delete_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.specialist_pool_service.DeleteSpecialistPoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a SpecialistPool as well as all Specialists in the pool.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.get_specialist_pool
get_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.specialist_pool_service.GetSpecialistPoolRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.specialist_pool.SpecialistPool
Gets a SpecialistPool.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.list_specialist_pools
list_specialist_pools(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.specialist_pool_service.ListSpecialistPoolsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.pagers.ListSpecialistPoolsPager
)
Lists SpecialistPools in a Location.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.parse_specialist_pool_path
parse_specialist_pool_path(path: str) -> typing.Dict[str, str]
Parses a specialist_pool path into its component segments.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.specialist_pool_path
specialist_pool_path(project: str, location: str, specialist_pool: str) -> str
Returns a fully-qualified specialist_pool string.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.update_specialist_pool
update_specialist_pool(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.specialist_pool_service.UpdateSpecialistPoolRequest,
dict,
]
] = None,
*,
specialist_pool: typing.Optional[
google.cloud.aiplatform_v1beta1.types.specialist_pool.SpecialistPool
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates a SpecialistPool.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.SpecialistPoolServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.pagers.ListSpecialistPoolsAsyncPager
ListSpecialistPoolsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.specialist_pool_service.ListSpecialistPoolsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.specialist_pool_service.ListSpecialistPoolsRequest,
response: google.cloud.aiplatform_v1beta1.types.specialist_pool_service.ListSpecialistPoolsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.specialist_pool_service.pagers.ListSpecialistPoolsPager
ListSpecialistPoolsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.specialist_pool_service.ListSpecialistPoolsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.specialist_pool_service.ListSpecialistPoolsRequest,
response: google.cloud.aiplatform_v1beta1.types.specialist_pool_service.ListSpecialistPoolsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.specialist_pool_service.pagers.ListSpecialistPoolsPager
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient
TensorboardServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.tensorboard_service.transports.base.TensorboardServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the tensorboard service async client.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.batch_create_tensorboard_runs
batch_create_tensorboard_runs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.BatchCreateTensorboardRunsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardRunRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.BatchCreateTensorboardRunsResponse
)
Batch create TensorboardRuns.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.batch_create_tensorboard_time_series
batch_create_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.BatchCreateTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardTimeSeriesRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.BatchCreateTensorboardTimeSeriesResponse
)
Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.batch_read_tensorboard_time_series_data
batch_read_tensorboard_time_series_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.BatchReadTensorboardTimeSeriesDataRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.BatchReadTensorboardTimeSeriesDataResponse
)
Reads multiple TensorboardTimeSeries' data.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.create_tensorboard
create_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard.Tensorboard
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a Tensorboard.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.create_tensorboard_experiment
create_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardExperimentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard_experiment: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard_experiment.TensorboardExperiment
] = None,
tensorboard_experiment_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard_experiment.TensorboardExperiment
Creates a TensorboardExperiment.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.create_tensorboard_run
create_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardRunRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard_run: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard_run.TensorboardRun
] = None,
tensorboard_run_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard_run.TensorboardRun
Creates a TensorboardRun.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.create_tensorboard_time_series
create_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard_time_series: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard_time_series.TensorboardTimeSeries
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_time_series.TensorboardTimeSeries
)
Creates a TensorboardTimeSeries.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.delete_tensorboard
delete_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.DeleteTensorboardRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a Tensorboard.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.delete_tensorboard_experiment
delete_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.DeleteTensorboardExperimentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a TensorboardExperiment.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.delete_tensorboard_run
delete_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.DeleteTensorboardRunRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a TensorboardRun.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.delete_tensorboard_time_series
delete_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.DeleteTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a TensorboardTimeSeries.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.export_tensorboard_time_series_data
export_tensorboard_time_series_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ExportTensorboardTimeSeriesDataRequest,
dict,
]
] = None,
*,
tensorboard_time_series: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ExportTensorboardTimeSeriesDataAsyncPager
)
Exports a TensorboardTimeSeries' data.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.get_tensorboard
get_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.GetTensorboardRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard.Tensorboard
Gets a Tensorboard.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.get_tensorboard_experiment
get_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.GetTensorboardExperimentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard_experiment.TensorboardExperiment
Gets a TensorboardExperiment.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.get_tensorboard_run
get_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.GetTensorboardRunRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard_run.TensorboardRun
Gets a TensorboardRun.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.get_tensorboard_time_series
get_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.GetTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_time_series.TensorboardTimeSeries
)
Gets a TensorboardTimeSeries.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.tensorboard_service.transports.base.TensorboardServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.list_tensorboard_experiments
list_tensorboard_experiments(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardExperimentsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardExperimentsAsyncPager
)
Lists TensorboardExperiments in a Location.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.list_tensorboard_runs
list_tensorboard_runs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardRunsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardRunsAsyncPager
)
Lists TensorboardRuns in a Location.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.list_tensorboard_time_series
list_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardTimeSeriesAsyncPager
)
Lists TensorboardTimeSeries in a Location.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.list_tensorboards
list_tensorboards(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardsAsyncPager
)
Lists Tensorboards in a Location.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_tensorboard_experiment_path
parse_tensorboard_experiment_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard_experiment path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_tensorboard_path
parse_tensorboard_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_tensorboard_run_path
parse_tensorboard_run_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard_run path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.parse_tensorboard_time_series_path
parse_tensorboard_time_series_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard_time_series path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.read_tensorboard_blob_data
read_tensorboard_blob_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardBlobDataRequest,
dict,
]
] = None,
*,
time_series: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardBlobDataResponse
]
]
Gets bytes of TensorboardBlobs.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.read_tensorboard_size
read_tensorboard_size(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardSizeRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardSizeResponse
)
Returns the storage size for a given TensorBoard instance.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.read_tensorboard_time_series_data
read_tensorboard_time_series_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardTimeSeriesDataRequest,
dict,
]
] = None,
*,
tensorboard_time_series: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardTimeSeriesDataResponse
)
Reads a TensorboardTimeSeries' data.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.read_tensorboard_usage
read_tensorboard_usage(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardUsageRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardUsageResponse
)
Returns a list of monthly active users for a given TensorBoard instance.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.tensorboard_experiment_path
tensorboard_experiment_path(
project: str, location: str, tensorboard: str, experiment: str
) -> str
Returns a fully-qualified tensorboard_experiment string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.tensorboard_path
tensorboard_path(project: str, location: str, tensorboard: str) -> str
Returns a fully-qualified tensorboard string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.tensorboard_run_path
tensorboard_run_path(
project: str, location: str, tensorboard: str, experiment: str, run: str
) -> str
Returns a fully-qualified tensorboard_run string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.tensorboard_time_series_path
tensorboard_time_series_path(
project: str,
location: str,
tensorboard: str,
experiment: str,
run: str,
time_series: str,
) -> str
Returns a fully-qualified tensorboard_time_series string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.update_tensorboard
update_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.UpdateTensorboardRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard.Tensorboard
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a Tensorboard.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.update_tensorboard_experiment
update_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.UpdateTensorboardExperimentRequest,
dict,
]
] = None,
*,
tensorboard_experiment: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard_experiment.TensorboardExperiment
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard_experiment.TensorboardExperiment
Updates a TensorboardExperiment.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.update_tensorboard_run
update_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.UpdateTensorboardRunRequest,
dict,
]
] = None,
*,
tensorboard_run: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard_run.TensorboardRun
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard_run.TensorboardRun
Updates a TensorboardRun.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.update_tensorboard_time_series
update_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.UpdateTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
tensorboard_time_series: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard_time_series.TensorboardTimeSeries
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_time_series.TensorboardTimeSeries
)
Updates a TensorboardTimeSeries.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.write_tensorboard_experiment_data
write_tensorboard_experiment_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.WriteTensorboardExperimentDataRequest,
dict,
]
] = None,
*,
tensorboard_experiment: typing.Optional[str] = None,
write_run_data_requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.WriteTensorboardRunDataRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.WriteTensorboardExperimentDataResponse
)
Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceAsyncClient.write_tensorboard_run_data
write_tensorboard_run_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.WriteTensorboardRunDataRequest,
dict,
]
] = None,
*,
tensorboard_run: typing.Optional[str] = None,
time_series_data: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.tensorboard_data.TimeSeriesData
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.WriteTensorboardRunDataResponse
)
Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient
TensorboardServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.tensorboard_service.transports.base.TensorboardServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the tensorboard service client.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.exit
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.batch_create_tensorboard_runs
batch_create_tensorboard_runs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.BatchCreateTensorboardRunsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardRunRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.BatchCreateTensorboardRunsResponse
)
Batch create TensorboardRuns.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.batch_create_tensorboard_time_series
batch_create_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.BatchCreateTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardTimeSeriesRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.BatchCreateTensorboardTimeSeriesResponse
)
Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.batch_read_tensorboard_time_series_data
batch_read_tensorboard_time_series_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.BatchReadTensorboardTimeSeriesDataRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.BatchReadTensorboardTimeSeriesDataResponse
)
Reads multiple TensorboardTimeSeries' data.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.create_tensorboard
create_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard.Tensorboard
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a Tensorboard.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.create_tensorboard_experiment
create_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardExperimentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard_experiment: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard_experiment.TensorboardExperiment
] = None,
tensorboard_experiment_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard_experiment.TensorboardExperiment
Creates a TensorboardExperiment.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.create_tensorboard_run
create_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardRunRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard_run: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard_run.TensorboardRun
] = None,
tensorboard_run_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard_run.TensorboardRun
Creates a TensorboardRun.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.create_tensorboard_time_series
create_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tensorboard_time_series: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard_time_series.TensorboardTimeSeries
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_time_series.TensorboardTimeSeries
)
Creates a TensorboardTimeSeries.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.delete_tensorboard
delete_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.DeleteTensorboardRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a Tensorboard.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.delete_tensorboard_experiment
delete_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.DeleteTensorboardExperimentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a TensorboardExperiment.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.delete_tensorboard_run
delete_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.DeleteTensorboardRunRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a TensorboardRun.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.delete_tensorboard_time_series
delete_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.DeleteTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a TensorboardTimeSeries.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.export_tensorboard_time_series_data
export_tensorboard_time_series_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ExportTensorboardTimeSeriesDataRequest,
dict,
]
] = None,
*,
tensorboard_time_series: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ExportTensorboardTimeSeriesDataPager
)
Exports a TensorboardTimeSeries' data.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.get_tensorboard
get_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.GetTensorboardRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard.Tensorboard
Gets a Tensorboard.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.get_tensorboard_experiment
get_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.GetTensorboardExperimentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard_experiment.TensorboardExperiment
Gets a TensorboardExperiment.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.get_tensorboard_run
get_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.GetTensorboardRunRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard_run.TensorboardRun
Gets a TensorboardRun.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.get_tensorboard_time_series
get_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.GetTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_time_series.TensorboardTimeSeries
)
Gets a TensorboardTimeSeries.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.list_tensorboard_experiments
list_tensorboard_experiments(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardExperimentsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardExperimentsPager
)
Lists TensorboardExperiments in a Location.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.list_tensorboard_runs
list_tensorboard_runs(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardRunsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardRunsPager
)
Lists TensorboardRuns in a Location.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.list_tensorboard_time_series
list_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardTimeSeriesPager
)
Lists TensorboardTimeSeries in a Location.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.list_tensorboards
list_tensorboards(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardsPager
)
Lists Tensorboards in a Location.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.parse_tensorboard_experiment_path
parse_tensorboard_experiment_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard_experiment path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.parse_tensorboard_path
parse_tensorboard_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.parse_tensorboard_run_path
parse_tensorboard_run_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard_run path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.parse_tensorboard_time_series_path
parse_tensorboard_time_series_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard_time_series path into its component segments.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.read_tensorboard_blob_data
read_tensorboard_blob_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardBlobDataRequest,
dict,
]
] = None,
*,
time_series: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardBlobDataResponse
]
Gets bytes of TensorboardBlobs.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.read_tensorboard_size
read_tensorboard_size(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardSizeRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardSizeResponse
)
Returns the storage size for a given TensorBoard instance.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.read_tensorboard_time_series_data
read_tensorboard_time_series_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardTimeSeriesDataRequest,
dict,
]
] = None,
*,
tensorboard_time_series: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardTimeSeriesDataResponse
)
Reads a TensorboardTimeSeries' data.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.read_tensorboard_usage
read_tensorboard_usage(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardUsageRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardUsageResponse
)
Returns a list of monthly active users for a given TensorBoard instance.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.tensorboard_experiment_path
tensorboard_experiment_path(
project: str, location: str, tensorboard: str, experiment: str
) -> str
Returns a fully-qualified tensorboard_experiment string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.tensorboard_path
tensorboard_path(project: str, location: str, tensorboard: str) -> str
Returns a fully-qualified tensorboard string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.tensorboard_run_path
tensorboard_run_path(
project: str, location: str, tensorboard: str, experiment: str, run: str
) -> str
Returns a fully-qualified tensorboard_run string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.tensorboard_time_series_path
tensorboard_time_series_path(
project: str,
location: str,
tensorboard: str,
experiment: str,
run: str,
time_series: str,
) -> str
Returns a fully-qualified tensorboard_time_series string.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.update_tensorboard
update_tensorboard(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.UpdateTensorboardRequest,
dict,
]
] = None,
*,
tensorboard: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard.Tensorboard
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates a Tensorboard.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.update_tensorboard_experiment
update_tensorboard_experiment(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.UpdateTensorboardExperimentRequest,
dict,
]
] = None,
*,
tensorboard_experiment: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard_experiment.TensorboardExperiment
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard_experiment.TensorboardExperiment
Updates a TensorboardExperiment.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.update_tensorboard_run
update_tensorboard_run(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.UpdateTensorboardRunRequest,
dict,
]
] = None,
*,
tensorboard_run: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard_run.TensorboardRun
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.tensorboard_run.TensorboardRun
Updates a TensorboardRun.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.update_tensorboard_time_series
update_tensorboard_time_series(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.UpdateTensorboardTimeSeriesRequest,
dict,
]
] = None,
*,
tensorboard_time_series: typing.Optional[
google.cloud.aiplatform_v1beta1.types.tensorboard_time_series.TensorboardTimeSeries
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_time_series.TensorboardTimeSeries
)
Updates a TensorboardTimeSeries.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.write_tensorboard_experiment_data
write_tensorboard_experiment_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.WriteTensorboardExperimentDataRequest,
dict,
]
] = None,
*,
tensorboard_experiment: typing.Optional[str] = None,
write_run_data_requests: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.WriteTensorboardRunDataRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.WriteTensorboardExperimentDataResponse
)
Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.TensorboardServiceClient.write_tensorboard_run_data
write_tensorboard_run_data(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.WriteTensorboardRunDataRequest,
dict,
]
] = None,
*,
tensorboard_run: typing.Optional[str] = None,
time_series_data: typing.Optional[
typing.MutableSequence[
google.cloud.aiplatform_v1beta1.types.tensorboard_data.TimeSeriesData
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.tensorboard_service.WriteTensorboardRunDataResponse
)
Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ExportTensorboardTimeSeriesDataAsyncPager
ExportTensorboardTimeSeriesDataAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ExportTensorboardTimeSeriesDataResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ExportTensorboardTimeSeriesDataRequest,
response: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ExportTensorboardTimeSeriesDataResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ExportTensorboardTimeSeriesDataPager
ExportTensorboardTimeSeriesDataPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ExportTensorboardTimeSeriesDataResponse,
],
request: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ExportTensorboardTimeSeriesDataRequest,
response: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ExportTensorboardTimeSeriesDataResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardExperimentsAsyncPager
ListTensorboardExperimentsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardExperimentsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardExperimentsRequest,
response: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardExperimentsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardExperimentsPager
ListTensorboardExperimentsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardExperimentsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardExperimentsRequest,
response: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardExperimentsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardExperimentsPager
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardRunsAsyncPager
ListTensorboardRunsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardRunsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardRunsRequest,
response: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardRunsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardRunsAsyncPager
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardRunsPager
ListTensorboardRunsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardRunsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardRunsRequest,
response: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardRunsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardRunsPager
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardTimeSeriesAsyncPager
ListTensorboardTimeSeriesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardTimeSeriesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardTimeSeriesRequest,
response: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardTimeSeriesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardTimeSeriesPager
ListTensorboardTimeSeriesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardTimeSeriesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardTimeSeriesRequest,
response: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardTimeSeriesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardTimeSeriesPager
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardsAsyncPager
ListTensorboardsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardsRequest,
response: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardsAsyncPager
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardsPager
ListTensorboardsPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardsResponse,
],
request: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardsRequest,
response: google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardsPager
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient
VertexRagDataServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.transports.base.VertexRagDataServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the vertex rag data service async client.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.create_rag_corpus
create_rag_corpus(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.CreateRagCorpusRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
rag_corpus: typing.Optional[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data.RagCorpus
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a RagCorpus.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.delete_rag_corpus
delete_rag_corpus(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.DeleteRagCorpusRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a RagCorpus.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.delete_rag_file
delete_rag_file(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.DeleteRagFileRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a RagFile.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.get_rag_corpus
get_rag_corpus(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.GetRagCorpusRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.vertex_rag_data.RagCorpus
Gets a RagCorpus.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.get_rag_file
get_rag_file(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.GetRagFileRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.vertex_rag_data.RagFile
Gets a RagFile.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.transports.base.VertexRagDataServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.import_rag_files
import_rag_files(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ImportRagFilesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
import_rag_files_config: typing.Optional[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data.ImportRagFilesConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Import files from Google Cloud Storage or Google Drive into a RagCorpus.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.list_rag_corpora
list_rag_corpora(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagCorporaRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.pagers.ListRagCorporaAsyncPager
)
Lists RagCorpora in a Location.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.list_rag_files
list_rag_files(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.pagers.ListRagFilesAsyncPager
)
Lists RagFiles in a RagCorpus.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.parse_rag_corpus_path
parse_rag_corpus_path(path: str) -> typing.Dict[str, str]
Parses a rag_corpus path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.parse_rag_file_path
parse_rag_file_path(path: str) -> typing.Dict[str, str]
Parses a rag_file path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.rag_corpus_path
rag_corpus_path(project: str, location: str, rag_corpus: str) -> str
Returns a fully-qualified rag_corpus string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.rag_file_path
rag_file_path(project: str, location: str, rag_corpus: str, rag_file: str) -> str
Returns a fully-qualified rag_file string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.upload_rag_file
upload_rag_file(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.UploadRagFileRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
rag_file: typing.Optional[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data.RagFile
] = None,
upload_rag_file_config: typing.Optional[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data.UploadRagFileConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.UploadRagFileResponse
)
Upload a file into a RagCorpus.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient
VertexRagDataServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.transports.base.VertexRagDataServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the vertex rag data service client.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.exit
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.create_rag_corpus
create_rag_corpus(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.CreateRagCorpusRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
rag_corpus: typing.Optional[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data.RagCorpus
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a RagCorpus.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.delete_rag_corpus
delete_rag_corpus(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.DeleteRagCorpusRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a RagCorpus.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.delete_rag_file
delete_rag_file(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.DeleteRagFileRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a RagFile.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.get_rag_corpus
get_rag_corpus(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.GetRagCorpusRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.vertex_rag_data.RagCorpus
Gets a RagCorpus.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.get_rag_file
get_rag_file(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.GetRagFileRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.vertex_rag_data.RagFile
Gets a RagFile.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.import_rag_files
import_rag_files(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ImportRagFilesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
import_rag_files_config: typing.Optional[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data.ImportRagFilesConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Import files from Google Cloud Storage or Google Drive into a RagCorpus.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.list_rag_corpora
list_rag_corpora(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagCorporaRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.pagers.ListRagCorporaPager
)
Lists RagCorpora in a Location.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.list_rag_files
list_rag_files(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.pagers.ListRagFilesPager
)
Lists RagFiles in a RagCorpus.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.parse_rag_corpus_path
parse_rag_corpus_path(path: str) -> typing.Dict[str, str]
Parses a rag_corpus path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.parse_rag_file_path
parse_rag_file_path(path: str) -> typing.Dict[str, str]
Parses a rag_file path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.rag_corpus_path
rag_corpus_path(project: str, location: str, rag_corpus: str) -> str
Returns a fully-qualified rag_corpus string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.rag_file_path
rag_file_path(project: str, location: str, rag_corpus: str, rag_file: str) -> str
Returns a fully-qualified rag_file string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.upload_rag_file
upload_rag_file(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.UploadRagFileRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
rag_file: typing.Optional[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data.RagFile
] = None,
upload_rag_file_config: typing.Optional[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data.UploadRagFileConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.UploadRagFileResponse
)
Upload a file into a RagCorpus.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.VertexRagDataServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.pagers.ListRagCorporaAsyncPager
ListRagCorporaAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagCorporaResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagCorporaRequest,
response: google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagCorporaResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.pagers.ListRagCorporaAsyncPager
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.pagers.ListRagCorporaPager
ListRagCorporaPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagCorporaResponse,
],
request: google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagCorporaRequest,
response: google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagCorporaResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.pagers.ListRagCorporaPager
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.pagers.ListRagFilesAsyncPager
ListRagFilesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesRequest,
response: google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.pagers.ListRagFilesAsyncPager
google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.pagers.ListRagFilesPager
ListRagFilesPager(
method: typing.Callable[
[...],
google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesResponse,
],
request: google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesRequest,
response: google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_data_service.pagers.ListRagFilesPager
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient
VertexRagServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.vertex_rag_service.transports.base.VertexRagServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the vertex rag service async client.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.transports.base.VertexRagServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.retrieve_contexts
retrieve_contexts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_service.RetrieveContextsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
query: typing.Optional[
google.cloud.aiplatform_v1beta1.types.vertex_rag_service.RagQuery
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.vertex_rag_service.RetrieveContextsResponse
Retrieves relevant contexts for a query.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient
VertexRagServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.vertex_rag_service.transports.base.VertexRagServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the vertex rag service client.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.exit
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.retrieve_contexts
retrieve_contexts(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vertex_rag_service.RetrieveContextsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
query: typing.Optional[
google.cloud.aiplatform_v1beta1.types.vertex_rag_service.RagQuery
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.vertex_rag_service.RetrieveContextsResponse
Retrieves relevant contexts for a query.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.retrieve_contexts
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.vertex_rag_service.VertexRagServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient
VizierServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.aiplatform_v1beta1.services.vizier_service.transports.base.VizierServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the vizier service async client.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.add_trial_measurement
add_trial_measurement(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.AddTrialMeasurementRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Trial
Adds a measurement of the objective metrics to a Trial.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.check_trial_early_stopping_state
check_trial_early_stopping_state(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.CheckTrialEarlyStoppingStateRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Checks whether a Trial should stop or not.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.common_project_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.complete_trial
complete_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.CompleteTrialRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Trial
Marks a Trial as complete.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.complete_trial
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.create_study
create_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.CreateStudyRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
study: typing.Optional[google.cloud.aiplatform_v1beta1.types.study.Study] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Study
Creates a Study.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.create_study
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.create_trial
create_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.CreateTrialRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
trial: typing.Optional[google.cloud.aiplatform_v1beta1.types.study.Trial] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Trial
Adds a user provided Trial to a Study.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.create_trial
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.custom_job_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.delete_operation
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.delete_study
delete_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.DeleteStudyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a Study.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.delete_study
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.delete_trial
delete_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.DeleteTrialRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a Trial.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.delete_trial
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_location
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_operation
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_study
get_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.GetStudyRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Study
Gets a Study by name.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_study
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.aiplatform_v1beta1.services.vizier_service.transports.base.VizierServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_transport_class
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_trial
get_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.GetTrialRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Trial
Gets a Trial.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.get_trial
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.list_locations
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.list_operations
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.list_optimal_trials
list_optimal_trials(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.ListOptimalTrialsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.vizier_service.ListOptimalTrialsResponse
Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.list_optimal_trials
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.list_studies
list_studies(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.ListStudiesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListStudiesAsyncPager
)
Lists all the studies in a region for an associated project.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.list_studies
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.list_trials
list_trials(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.ListTrialsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListTrialsAsyncPager
)
Lists the Trials associated with a Study.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.list_trials
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.lookup_study
lookup_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.LookupStudyRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Study
Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.lookup_study
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.parse_study_path
parse_study_path(path: str) -> typing.Dict[str, str]
Parses a study path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.parse_study_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.parse_trial_path
parse_trial_path(path: str) -> typing.Dict[str, str]
Parses a trial path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.parse_trial_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.stop_trial
stop_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.StopTrialRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Trial
Stops a Trial.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.stop_trial
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.study_path
study_path(project: str, location: str, study: str) -> str
Returns a fully-qualified study string.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.study_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.suggest_trials
suggest_trials(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.SuggestTrialsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.suggest_trials
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.trial_path
trial_path(project: str, location: str, study: str, trial: str) -> str
Returns a fully-qualified trial string.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.trial_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceAsyncClient.wait_operation
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient
VizierServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.aiplatform_v1beta1.services.vizier_service.transports.base.VizierServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the vizier service client.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.exit
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.add_trial_measurement
add_trial_measurement(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.AddTrialMeasurementRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Trial
Adds a measurement of the objective metrics to a Trial.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.add_trial_measurement
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.cancel_operation
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.check_trial_early_stopping_state
check_trial_early_stopping_state(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.CheckTrialEarlyStoppingStateRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Checks whether a Trial should stop or not.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.common_folder_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.common_location_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.common_organization_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.common_project_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.complete_trial
complete_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.CompleteTrialRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Trial
Marks a Trial as complete.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.complete_trial
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.create_study
create_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.CreateStudyRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
study: typing.Optional[google.cloud.aiplatform_v1beta1.types.study.Study] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Study
Creates a Study.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.create_study
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.create_trial
create_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.CreateTrialRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
trial: typing.Optional[google.cloud.aiplatform_v1beta1.types.study.Trial] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Trial
Adds a user provided Trial to a Study.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.create_trial
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.custom_job_path
custom_job_path(project: str, location: str, custom_job: str) -> str
Returns a fully-qualified custom_job string.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.custom_job_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.delete_operation
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.delete_study
delete_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.DeleteStudyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a Study.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.delete_study
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.delete_trial
delete_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.DeleteTrialRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a Trial.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.delete_trial
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.get_iam_policy
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.get_location
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.get_operation
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.get_study
get_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.GetStudyRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Study
Gets a Study by name.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.get_study
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.get_trial
get_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.GetTrialRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Trial
Gets a Trial.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.get_trial
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.list_locations
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.list_operations
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.list_optimal_trials
list_optimal_trials(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.ListOptimalTrialsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.vizier_service.ListOptimalTrialsResponse
Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.list_optimal_trials
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.list_studies
list_studies(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.ListStudiesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListStudiesPager
Lists all the studies in a region for an associated project.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.list_studies
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.list_trials
list_trials(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.ListTrialsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListTrialsPager
Lists the Trials associated with a Study.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.list_trials
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.lookup_study
lookup_study(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.LookupStudyRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Study
Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.lookup_study
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.parse_common_folder_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.parse_custom_job_path
parse_custom_job_path(path: str) -> typing.Dict[str, str]
Parses a custom_job path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.parse_custom_job_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.parse_study_path
parse_study_path(path: str) -> typing.Dict[str, str]
Parses a study path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.parse_study_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.parse_trial_path
parse_trial_path(path: str) -> typing.Dict[str, str]
Parses a trial path into its component segments.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.parse_trial_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.set_iam_policy
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.stop_trial
stop_trial(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.StopTrialRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.aiplatform_v1beta1.types.study.Trial
Stops a Trial.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.stop_trial
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.study_path
study_path(project: str, location: str, study: str) -> str
Returns a fully-qualified study string.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.study_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.suggest_trials
suggest_trials(
request: typing.Optional[
typing.Union[
google.cloud.aiplatform_v1beta1.types.vizier_service.SuggestTrialsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.suggest_trials
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.test_iam_permissions
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.trial_path
trial_path(project: str, location: str, study: str, trial: str) -> str
Returns a fully-qualified trial string.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.trial_path
google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.wait_operation
wait_operation(
request: typing.Optional[
google.longrunning.operations_pb2.WaitOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.VizierServiceClient.wait_operation
google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListStudiesAsyncPager
ListStudiesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.vizier_service.ListStudiesResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.vizier_service.ListStudiesRequest,
response: google.cloud.aiplatform_v1beta1.types.vizier_service.ListStudiesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListStudiesAsyncPager
google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListStudiesPager
ListStudiesPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1beta1.types.vizier_service.ListStudiesResponse
],
request: google.cloud.aiplatform_v1beta1.types.vizier_service.ListStudiesRequest,
response: google.cloud.aiplatform_v1beta1.types.vizier_service.ListStudiesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListStudiesPager
google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListTrialsAsyncPager
ListTrialsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.aiplatform_v1beta1.types.vizier_service.ListTrialsResponse
],
],
request: google.cloud.aiplatform_v1beta1.types.vizier_service.ListTrialsRequest,
response: google.cloud.aiplatform_v1beta1.types.vizier_service.ListTrialsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListTrialsAsyncPager
google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListTrialsPager
ListTrialsPager(
method: typing.Callable[
[...], google.cloud.aiplatform_v1beta1.types.vizier_service.ListTrialsResponse
],
request: google.cloud.aiplatform_v1beta1.types.vizier_service.ListTrialsRequest,
response: google.cloud.aiplatform_v1beta1.types.vizier_service.ListTrialsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListTrialsPager
google.cloud.aiplatform_v1beta1.types.AcceleratorType
AcceleratorType(value)
Represents a hardware accelerator type.
See more: google.cloud.aiplatform_v1beta1.types.AcceleratorType
google.cloud.aiplatform_v1beta1.types.ActiveLearningConfig
ActiveLearningConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Parameters that configure the active learning pipeline.
See more: google.cloud.aiplatform_v1beta1.types.ActiveLearningConfig
google.cloud.aiplatform_v1beta1.types.AddContextArtifactsAndExecutionsRequest
AddContextArtifactsAndExecutionsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for MetadataService.AddContextArtifactsAndExecutions.
See more: google.cloud.aiplatform_v1beta1.types.AddContextArtifactsAndExecutionsRequest
google.cloud.aiplatform_v1beta1.types.AddContextArtifactsAndExecutionsResponse
AddContextArtifactsAndExecutionsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for MetadataService.AddContextArtifactsAndExecutions.
See more: google.cloud.aiplatform_v1beta1.types.AddContextArtifactsAndExecutionsResponse
google.cloud.aiplatform_v1beta1.types.AddContextChildrenRequest
AddContextChildrenRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.AddContextChildren.
See more: google.cloud.aiplatform_v1beta1.types.AddContextChildrenRequest
google.cloud.aiplatform_v1beta1.types.AddContextChildrenResponse
AddContextChildrenResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.AddContextChildren.
See more: google.cloud.aiplatform_v1beta1.types.AddContextChildrenResponse
google.cloud.aiplatform_v1beta1.types.AddExecutionEventsRequest
AddExecutionEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.AddExecutionEvents.
See more: google.cloud.aiplatform_v1beta1.types.AddExecutionEventsRequest
google.cloud.aiplatform_v1beta1.types.AddExecutionEventsResponse
AddExecutionEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.AddExecutionEvents.
See more: google.cloud.aiplatform_v1beta1.types.AddExecutionEventsResponse
google.cloud.aiplatform_v1beta1.types.AddTrialMeasurementRequest
AddTrialMeasurementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.AddTrialMeasurement.
See more: google.cloud.aiplatform_v1beta1.types.AddTrialMeasurementRequest
google.cloud.aiplatform_v1beta1.types.Annotation
Annotation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.
google.cloud.aiplatform_v1beta1.types.Annotation.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Annotation.LabelsEntry
google.cloud.aiplatform_v1beta1.types.AnnotationSpec
AnnotationSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Identifies a concept with which DataItems may be annotated with.
See more: google.cloud.aiplatform_v1beta1.types.AnnotationSpec
google.cloud.aiplatform_v1beta1.types.Artifact
Artifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Instance of a general artifact.
google.cloud.aiplatform_v1beta1.types.Artifact.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Artifact.LabelsEntry
google.cloud.aiplatform_v1beta1.types.Artifact.State
State(value)
Describes the state of the Artifact.
See more: google.cloud.aiplatform_v1beta1.types.Artifact.State
google.cloud.aiplatform_v1beta1.types.AssignNotebookRuntimeOperationMetadata
AssignNotebookRuntimeOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Metadata information for NotebookService.AssignNotebookRuntime.
See more: google.cloud.aiplatform_v1beta1.types.AssignNotebookRuntimeOperationMetadata
google.cloud.aiplatform_v1beta1.types.AssignNotebookRuntimeRequest
AssignNotebookRuntimeRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.AssignNotebookRuntime.
See more: google.cloud.aiplatform_v1beta1.types.AssignNotebookRuntimeRequest
google.cloud.aiplatform_v1beta1.types.Attribution
Attribution(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Attribution that explains a particular prediction output.
google.cloud.aiplatform_v1beta1.types.AuthConfig
AuthConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Auth configuration to run the extension.
google.cloud.aiplatform_v1beta1.types.AuthConfig.ApiKeyConfig
ApiKeyConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for authentication with API key.
See more: google.cloud.aiplatform_v1beta1.types.AuthConfig.ApiKeyConfig
google.cloud.aiplatform_v1beta1.types.AuthConfig.GoogleServiceAccountConfig
GoogleServiceAccountConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for Google Service Account Authentication.
See more: google.cloud.aiplatform_v1beta1.types.AuthConfig.GoogleServiceAccountConfig
google.cloud.aiplatform_v1beta1.types.AuthConfig.HttpBasicAuthConfig
HttpBasicAuthConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for HTTP Basic Authentication.
See more: google.cloud.aiplatform_v1beta1.types.AuthConfig.HttpBasicAuthConfig
google.cloud.aiplatform_v1beta1.types.AuthConfig.OauthConfig
OauthConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for user oauth.
See more: google.cloud.aiplatform_v1beta1.types.AuthConfig.OauthConfig
google.cloud.aiplatform_v1beta1.types.AuthConfig.OidcConfig
OidcConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for user OIDC auth.
See more: google.cloud.aiplatform_v1beta1.types.AuthConfig.OidcConfig
google.cloud.aiplatform_v1beta1.types.AuthType
AuthType(value)
Type of Auth.
google.cloud.aiplatform_v1beta1.types.AutomaticResources
AutomaticResources(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
See more: google.cloud.aiplatform_v1beta1.types.AutomaticResources
google.cloud.aiplatform_v1beta1.types.AutoscalingMetricSpec
AutoscalingMetricSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.
See more: google.cloud.aiplatform_v1beta1.types.AutoscalingMetricSpec
google.cloud.aiplatform_v1beta1.types.AvroSource
AvroSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The storage details for Avro input content.
google.cloud.aiplatform_v1beta1.types.BatchCancelPipelineJobsOperationMetadata
BatchCancelPipelineJobsOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for PipelineService.BatchCancelPipelineJobs.
See more: google.cloud.aiplatform_v1beta1.types.BatchCancelPipelineJobsOperationMetadata
google.cloud.aiplatform_v1beta1.types.BatchCancelPipelineJobsRequest
BatchCancelPipelineJobsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PipelineService.BatchCancelPipelineJobs.
See more: google.cloud.aiplatform_v1beta1.types.BatchCancelPipelineJobsRequest
google.cloud.aiplatform_v1beta1.types.BatchCancelPipelineJobsResponse
BatchCancelPipelineJobsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for PipelineService.BatchCancelPipelineJobs.
See more: google.cloud.aiplatform_v1beta1.types.BatchCancelPipelineJobsResponse
google.cloud.aiplatform_v1beta1.types.BatchCreateFeaturesOperationMetadata
BatchCreateFeaturesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform batch create Features.
See more: google.cloud.aiplatform_v1beta1.types.BatchCreateFeaturesOperationMetadata
google.cloud.aiplatform_v1beta1.types.BatchCreateFeaturesRequest
BatchCreateFeaturesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.BatchCreateFeatures.
See more: google.cloud.aiplatform_v1beta1.types.BatchCreateFeaturesRequest
google.cloud.aiplatform_v1beta1.types.BatchCreateFeaturesResponse
BatchCreateFeaturesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.BatchCreateFeatures.
See more: google.cloud.aiplatform_v1beta1.types.BatchCreateFeaturesResponse
google.cloud.aiplatform_v1beta1.types.BatchCreateTensorboardRunsRequest
BatchCreateTensorboardRunsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.BatchCreateTensorboardRuns.
See more: google.cloud.aiplatform_v1beta1.types.BatchCreateTensorboardRunsRequest
google.cloud.aiplatform_v1beta1.types.BatchCreateTensorboardRunsResponse
BatchCreateTensorboardRunsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.BatchCreateTensorboardRuns.
See more: google.cloud.aiplatform_v1beta1.types.BatchCreateTensorboardRunsResponse
google.cloud.aiplatform_v1beta1.types.BatchCreateTensorboardTimeSeriesRequest
BatchCreateTensorboardTimeSeriesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.BatchCreateTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1beta1.types.BatchCreateTensorboardTimeSeriesRequest
google.cloud.aiplatform_v1beta1.types.BatchCreateTensorboardTimeSeriesResponse
BatchCreateTensorboardTimeSeriesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.BatchCreateTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1beta1.types.BatchCreateTensorboardTimeSeriesResponse
google.cloud.aiplatform_v1beta1.types.BatchDedicatedResources
BatchDedicatedResources(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration.
See more: google.cloud.aiplatform_v1beta1.types.BatchDedicatedResources
google.cloud.aiplatform_v1beta1.types.BatchDeletePipelineJobsRequest
BatchDeletePipelineJobsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PipelineService.BatchDeletePipelineJobs.
See more: google.cloud.aiplatform_v1beta1.types.BatchDeletePipelineJobsRequest
google.cloud.aiplatform_v1beta1.types.BatchDeletePipelineJobsResponse
BatchDeletePipelineJobsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for PipelineService.BatchDeletePipelineJobs.
See more: google.cloud.aiplatform_v1beta1.types.BatchDeletePipelineJobsResponse
google.cloud.aiplatform_v1beta1.types.BatchImportEvaluatedAnnotationsRequest
BatchImportEvaluatedAnnotationsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ModelService.BatchImportEvaluatedAnnotations .
See more: google.cloud.aiplatform_v1beta1.types.BatchImportEvaluatedAnnotationsRequest
google.cloud.aiplatform_v1beta1.types.BatchImportEvaluatedAnnotationsResponse
BatchImportEvaluatedAnnotationsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for ModelService.BatchImportEvaluatedAnnotations .
See more: google.cloud.aiplatform_v1beta1.types.BatchImportEvaluatedAnnotationsResponse
google.cloud.aiplatform_v1beta1.types.BatchImportModelEvaluationSlicesRequest
BatchImportModelEvaluationSlicesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ModelService.BatchImportModelEvaluationSlices .
See more: google.cloud.aiplatform_v1beta1.types.BatchImportModelEvaluationSlicesRequest
google.cloud.aiplatform_v1beta1.types.BatchImportModelEvaluationSlicesResponse
BatchImportModelEvaluationSlicesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for ModelService.BatchImportModelEvaluationSlices .
See more: google.cloud.aiplatform_v1beta1.types.BatchImportModelEvaluationSlicesResponse
google.cloud.aiplatform_v1beta1.types.BatchMigrateResourcesOperationMetadata
BatchMigrateResourcesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for MigrationService.BatchMigrateResources.
See more: google.cloud.aiplatform_v1beta1.types.BatchMigrateResourcesOperationMetadata
google.cloud.aiplatform_v1beta1.types.BatchMigrateResourcesOperationMetadata.PartialResult
PartialResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a partial result in batch migration operation for one MigrateResourceRequest.
See more: google.cloud.aiplatform_v1beta1.types.BatchMigrateResourcesOperationMetadata.PartialResult
google.cloud.aiplatform_v1beta1.types.BatchMigrateResourcesRequest
BatchMigrateResourcesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for MigrationService.BatchMigrateResources.
See more: google.cloud.aiplatform_v1beta1.types.BatchMigrateResourcesRequest
google.cloud.aiplatform_v1beta1.types.BatchMigrateResourcesResponse
BatchMigrateResourcesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for MigrationService.BatchMigrateResources.
See more: google.cloud.aiplatform_v1beta1.types.BatchMigrateResourcesResponse
google.cloud.aiplatform_v1beta1.types.BatchPredictionJob
BatchPredictionJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A job that uses a Model to produce predictions on multiple [input instances][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config].
See more: google.cloud.aiplatform_v1beta1.types.BatchPredictionJob
google.cloud.aiplatform_v1beta1.types.BatchPredictionJob.InputConfig
InputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configures the input to BatchPredictionJob.
See more: google.cloud.aiplatform_v1beta1.types.BatchPredictionJob.InputConfig
google.cloud.aiplatform_v1beta1.types.BatchPredictionJob.InstanceConfig
InstanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration defining how to transform batch prediction input instances to the instances that the Model accepts.
See more: google.cloud.aiplatform_v1beta1.types.BatchPredictionJob.InstanceConfig
google.cloud.aiplatform_v1beta1.types.BatchPredictionJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.BatchPredictionJob.LabelsEntry
google.cloud.aiplatform_v1beta1.types.BatchPredictionJob.OutputConfig
OutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configures the output of BatchPredictionJob.
See more: google.cloud.aiplatform_v1beta1.types.BatchPredictionJob.OutputConfig
google.cloud.aiplatform_v1beta1.types.BatchPredictionJob.OutputInfo
OutputInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Further describes this job's output.
See more: google.cloud.aiplatform_v1beta1.types.BatchPredictionJob.OutputInfo
google.cloud.aiplatform_v1beta1.types.BatchReadFeatureValuesOperationMetadata
BatchReadFeatureValuesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that batch reads Feature values.
See more: google.cloud.aiplatform_v1beta1.types.BatchReadFeatureValuesOperationMetadata
google.cloud.aiplatform_v1beta1.types.BatchReadFeatureValuesRequest
BatchReadFeatureValuesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeaturestoreService.BatchReadFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.BatchReadFeatureValuesRequest
google.cloud.aiplatform_v1beta1.types.BatchReadFeatureValuesRequest.EntityTypeSpec
EntityTypeSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Selects Features of an EntityType to read values of and specifies read settings.
See more: google.cloud.aiplatform_v1beta1.types.BatchReadFeatureValuesRequest.EntityTypeSpec
google.cloud.aiplatform_v1beta1.types.BatchReadFeatureValuesRequest.PassThroughField
PassThroughField(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describe pass-through fields in read_instance source.
See more: google.cloud.aiplatform_v1beta1.types.BatchReadFeatureValuesRequest.PassThroughField
google.cloud.aiplatform_v1beta1.types.BatchReadFeatureValuesResponse
BatchReadFeatureValuesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for FeaturestoreService.BatchReadFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.BatchReadFeatureValuesResponse
google.cloud.aiplatform_v1beta1.types.BatchReadTensorboardTimeSeriesDataRequest
BatchReadTensorboardTimeSeriesDataRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.BatchReadTensorboardTimeSeriesData.
See more: google.cloud.aiplatform_v1beta1.types.BatchReadTensorboardTimeSeriesDataRequest
google.cloud.aiplatform_v1beta1.types.BatchReadTensorboardTimeSeriesDataResponse
BatchReadTensorboardTimeSeriesDataResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.BatchReadTensorboardTimeSeriesData.
See more: google.cloud.aiplatform_v1beta1.types.BatchReadTensorboardTimeSeriesDataResponse
google.cloud.aiplatform_v1beta1.types.BigQueryDestination
BigQueryDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The BigQuery location for the output content.
See more: google.cloud.aiplatform_v1beta1.types.BigQueryDestination
google.cloud.aiplatform_v1beta1.types.BigQuerySource
BigQuerySource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The BigQuery location for the input content.
See more: google.cloud.aiplatform_v1beta1.types.BigQuerySource
google.cloud.aiplatform_v1beta1.types.BleuInput
BleuInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for bleu metric.
google.cloud.aiplatform_v1beta1.types.BleuInstance
BleuInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for bleu instance.
See more: google.cloud.aiplatform_v1beta1.types.BleuInstance
google.cloud.aiplatform_v1beta1.types.BleuMetricValue
BleuMetricValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Bleu metric value for an instance.
See more: google.cloud.aiplatform_v1beta1.types.BleuMetricValue
google.cloud.aiplatform_v1beta1.types.BleuResults
BleuResults(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Results for bleu metric.
google.cloud.aiplatform_v1beta1.types.BleuSpec
BleuSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1.
google.cloud.aiplatform_v1beta1.types.Blob
Blob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Content blob.
google.cloud.aiplatform_v1beta1.types.BlurBaselineConfig
BlurBaselineConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for blur baseline.
See more: google.cloud.aiplatform_v1beta1.types.BlurBaselineConfig
google.cloud.aiplatform_v1beta1.types.BoolArray
BoolArray(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of boolean values.
google.cloud.aiplatform_v1beta1.types.CancelBatchPredictionJobRequest
CancelBatchPredictionJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CancelBatchPredictionJob.
See more: google.cloud.aiplatform_v1beta1.types.CancelBatchPredictionJobRequest
google.cloud.aiplatform_v1beta1.types.CancelCustomJobRequest
CancelCustomJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.CancelCustomJob.
See more: google.cloud.aiplatform_v1beta1.types.CancelCustomJobRequest
google.cloud.aiplatform_v1beta1.types.CancelDataLabelingJobRequest
CancelDataLabelingJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CancelDataLabelingJob.
See more: google.cloud.aiplatform_v1beta1.types.CancelDataLabelingJobRequest
google.cloud.aiplatform_v1beta1.types.CancelHyperparameterTuningJobRequest
CancelHyperparameterTuningJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CancelHyperparameterTuningJob.
See more: google.cloud.aiplatform_v1beta1.types.CancelHyperparameterTuningJobRequest
google.cloud.aiplatform_v1beta1.types.CancelNasJobRequest
CancelNasJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.CancelNasJob.
See more: google.cloud.aiplatform_v1beta1.types.CancelNasJobRequest
google.cloud.aiplatform_v1beta1.types.CancelPipelineJobRequest
CancelPipelineJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PipelineService.CancelPipelineJob.
See more: google.cloud.aiplatform_v1beta1.types.CancelPipelineJobRequest
google.cloud.aiplatform_v1beta1.types.CancelTrainingPipelineRequest
CancelTrainingPipelineRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PipelineService.CancelTrainingPipeline.
See more: google.cloud.aiplatform_v1beta1.types.CancelTrainingPipelineRequest
google.cloud.aiplatform_v1beta1.types.Candidate
Candidate(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A response candidate generated from the model.
google.cloud.aiplatform_v1beta1.types.Candidate.FinishReason
FinishReason(value)
The reason why the model stopped generating tokens.
See more: google.cloud.aiplatform_v1beta1.types.Candidate.FinishReason
google.cloud.aiplatform_v1beta1.types.ChatCompletionsRequest
ChatCompletionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for [PredictionService.ChatCompletions] .
See more: google.cloud.aiplatform_v1beta1.types.ChatCompletionsRequest
google.cloud.aiplatform_v1beta1.types.CheckTrialEarlyStoppingStateMetatdata
CheckTrialEarlyStoppingStateMetatdata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.
See more: google.cloud.aiplatform_v1beta1.types.CheckTrialEarlyStoppingStateMetatdata
google.cloud.aiplatform_v1beta1.types.CheckTrialEarlyStoppingStateRequest
CheckTrialEarlyStoppingStateRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for VizierService.CheckTrialEarlyStoppingState.
See more: google.cloud.aiplatform_v1beta1.types.CheckTrialEarlyStoppingStateRequest
google.cloud.aiplatform_v1beta1.types.CheckTrialEarlyStoppingStateResponse
CheckTrialEarlyStoppingStateResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for VizierService.CheckTrialEarlyStoppingState.
See more: google.cloud.aiplatform_v1beta1.types.CheckTrialEarlyStoppingStateResponse
google.cloud.aiplatform_v1beta1.types.Citation
Citation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Source attributions for content.
google.cloud.aiplatform_v1beta1.types.CitationMetadata
CitationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A collection of source attributions for a piece of content.
See more: google.cloud.aiplatform_v1beta1.types.CitationMetadata
google.cloud.aiplatform_v1beta1.types.CoherenceInput
CoherenceInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for coherence metric.
See more: google.cloud.aiplatform_v1beta1.types.CoherenceInput
google.cloud.aiplatform_v1beta1.types.CoherenceInstance
CoherenceInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for coherence instance.
See more: google.cloud.aiplatform_v1beta1.types.CoherenceInstance
google.cloud.aiplatform_v1beta1.types.CoherenceResult
CoherenceResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for coherence result.
See more: google.cloud.aiplatform_v1beta1.types.CoherenceResult
google.cloud.aiplatform_v1beta1.types.CoherenceSpec
CoherenceSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for coherence score metric.
See more: google.cloud.aiplatform_v1beta1.types.CoherenceSpec
google.cloud.aiplatform_v1beta1.types.CompleteTrialRequest
CompleteTrialRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.CompleteTrial.
See more: google.cloud.aiplatform_v1beta1.types.CompleteTrialRequest
google.cloud.aiplatform_v1beta1.types.CompletionStats
CompletionStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch.
See more: google.cloud.aiplatform_v1beta1.types.CompletionStats
google.cloud.aiplatform_v1beta1.types.ComputeTokensRequest
ComputeTokensRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ComputeTokens RPC call.
See more: google.cloud.aiplatform_v1beta1.types.ComputeTokensRequest
google.cloud.aiplatform_v1beta1.types.ComputeTokensResponse
ComputeTokensResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for ComputeTokens RPC call.
See more: google.cloud.aiplatform_v1beta1.types.ComputeTokensResponse
google.cloud.aiplatform_v1beta1.types.ContainerRegistryDestination
ContainerRegistryDestination(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The Container Registry location for the container image.
See more: google.cloud.aiplatform_v1beta1.types.ContainerRegistryDestination
google.cloud.aiplatform_v1beta1.types.ContainerSpec
ContainerSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The spec of a Container.
See more: google.cloud.aiplatform_v1beta1.types.ContainerSpec
google.cloud.aiplatform_v1beta1.types.Content
Content(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The base structured datatype containing multi-part content of a message.
google.cloud.aiplatform_v1beta1.types.Context
Context(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Instance of a general context.
google.cloud.aiplatform_v1beta1.types.Context.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Context.LabelsEntry
google.cloud.aiplatform_v1beta1.types.CopyModelOperationMetadata
CopyModelOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Details of ModelService.CopyModel operation.
See more: google.cloud.aiplatform_v1beta1.types.CopyModelOperationMetadata
google.cloud.aiplatform_v1beta1.types.CopyModelRequest
CopyModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.CopyModel.
See more: google.cloud.aiplatform_v1beta1.types.CopyModelRequest
google.cloud.aiplatform_v1beta1.types.CopyModelResponse
CopyModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message of ModelService.CopyModel operation.
See more: google.cloud.aiplatform_v1beta1.types.CopyModelResponse
google.cloud.aiplatform_v1beta1.types.CountTokensRequest
CountTokensRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.CountTokens.
See more: google.cloud.aiplatform_v1beta1.types.CountTokensRequest
google.cloud.aiplatform_v1beta1.types.CountTokensResponse
CountTokensResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.CountTokens.
See more: google.cloud.aiplatform_v1beta1.types.CountTokensResponse
google.cloud.aiplatform_v1beta1.types.CreateArtifactRequest
CreateArtifactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.CreateArtifact.
See more: google.cloud.aiplatform_v1beta1.types.CreateArtifactRequest
google.cloud.aiplatform_v1beta1.types.CreateBatchPredictionJobRequest
CreateBatchPredictionJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CreateBatchPredictionJob.
See more: google.cloud.aiplatform_v1beta1.types.CreateBatchPredictionJobRequest
google.cloud.aiplatform_v1beta1.types.CreateContextRequest
CreateContextRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.CreateContext.
See more: google.cloud.aiplatform_v1beta1.types.CreateContextRequest
google.cloud.aiplatform_v1beta1.types.CreateCustomJobRequest
CreateCustomJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.CreateCustomJob.
See more: google.cloud.aiplatform_v1beta1.types.CreateCustomJobRequest
google.cloud.aiplatform_v1beta1.types.CreateDataLabelingJobRequest
CreateDataLabelingJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CreateDataLabelingJob.
See more: google.cloud.aiplatform_v1beta1.types.CreateDataLabelingJobRequest
google.cloud.aiplatform_v1beta1.types.CreateDatasetOperationMetadata
CreateDatasetOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for DatasetService.CreateDataset.
See more: google.cloud.aiplatform_v1beta1.types.CreateDatasetOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateDatasetRequest
CreateDatasetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.CreateDataset.
See more: google.cloud.aiplatform_v1beta1.types.CreateDatasetRequest
google.cloud.aiplatform_v1beta1.types.CreateDatasetVersionOperationMetadata
CreateDatasetVersionOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for DatasetService.CreateDatasetVersion.
See more: google.cloud.aiplatform_v1beta1.types.CreateDatasetVersionOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateDatasetVersionRequest
CreateDatasetVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.CreateDatasetVersion.
See more: google.cloud.aiplatform_v1beta1.types.CreateDatasetVersionRequest
google.cloud.aiplatform_v1beta1.types.CreateDeploymentResourcePoolOperationMetadata
CreateDeploymentResourcePoolOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for CreateDeploymentResourcePool method.
See more: google.cloud.aiplatform_v1beta1.types.CreateDeploymentResourcePoolOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateDeploymentResourcePoolRequest
CreateDeploymentResourcePoolRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for CreateDeploymentResourcePool method.
See more: google.cloud.aiplatform_v1beta1.types.CreateDeploymentResourcePoolRequest
google.cloud.aiplatform_v1beta1.types.CreateEndpointOperationMetadata
CreateEndpointOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for EndpointService.CreateEndpoint.
See more: google.cloud.aiplatform_v1beta1.types.CreateEndpointOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateEndpointRequest
CreateEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.CreateEndpoint.
See more: google.cloud.aiplatform_v1beta1.types.CreateEndpointRequest
google.cloud.aiplatform_v1beta1.types.CreateEntityTypeOperationMetadata
CreateEntityTypeOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create EntityType.
See more: google.cloud.aiplatform_v1beta1.types.CreateEntityTypeOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateEntityTypeRequest
CreateEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.CreateEntityType.
See more: google.cloud.aiplatform_v1beta1.types.CreateEntityTypeRequest
google.cloud.aiplatform_v1beta1.types.CreateExecutionRequest
CreateExecutionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.CreateExecution.
See more: google.cloud.aiplatform_v1beta1.types.CreateExecutionRequest
google.cloud.aiplatform_v1beta1.types.CreateFeatureGroupOperationMetadata
CreateFeatureGroupOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create FeatureGroup.
See more: google.cloud.aiplatform_v1beta1.types.CreateFeatureGroupOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateFeatureGroupRequest
CreateFeatureGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureRegistryService.CreateFeatureGroup.
See more: google.cloud.aiplatform_v1beta1.types.CreateFeatureGroupRequest
google.cloud.aiplatform_v1beta1.types.CreateFeatureOnlineStoreOperationMetadata
CreateFeatureOnlineStoreOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create FeatureOnlineStore.
See more: google.cloud.aiplatform_v1beta1.types.CreateFeatureOnlineStoreOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateFeatureOnlineStoreRequest
CreateFeatureOnlineStoreRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeatureOnlineStoreAdminService.CreateFeatureOnlineStore.
See more: google.cloud.aiplatform_v1beta1.types.CreateFeatureOnlineStoreRequest
google.cloud.aiplatform_v1beta1.types.CreateFeatureOperationMetadata
CreateFeatureOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create Feature.
See more: google.cloud.aiplatform_v1beta1.types.CreateFeatureOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateFeatureRequest
CreateFeatureRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.CreateFeature.
See more: google.cloud.aiplatform_v1beta1.types.CreateFeatureRequest
google.cloud.aiplatform_v1beta1.types.CreateFeatureViewOperationMetadata
CreateFeatureViewOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create FeatureView.
See more: google.cloud.aiplatform_v1beta1.types.CreateFeatureViewOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateFeatureViewRequest
CreateFeatureViewRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.CreateFeatureView.
See more: google.cloud.aiplatform_v1beta1.types.CreateFeatureViewRequest
google.cloud.aiplatform_v1beta1.types.CreateFeaturestoreOperationMetadata
CreateFeaturestoreOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create Featurestore.
See more: google.cloud.aiplatform_v1beta1.types.CreateFeaturestoreOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateFeaturestoreRequest
CreateFeaturestoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.CreateFeaturestore.
See more: google.cloud.aiplatform_v1beta1.types.CreateFeaturestoreRequest
google.cloud.aiplatform_v1beta1.types.CreateHyperparameterTuningJobRequest
CreateHyperparameterTuningJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CreateHyperparameterTuningJob.
See more: google.cloud.aiplatform_v1beta1.types.CreateHyperparameterTuningJobRequest
google.cloud.aiplatform_v1beta1.types.CreateIndexEndpointOperationMetadata
CreateIndexEndpointOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for IndexEndpointService.CreateIndexEndpoint.
See more: google.cloud.aiplatform_v1beta1.types.CreateIndexEndpointOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateIndexEndpointRequest
CreateIndexEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.CreateIndexEndpoint.
See more: google.cloud.aiplatform_v1beta1.types.CreateIndexEndpointRequest
google.cloud.aiplatform_v1beta1.types.CreateIndexOperationMetadata
CreateIndexOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for IndexService.CreateIndex.
See more: google.cloud.aiplatform_v1beta1.types.CreateIndexOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateIndexRequest
CreateIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.CreateIndex.
See more: google.cloud.aiplatform_v1beta1.types.CreateIndexRequest
google.cloud.aiplatform_v1beta1.types.CreateMetadataSchemaRequest
CreateMetadataSchemaRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.CreateMetadataSchema.
See more: google.cloud.aiplatform_v1beta1.types.CreateMetadataSchemaRequest
google.cloud.aiplatform_v1beta1.types.CreateMetadataStoreOperationMetadata
CreateMetadataStoreOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform MetadataService.CreateMetadataStore.
See more: google.cloud.aiplatform_v1beta1.types.CreateMetadataStoreOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateMetadataStoreRequest
CreateMetadataStoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.CreateMetadataStore.
See more: google.cloud.aiplatform_v1beta1.types.CreateMetadataStoreRequest
google.cloud.aiplatform_v1beta1.types.CreateModelDeploymentMonitoringJobRequest
CreateModelDeploymentMonitoringJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.CreateModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1beta1.types.CreateModelDeploymentMonitoringJobRequest
google.cloud.aiplatform_v1beta1.types.CreateNasJobRequest
CreateNasJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.CreateNasJob.
See more: google.cloud.aiplatform_v1beta1.types.CreateNasJobRequest
google.cloud.aiplatform_v1beta1.types.CreateNotebookRuntimeTemplateOperationMetadata
CreateNotebookRuntimeTemplateOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Metadata information for NotebookService.CreateNotebookRuntimeTemplate.
See more: google.cloud.aiplatform_v1beta1.types.CreateNotebookRuntimeTemplateOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateNotebookRuntimeTemplateRequest
CreateNotebookRuntimeTemplateRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.CreateNotebookRuntimeTemplate.
See more: google.cloud.aiplatform_v1beta1.types.CreateNotebookRuntimeTemplateRequest
google.cloud.aiplatform_v1beta1.types.CreatePersistentResourceOperationMetadata
CreatePersistentResourceOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create PersistentResource.
See more: google.cloud.aiplatform_v1beta1.types.CreatePersistentResourceOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreatePersistentResourceRequest
CreatePersistentResourceRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PersistentResourceService.CreatePersistentResource.
See more: google.cloud.aiplatform_v1beta1.types.CreatePersistentResourceRequest
google.cloud.aiplatform_v1beta1.types.CreatePipelineJobRequest
CreatePipelineJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PipelineService.CreatePipelineJob.
See more: google.cloud.aiplatform_v1beta1.types.CreatePipelineJobRequest
google.cloud.aiplatform_v1beta1.types.CreateRagCorpusOperationMetadata
CreateRagCorpusOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for VertexRagDataService.CreateRagCorpus.
See more: google.cloud.aiplatform_v1beta1.types.CreateRagCorpusOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateRagCorpusRequest
CreateRagCorpusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VertexRagDataService.CreateRagCorpus.
See more: google.cloud.aiplatform_v1beta1.types.CreateRagCorpusRequest
google.cloud.aiplatform_v1beta1.types.CreateReasoningEngineOperationMetadata
CreateReasoningEngineOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of ReasoningEngineService.CreateReasoningEngine operation.
See more: google.cloud.aiplatform_v1beta1.types.CreateReasoningEngineOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateReasoningEngineRequest
CreateReasoningEngineRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ReasoningEngineService.CreateReasoningEngine.
See more: google.cloud.aiplatform_v1beta1.types.CreateReasoningEngineRequest
google.cloud.aiplatform_v1beta1.types.CreateRegistryFeatureOperationMetadata
CreateRegistryFeatureOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create FeatureGroup.
See more: google.cloud.aiplatform_v1beta1.types.CreateRegistryFeatureOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateScheduleRequest
CreateScheduleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.CreateSchedule.
See more: google.cloud.aiplatform_v1beta1.types.CreateScheduleRequest
google.cloud.aiplatform_v1beta1.types.CreateSpecialistPoolOperationMetadata
CreateSpecialistPoolOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for SpecialistPoolService.CreateSpecialistPool.
See more: google.cloud.aiplatform_v1beta1.types.CreateSpecialistPoolOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateSpecialistPoolRequest
CreateSpecialistPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for SpecialistPoolService.CreateSpecialistPool.
See more: google.cloud.aiplatform_v1beta1.types.CreateSpecialistPoolRequest
google.cloud.aiplatform_v1beta1.types.CreateStudyRequest
CreateStudyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.CreateStudy.
See more: google.cloud.aiplatform_v1beta1.types.CreateStudyRequest
google.cloud.aiplatform_v1beta1.types.CreateTensorboardExperimentRequest
CreateTensorboardExperimentRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.CreateTensorboardExperiment.
See more: google.cloud.aiplatform_v1beta1.types.CreateTensorboardExperimentRequest
google.cloud.aiplatform_v1beta1.types.CreateTensorboardOperationMetadata
CreateTensorboardOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform create Tensorboard.
See more: google.cloud.aiplatform_v1beta1.types.CreateTensorboardOperationMetadata
google.cloud.aiplatform_v1beta1.types.CreateTensorboardRequest
CreateTensorboardRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.CreateTensorboard.
See more: google.cloud.aiplatform_v1beta1.types.CreateTensorboardRequest
google.cloud.aiplatform_v1beta1.types.CreateTensorboardRunRequest
CreateTensorboardRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.CreateTensorboardRun.
See more: google.cloud.aiplatform_v1beta1.types.CreateTensorboardRunRequest
google.cloud.aiplatform_v1beta1.types.CreateTensorboardTimeSeriesRequest
CreateTensorboardTimeSeriesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.CreateTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1beta1.types.CreateTensorboardTimeSeriesRequest
google.cloud.aiplatform_v1beta1.types.CreateTrainingPipelineRequest
CreateTrainingPipelineRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PipelineService.CreateTrainingPipeline.
See more: google.cloud.aiplatform_v1beta1.types.CreateTrainingPipelineRequest
google.cloud.aiplatform_v1beta1.types.CreateTrialRequest
CreateTrialRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.CreateTrial.
See more: google.cloud.aiplatform_v1beta1.types.CreateTrialRequest
google.cloud.aiplatform_v1beta1.types.CsvDestination
CsvDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The storage details for CSV output content.
See more: google.cloud.aiplatform_v1beta1.types.CsvDestination
google.cloud.aiplatform_v1beta1.types.CsvSource
CsvSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The storage details for CSV input content.
google.cloud.aiplatform_v1beta1.types.CustomJob
CustomJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a job that runs custom workloads such as a Docker container or a Python package.
google.cloud.aiplatform_v1beta1.types.CustomJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.CustomJob.LabelsEntry
google.cloud.aiplatform_v1beta1.types.CustomJob.WebAccessUrisEntry
WebAccessUrisEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.CustomJob.WebAccessUrisEntry
google.cloud.aiplatform_v1beta1.types.CustomJobSpec
CustomJobSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of a CustomJob.
See more: google.cloud.aiplatform_v1beta1.types.CustomJobSpec
google.cloud.aiplatform_v1beta1.types.DataItem
DataItem(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A piece of data in a Dataset.
google.cloud.aiplatform_v1beta1.types.DataItem.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.DataItem.LabelsEntry
google.cloud.aiplatform_v1beta1.types.DataItemView
DataItemView(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A container for a single DataItem and Annotations on it.
See more: google.cloud.aiplatform_v1beta1.types.DataItemView
google.cloud.aiplatform_v1beta1.types.DataLabelingJob
DataLabelingJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset: .
See more: google.cloud.aiplatform_v1beta1.types.DataLabelingJob
google.cloud.aiplatform_v1beta1.types.DataLabelingJob.AnnotationLabelsEntry
AnnotationLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.DataLabelingJob.AnnotationLabelsEntry
google.cloud.aiplatform_v1beta1.types.DataLabelingJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.DataLabelingJob.LabelsEntry
google.cloud.aiplatform_v1beta1.types.Dataset
Dataset(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A collection of DataItems and Annotations on them.
google.cloud.aiplatform_v1beta1.types.Dataset.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Dataset.LabelsEntry
google.cloud.aiplatform_v1beta1.types.DatasetVersion
DatasetVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes the dataset version.
See more: google.cloud.aiplatform_v1beta1.types.DatasetVersion
google.cloud.aiplatform_v1beta1.types.DedicatedResources
DedicatedResources(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.
See more: google.cloud.aiplatform_v1beta1.types.DedicatedResources
google.cloud.aiplatform_v1beta1.types.DeleteArtifactRequest
DeleteArtifactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.DeleteArtifact.
See more: google.cloud.aiplatform_v1beta1.types.DeleteArtifactRequest
google.cloud.aiplatform_v1beta1.types.DeleteBatchPredictionJobRequest
DeleteBatchPredictionJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.DeleteBatchPredictionJob.
See more: google.cloud.aiplatform_v1beta1.types.DeleteBatchPredictionJobRequest
google.cloud.aiplatform_v1beta1.types.DeleteContextRequest
DeleteContextRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.DeleteContext.
See more: google.cloud.aiplatform_v1beta1.types.DeleteContextRequest
google.cloud.aiplatform_v1beta1.types.DeleteCustomJobRequest
DeleteCustomJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.DeleteCustomJob.
See more: google.cloud.aiplatform_v1beta1.types.DeleteCustomJobRequest
google.cloud.aiplatform_v1beta1.types.DeleteDataLabelingJobRequest
DeleteDataLabelingJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.DeleteDataLabelingJob.
See more: google.cloud.aiplatform_v1beta1.types.DeleteDataLabelingJobRequest
google.cloud.aiplatform_v1beta1.types.DeleteDatasetRequest
DeleteDatasetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.DeleteDataset.
See more: google.cloud.aiplatform_v1beta1.types.DeleteDatasetRequest
google.cloud.aiplatform_v1beta1.types.DeleteDatasetVersionRequest
DeleteDatasetVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.DeleteDatasetVersion.
See more: google.cloud.aiplatform_v1beta1.types.DeleteDatasetVersionRequest
google.cloud.aiplatform_v1beta1.types.DeleteDeploymentResourcePoolRequest
DeleteDeploymentResourcePoolRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for DeleteDeploymentResourcePool method.
See more: google.cloud.aiplatform_v1beta1.types.DeleteDeploymentResourcePoolRequest
google.cloud.aiplatform_v1beta1.types.DeleteEndpointRequest
DeleteEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.DeleteEndpoint.
See more: google.cloud.aiplatform_v1beta1.types.DeleteEndpointRequest
google.cloud.aiplatform_v1beta1.types.DeleteEntityTypeRequest
DeleteEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for [FeaturestoreService.DeleteEntityTypes][].
See more: google.cloud.aiplatform_v1beta1.types.DeleteEntityTypeRequest
google.cloud.aiplatform_v1beta1.types.DeleteExecutionRequest
DeleteExecutionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.DeleteExecution.
See more: google.cloud.aiplatform_v1beta1.types.DeleteExecutionRequest
google.cloud.aiplatform_v1beta1.types.DeleteExtensionRequest
DeleteExtensionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ExtensionRegistryService.DeleteExtension.
See more: google.cloud.aiplatform_v1beta1.types.DeleteExtensionRequest
google.cloud.aiplatform_v1beta1.types.DeleteFeatureGroupRequest
DeleteFeatureGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureRegistryService.DeleteFeatureGroup.
See more: google.cloud.aiplatform_v1beta1.types.DeleteFeatureGroupRequest
google.cloud.aiplatform_v1beta1.types.DeleteFeatureOnlineStoreRequest
DeleteFeatureOnlineStoreRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeatureOnlineStoreAdminService.DeleteFeatureOnlineStore.
See more: google.cloud.aiplatform_v1beta1.types.DeleteFeatureOnlineStoreRequest
google.cloud.aiplatform_v1beta1.types.DeleteFeatureRequest
DeleteFeatureRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.DeleteFeature.
See more: google.cloud.aiplatform_v1beta1.types.DeleteFeatureRequest
google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesOperationMetadata
DeleteFeatureValuesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that delete Feature values.
See more: google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesOperationMetadata
google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesRequest
DeleteFeatureValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.DeleteFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesRequest
google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesRequest.SelectEntity
SelectEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Message to select entity.
See more: google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesRequest.SelectEntity
google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesRequest.SelectTimeRangeAndFeature
SelectTimeRangeAndFeature(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Message to select time range and feature.
See more: google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesRequest.SelectTimeRangeAndFeature
google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesResponse
DeleteFeatureValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.DeleteFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesResponse
google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesResponse.SelectEntity
SelectEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message if the request uses the SelectEntity option.
See more: google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesResponse.SelectEntity
google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesResponse.SelectTimeRangeAndFeature
SelectTimeRangeAndFeature(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message if the request uses the SelectTimeRangeAndFeature option.
See more: google.cloud.aiplatform_v1beta1.types.DeleteFeatureValuesResponse.SelectTimeRangeAndFeature
google.cloud.aiplatform_v1beta1.types.DeleteFeatureViewRequest
DeleteFeatureViewRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for [FeatureOnlineStoreAdminService.DeleteFeatureViews][].
See more: google.cloud.aiplatform_v1beta1.types.DeleteFeatureViewRequest
google.cloud.aiplatform_v1beta1.types.DeleteFeaturestoreRequest
DeleteFeaturestoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.DeleteFeaturestore.
See more: google.cloud.aiplatform_v1beta1.types.DeleteFeaturestoreRequest
google.cloud.aiplatform_v1beta1.types.DeleteHyperparameterTuningJobRequest
DeleteHyperparameterTuningJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.DeleteHyperparameterTuningJob.
See more: google.cloud.aiplatform_v1beta1.types.DeleteHyperparameterTuningJobRequest
google.cloud.aiplatform_v1beta1.types.DeleteIndexEndpointRequest
DeleteIndexEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.DeleteIndexEndpoint.
See more: google.cloud.aiplatform_v1beta1.types.DeleteIndexEndpointRequest
google.cloud.aiplatform_v1beta1.types.DeleteIndexRequest
DeleteIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.DeleteIndex.
See more: google.cloud.aiplatform_v1beta1.types.DeleteIndexRequest
google.cloud.aiplatform_v1beta1.types.DeleteMetadataStoreOperationMetadata
DeleteMetadataStoreOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform MetadataService.DeleteMetadataStore.
See more: google.cloud.aiplatform_v1beta1.types.DeleteMetadataStoreOperationMetadata
google.cloud.aiplatform_v1beta1.types.DeleteMetadataStoreRequest
DeleteMetadataStoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.DeleteMetadataStore.
See more: google.cloud.aiplatform_v1beta1.types.DeleteMetadataStoreRequest
google.cloud.aiplatform_v1beta1.types.DeleteModelDeploymentMonitoringJobRequest
DeleteModelDeploymentMonitoringJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.DeleteModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1beta1.types.DeleteModelDeploymentMonitoringJobRequest
google.cloud.aiplatform_v1beta1.types.DeleteModelRequest
DeleteModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.DeleteModel.
See more: google.cloud.aiplatform_v1beta1.types.DeleteModelRequest
google.cloud.aiplatform_v1beta1.types.DeleteModelVersionRequest
DeleteModelVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.DeleteModelVersion.
See more: google.cloud.aiplatform_v1beta1.types.DeleteModelVersionRequest
google.cloud.aiplatform_v1beta1.types.DeleteNasJobRequest
DeleteNasJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.DeleteNasJob.
See more: google.cloud.aiplatform_v1beta1.types.DeleteNasJobRequest
google.cloud.aiplatform_v1beta1.types.DeleteNotebookRuntimeRequest
DeleteNotebookRuntimeRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.DeleteNotebookRuntime.
See more: google.cloud.aiplatform_v1beta1.types.DeleteNotebookRuntimeRequest
google.cloud.aiplatform_v1beta1.types.DeleteNotebookRuntimeTemplateRequest
DeleteNotebookRuntimeTemplateRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.DeleteNotebookRuntimeTemplate.
See more: google.cloud.aiplatform_v1beta1.types.DeleteNotebookRuntimeTemplateRequest
google.cloud.aiplatform_v1beta1.types.DeleteOperationMetadata
DeleteOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Details of operations that perform deletes of any entities.
See more: google.cloud.aiplatform_v1beta1.types.DeleteOperationMetadata
google.cloud.aiplatform_v1beta1.types.DeletePersistentResourceRequest
DeletePersistentResourceRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PersistentResourceService.DeletePersistentResource.
See more: google.cloud.aiplatform_v1beta1.types.DeletePersistentResourceRequest
google.cloud.aiplatform_v1beta1.types.DeletePipelineJobRequest
DeletePipelineJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PipelineService.DeletePipelineJob.
See more: google.cloud.aiplatform_v1beta1.types.DeletePipelineJobRequest
google.cloud.aiplatform_v1beta1.types.DeleteRagCorpusRequest
DeleteRagCorpusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VertexRagDataService.DeleteRagCorpus.
See more: google.cloud.aiplatform_v1beta1.types.DeleteRagCorpusRequest
google.cloud.aiplatform_v1beta1.types.DeleteRagFileRequest
DeleteRagFileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VertexRagDataService.DeleteRagFile.
See more: google.cloud.aiplatform_v1beta1.types.DeleteRagFileRequest
google.cloud.aiplatform_v1beta1.types.DeleteReasoningEngineRequest
DeleteReasoningEngineRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ReasoningEngineService.DeleteReasoningEngine.
See more: google.cloud.aiplatform_v1beta1.types.DeleteReasoningEngineRequest
google.cloud.aiplatform_v1beta1.types.DeleteSavedQueryRequest
DeleteSavedQueryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.DeleteSavedQuery.
See more: google.cloud.aiplatform_v1beta1.types.DeleteSavedQueryRequest
google.cloud.aiplatform_v1beta1.types.DeleteScheduleRequest
DeleteScheduleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.DeleteSchedule.
See more: google.cloud.aiplatform_v1beta1.types.DeleteScheduleRequest
google.cloud.aiplatform_v1beta1.types.DeleteSpecialistPoolRequest
DeleteSpecialistPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for SpecialistPoolService.DeleteSpecialistPool.
See more: google.cloud.aiplatform_v1beta1.types.DeleteSpecialistPoolRequest
google.cloud.aiplatform_v1beta1.types.DeleteStudyRequest
DeleteStudyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.DeleteStudy.
See more: google.cloud.aiplatform_v1beta1.types.DeleteStudyRequest
google.cloud.aiplatform_v1beta1.types.DeleteTensorboardExperimentRequest
DeleteTensorboardExperimentRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.DeleteTensorboardExperiment.
See more: google.cloud.aiplatform_v1beta1.types.DeleteTensorboardExperimentRequest
google.cloud.aiplatform_v1beta1.types.DeleteTensorboardRequest
DeleteTensorboardRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.DeleteTensorboard.
See more: google.cloud.aiplatform_v1beta1.types.DeleteTensorboardRequest
google.cloud.aiplatform_v1beta1.types.DeleteTensorboardRunRequest
DeleteTensorboardRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.DeleteTensorboardRun.
See more: google.cloud.aiplatform_v1beta1.types.DeleteTensorboardRunRequest
google.cloud.aiplatform_v1beta1.types.DeleteTensorboardTimeSeriesRequest
DeleteTensorboardTimeSeriesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.DeleteTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1beta1.types.DeleteTensorboardTimeSeriesRequest
google.cloud.aiplatform_v1beta1.types.DeleteTrainingPipelineRequest
DeleteTrainingPipelineRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PipelineService.DeleteTrainingPipeline.
See more: google.cloud.aiplatform_v1beta1.types.DeleteTrainingPipelineRequest
google.cloud.aiplatform_v1beta1.types.DeleteTrialRequest
DeleteTrialRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.DeleteTrial.
See more: google.cloud.aiplatform_v1beta1.types.DeleteTrialRequest
google.cloud.aiplatform_v1beta1.types.DeployIndexOperationMetadata
DeployIndexOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for IndexEndpointService.DeployIndex.
See more: google.cloud.aiplatform_v1beta1.types.DeployIndexOperationMetadata
google.cloud.aiplatform_v1beta1.types.DeployIndexRequest
DeployIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.DeployIndex.
See more: google.cloud.aiplatform_v1beta1.types.DeployIndexRequest
google.cloud.aiplatform_v1beta1.types.DeployIndexResponse
DeployIndexResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexEndpointService.DeployIndex.
See more: google.cloud.aiplatform_v1beta1.types.DeployIndexResponse
google.cloud.aiplatform_v1beta1.types.DeployModelOperationMetadata
DeployModelOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for EndpointService.DeployModel.
See more: google.cloud.aiplatform_v1beta1.types.DeployModelOperationMetadata
google.cloud.aiplatform_v1beta1.types.DeployModelRequest
DeployModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.DeployModel.
See more: google.cloud.aiplatform_v1beta1.types.DeployModelRequest
google.cloud.aiplatform_v1beta1.types.DeployModelRequest.TrafficSplitEntry
TrafficSplitEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.DeployModelRequest.TrafficSplitEntry
google.cloud.aiplatform_v1beta1.types.DeployModelResponse
DeployModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for EndpointService.DeployModel.
See more: google.cloud.aiplatform_v1beta1.types.DeployModelResponse
google.cloud.aiplatform_v1beta1.types.DeployedIndex
DeployedIndex(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A deployment of an Index.
See more: google.cloud.aiplatform_v1beta1.types.DeployedIndex
google.cloud.aiplatform_v1beta1.types.DeployedIndexAuthConfig
DeployedIndexAuthConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Used to set up the auth on the DeployedIndex's private endpoint.
See more: google.cloud.aiplatform_v1beta1.types.DeployedIndexAuthConfig
google.cloud.aiplatform_v1beta1.types.DeployedIndexAuthConfig.AuthProvider
AuthProvider(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for an authentication provider, including support for
JSON Web Token
(JWT) <https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32>
__.
See more: google.cloud.aiplatform_v1beta1.types.DeployedIndexAuthConfig.AuthProvider
google.cloud.aiplatform_v1beta1.types.DeployedIndexRef
DeployedIndexRef(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Points to a DeployedIndex.
See more: google.cloud.aiplatform_v1beta1.types.DeployedIndexRef
google.cloud.aiplatform_v1beta1.types.DeployedModel
DeployedModel(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A deployment of a Model.
See more: google.cloud.aiplatform_v1beta1.types.DeployedModel
google.cloud.aiplatform_v1beta1.types.DeployedModelRef
DeployedModelRef(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Points to a DeployedModel.
See more: google.cloud.aiplatform_v1beta1.types.DeployedModelRef
google.cloud.aiplatform_v1beta1.types.DeploymentResourcePool
DeploymentResourcePool(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources.
See more: google.cloud.aiplatform_v1beta1.types.DeploymentResourcePool
google.cloud.aiplatform_v1beta1.types.DestinationFeatureSetting
DestinationFeatureSetting(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform_v1beta1.types.DirectPredictRequest
DirectPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.DirectPredict.
See more: google.cloud.aiplatform_v1beta1.types.DirectPredictRequest
google.cloud.aiplatform_v1beta1.types.DirectPredictResponse
DirectPredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.DirectPredict.
See more: google.cloud.aiplatform_v1beta1.types.DirectPredictResponse
google.cloud.aiplatform_v1beta1.types.DirectRawPredictRequest
DirectRawPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.DirectRawPredict.
See more: google.cloud.aiplatform_v1beta1.types.DirectRawPredictRequest
google.cloud.aiplatform_v1beta1.types.DirectRawPredictResponse
DirectRawPredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.DirectRawPredict.
See more: google.cloud.aiplatform_v1beta1.types.DirectRawPredictResponse
google.cloud.aiplatform_v1beta1.types.DirectUploadSource
DirectUploadSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The input content is encapsulated and uploaded in the request.
See more: google.cloud.aiplatform_v1beta1.types.DirectUploadSource
google.cloud.aiplatform_v1beta1.types.DiskSpec
DiskSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of disk options.
google.cloud.aiplatform_v1beta1.types.DoubleArray
DoubleArray(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of double values.
google.cloud.aiplatform_v1beta1.types.EncryptionSpec
EncryptionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a customer-managed encryption key spec that can be applied to a top-level resource.
See more: google.cloud.aiplatform_v1beta1.types.EncryptionSpec
google.cloud.aiplatform_v1beta1.types.Endpoint
Endpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
google.cloud.aiplatform_v1beta1.types.Endpoint.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Endpoint.LabelsEntry
google.cloud.aiplatform_v1beta1.types.Endpoint.TrafficSplitEntry
TrafficSplitEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Endpoint.TrafficSplitEntry
google.cloud.aiplatform_v1beta1.types.EntityIdSelector
EntityIdSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Selector for entityId.
See more: google.cloud.aiplatform_v1beta1.types.EntityIdSelector
google.cloud.aiplatform_v1beta1.types.EntityType
EntityType(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An entity type is a type of object in a system that needs to be modeled and have stored information about.
google.cloud.aiplatform_v1beta1.types.EntityType.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.EntityType.LabelsEntry
google.cloud.aiplatform_v1beta1.types.EnvVar
EnvVar(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents an environment variable present in a Container or Python Module.
google.cloud.aiplatform_v1beta1.types.ErrorAnalysisAnnotation
ErrorAnalysisAnnotation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Model error analysis for each annotation.
See more: google.cloud.aiplatform_v1beta1.types.ErrorAnalysisAnnotation
google.cloud.aiplatform_v1beta1.types.ErrorAnalysisAnnotation.AttributedItem
AttributedItem(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Attributed items for a given annotation, typically representing neighbors from the training sets constrained by the query type.
See more: google.cloud.aiplatform_v1beta1.types.ErrorAnalysisAnnotation.AttributedItem
google.cloud.aiplatform_v1beta1.types.ErrorAnalysisAnnotation.QueryType
QueryType(value)
The query type used for finding the attributed items.
See more: google.cloud.aiplatform_v1beta1.types.ErrorAnalysisAnnotation.QueryType
google.cloud.aiplatform_v1beta1.types.EvaluateInstancesRequest
EvaluateInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EvaluationService.EvaluateInstances.
See more: google.cloud.aiplatform_v1beta1.types.EvaluateInstancesRequest
google.cloud.aiplatform_v1beta1.types.EvaluateInstancesResponse
EvaluateInstancesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for EvaluationService.EvaluateInstances.
See more: google.cloud.aiplatform_v1beta1.types.EvaluateInstancesResponse
google.cloud.aiplatform_v1beta1.types.EvaluatedAnnotation
EvaluatedAnnotation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
True positive, false positive, or false negative.
See more: google.cloud.aiplatform_v1beta1.types.EvaluatedAnnotation
google.cloud.aiplatform_v1beta1.types.EvaluatedAnnotation.EvaluatedAnnotationType
EvaluatedAnnotationType(value)
Describes the type of the EvaluatedAnnotation.
See more: google.cloud.aiplatform_v1beta1.types.EvaluatedAnnotation.EvaluatedAnnotationType
google.cloud.aiplatform_v1beta1.types.EvaluatedAnnotationExplanation
EvaluatedAnnotationExplanation(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Explanation result of the prediction produced by the Model.
See more: google.cloud.aiplatform_v1beta1.types.EvaluatedAnnotationExplanation
google.cloud.aiplatform_v1beta1.types.Event
Event(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An edge describing the relationship between an Artifact and an Execution in a lineage graph.
google.cloud.aiplatform_v1beta1.types.Event.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Event.LabelsEntry
google.cloud.aiplatform_v1beta1.types.Event.Type
Type(value)
Describes whether an Event's Artifact is the Execution's input or output.
google.cloud.aiplatform_v1beta1.types.ExactMatchInput
ExactMatchInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for exact match metric.
See more: google.cloud.aiplatform_v1beta1.types.ExactMatchInput
google.cloud.aiplatform_v1beta1.types.ExactMatchInstance
ExactMatchInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for exact match instance.
See more: google.cloud.aiplatform_v1beta1.types.ExactMatchInstance
google.cloud.aiplatform_v1beta1.types.ExactMatchMetricValue
ExactMatchMetricValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Exact match metric value for an instance.
See more: google.cloud.aiplatform_v1beta1.types.ExactMatchMetricValue
google.cloud.aiplatform_v1beta1.types.ExactMatchResults
ExactMatchResults(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Results for exact match metric.
See more: google.cloud.aiplatform_v1beta1.types.ExactMatchResults
google.cloud.aiplatform_v1beta1.types.ExactMatchSpec
ExactMatchSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0.
See more: google.cloud.aiplatform_v1beta1.types.ExactMatchSpec
google.cloud.aiplatform_v1beta1.types.Examples
Examples(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Example-based explainability that returns the nearest neighbors from the provided dataset.
google.cloud.aiplatform_v1beta1.types.Examples.ExampleGcsSource
ExampleGcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The Cloud Storage input instances.
See more: google.cloud.aiplatform_v1beta1.types.Examples.ExampleGcsSource
google.cloud.aiplatform_v1beta1.types.Examples.ExampleGcsSource.DataFormat
DataFormat(value)
The format of the input example instances.
See more: google.cloud.aiplatform_v1beta1.types.Examples.ExampleGcsSource.DataFormat
google.cloud.aiplatform_v1beta1.types.ExamplesOverride
ExamplesOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Overrides for example-based explanations.
See more: google.cloud.aiplatform_v1beta1.types.ExamplesOverride
google.cloud.aiplatform_v1beta1.types.ExamplesOverride.DataFormat
DataFormat(value)
Data format enum.
See more: google.cloud.aiplatform_v1beta1.types.ExamplesOverride.DataFormat
google.cloud.aiplatform_v1beta1.types.ExamplesRestrictionsNamespace
ExamplesRestrictionsNamespace(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Restrictions namespace for example-based explanations overrides.
See more: google.cloud.aiplatform_v1beta1.types.ExamplesRestrictionsNamespace
google.cloud.aiplatform_v1beta1.types.ExecuteExtensionRequest
ExecuteExtensionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ExtensionExecutionService.ExecuteExtension.
See more: google.cloud.aiplatform_v1beta1.types.ExecuteExtensionRequest
google.cloud.aiplatform_v1beta1.types.ExecuteExtensionResponse
ExecuteExtensionResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for ExtensionExecutionService.ExecuteExtension.
See more: google.cloud.aiplatform_v1beta1.types.ExecuteExtensionResponse
google.cloud.aiplatform_v1beta1.types.Execution
Execution(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Instance of a general execution.
google.cloud.aiplatform_v1beta1.types.Execution.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Execution.LabelsEntry
google.cloud.aiplatform_v1beta1.types.Execution.State
State(value)
Describes the state of the Execution.
See more: google.cloud.aiplatform_v1beta1.types.Execution.State
google.cloud.aiplatform_v1beta1.types.ExplainRequest
ExplainRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.Explain.
See more: google.cloud.aiplatform_v1beta1.types.ExplainRequest
google.cloud.aiplatform_v1beta1.types.ExplainRequest.ConcurrentExplanationSpecOverrideEntry
ConcurrentExplanationSpecOverrideEntry(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.ExplainRequest.ConcurrentExplanationSpecOverrideEntry
google.cloud.aiplatform_v1beta1.types.ExplainResponse
ExplainResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.Explain.
See more: google.cloud.aiplatform_v1beta1.types.ExplainResponse
google.cloud.aiplatform_v1beta1.types.ExplainResponse.ConcurrentExplanation
ConcurrentExplanation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
This message is a wrapper grouping Concurrent Explanations.
See more: google.cloud.aiplatform_v1beta1.types.ExplainResponse.ConcurrentExplanation
google.cloud.aiplatform_v1beta1.types.ExplainResponse.ConcurrentExplanationsEntry
ConcurrentExplanationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.ExplainResponse.ConcurrentExplanationsEntry
google.cloud.aiplatform_v1beta1.types.Explanation
Explanation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Explanation of a prediction (provided in PredictResponse.predictions) produced by the Model on a given instance.
google.cloud.aiplatform_v1beta1.types.ExplanationMetadata
ExplanationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata describing the Model's input and output for explanation.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadata
google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata
InputMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata of the input of a feature.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata
google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.Encoding
Encoding(value)
Defines how a feature is encoded.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.Encoding
google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.FeatureValueDomain
FeatureValueDomain(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Domain details of the input feature value.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.FeatureValueDomain
google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.Visualization
Visualization(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Visualization configurations for image explanation.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.Visualization
google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.Visualization.ColorMap
ColorMap(value)
The color scheme used for highlighting areas.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.Visualization.ColorMap
google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.Visualization.OverlayType
OverlayType(value)
How the original image is displayed in the visualization.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.Visualization.OverlayType
google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.Visualization.Polarity
Polarity(value)
Whether to only highlight pixels with positive contributions, negative or both.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.Visualization.Polarity
google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.Visualization.Type
Type(value)
Type of the image visualization.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputMetadata.Visualization.Type
google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputsEntry
InputsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.InputsEntry
google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.OutputMetadata
OutputMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata of the prediction output to be explained.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.OutputMetadata
google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.OutputsEntry
OutputsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadata.OutputsEntry
google.cloud.aiplatform_v1beta1.types.ExplanationMetadataOverride
ExplanationMetadataOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The ExplanationMetadata entries that can be overridden at [online explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadataOverride
google.cloud.aiplatform_v1beta1.types.ExplanationMetadataOverride.InputMetadataOverride
InputMetadataOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The [input metadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata] entries to be overridden.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadataOverride.InputMetadataOverride
google.cloud.aiplatform_v1beta1.types.ExplanationMetadataOverride.InputsEntry
InputsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationMetadataOverride.InputsEntry
google.cloud.aiplatform_v1beta1.types.ExplanationParameters
ExplanationParameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Parameters to configure explaining for Model's predictions.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationParameters
google.cloud.aiplatform_v1beta1.types.ExplanationSpec
ExplanationSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specification of Model explanation.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationSpec
google.cloud.aiplatform_v1beta1.types.ExplanationSpecOverride
ExplanationSpecOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The ExplanationSpec entries that can be overridden at [online explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time.
See more: google.cloud.aiplatform_v1beta1.types.ExplanationSpecOverride
google.cloud.aiplatform_v1beta1.types.ExportDataConfig
ExportDataConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes what part of the Dataset is to be exported, the destination of the export and how to export.
See more: google.cloud.aiplatform_v1beta1.types.ExportDataConfig
google.cloud.aiplatform_v1beta1.types.ExportDataOperationMetadata
ExportDataOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Runtime operation information for DatasetService.ExportData.
See more: google.cloud.aiplatform_v1beta1.types.ExportDataOperationMetadata
google.cloud.aiplatform_v1beta1.types.ExportDataRequest
ExportDataRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ExportData.
See more: google.cloud.aiplatform_v1beta1.types.ExportDataRequest
google.cloud.aiplatform_v1beta1.types.ExportDataResponse
ExportDataResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ExportData.
See more: google.cloud.aiplatform_v1beta1.types.ExportDataResponse
google.cloud.aiplatform_v1beta1.types.ExportFeatureValuesOperationMetadata
ExportFeatureValuesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that exports Features values.
See more: google.cloud.aiplatform_v1beta1.types.ExportFeatureValuesOperationMetadata
google.cloud.aiplatform_v1beta1.types.ExportFeatureValuesRequest
ExportFeatureValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.ExportFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.ExportFeatureValuesRequest
google.cloud.aiplatform_v1beta1.types.ExportFeatureValuesRequest.FullExport
FullExport(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes exporting all historical Feature values of all entities of the EntityType between [start_time, end_time].
See more: google.cloud.aiplatform_v1beta1.types.ExportFeatureValuesRequest.FullExport
google.cloud.aiplatform_v1beta1.types.ExportFeatureValuesRequest.SnapshotExport
SnapshotExport(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes exporting the latest Feature values of all entities of the EntityType between [start_time, snapshot_time].
See more: google.cloud.aiplatform_v1beta1.types.ExportFeatureValuesRequest.SnapshotExport
google.cloud.aiplatform_v1beta1.types.ExportFeatureValuesResponse
ExportFeatureValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.ExportFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.ExportFeatureValuesResponse
google.cloud.aiplatform_v1beta1.types.ExportFractionSplit
ExportFractionSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns the input data to training, validation, and test sets as per the given fractions.
See more: google.cloud.aiplatform_v1beta1.types.ExportFractionSplit
google.cloud.aiplatform_v1beta1.types.ExportModelOperationMetadata
ExportModelOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of ModelService.ExportModel operation.
See more: google.cloud.aiplatform_v1beta1.types.ExportModelOperationMetadata
google.cloud.aiplatform_v1beta1.types.ExportModelOperationMetadata.OutputInfo
OutputInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Further describes the output of the ExportModel.
See more: google.cloud.aiplatform_v1beta1.types.ExportModelOperationMetadata.OutputInfo
google.cloud.aiplatform_v1beta1.types.ExportModelRequest
ExportModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.ExportModel.
See more: google.cloud.aiplatform_v1beta1.types.ExportModelRequest
google.cloud.aiplatform_v1beta1.types.ExportModelRequest.OutputConfig
OutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Output configuration for the Model export.
See more: google.cloud.aiplatform_v1beta1.types.ExportModelRequest.OutputConfig
google.cloud.aiplatform_v1beta1.types.ExportModelResponse
ExportModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message of ModelService.ExportModel operation.
See more: google.cloud.aiplatform_v1beta1.types.ExportModelResponse
google.cloud.aiplatform_v1beta1.types.ExportTensorboardTimeSeriesDataRequest
ExportTensorboardTimeSeriesDataRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.ExportTensorboardTimeSeriesData.
See more: google.cloud.aiplatform_v1beta1.types.ExportTensorboardTimeSeriesDataRequest
google.cloud.aiplatform_v1beta1.types.ExportTensorboardTimeSeriesDataResponse
ExportTensorboardTimeSeriesDataResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.ExportTensorboardTimeSeriesData.
See more: google.cloud.aiplatform_v1beta1.types.ExportTensorboardTimeSeriesDataResponse
google.cloud.aiplatform_v1beta1.types.Extension
Extension(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Extensions are tools for large language models to access external data, run computations, etc.
google.cloud.aiplatform_v1beta1.types.ExtensionManifest
ExtensionManifest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Manifest spec of an Extension needed for runtime execution.
See more: google.cloud.aiplatform_v1beta1.types.ExtensionManifest
google.cloud.aiplatform_v1beta1.types.ExtensionManifest.ApiSpec
ApiSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The API specification shown to the LLM.
See more: google.cloud.aiplatform_v1beta1.types.ExtensionManifest.ApiSpec
google.cloud.aiplatform_v1beta1.types.ExtensionOperation
ExtensionOperation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Operation of an extension.
See more: google.cloud.aiplatform_v1beta1.types.ExtensionOperation
google.cloud.aiplatform_v1beta1.types.ExtensionPrivateServiceConnectConfig
ExtensionPrivateServiceConnectConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
PrivateExtensionConfig configuration for the extension.
See more: google.cloud.aiplatform_v1beta1.types.ExtensionPrivateServiceConnectConfig
google.cloud.aiplatform_v1beta1.types.Feature
Feature(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Feature Metadata information.
google.cloud.aiplatform_v1beta1.types.Feature.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Feature.LabelsEntry
google.cloud.aiplatform_v1beta1.types.Feature.MonitoringStatsAnomaly
MonitoringStatsAnomaly(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.
See more: google.cloud.aiplatform_v1beta1.types.Feature.MonitoringStatsAnomaly
google.cloud.aiplatform_v1beta1.types.Feature.MonitoringStatsAnomaly.Objective
Objective(value)
If the objective in the request is both Import Feature Analysis and Snapshot Analysis, this objective could be one of them.
See more: google.cloud.aiplatform_v1beta1.types.Feature.MonitoringStatsAnomaly.Objective
google.cloud.aiplatform_v1beta1.types.Feature.ValueType
ValueType(value)
Only applicable for Vertex AI Legacy Feature Store.
See more: google.cloud.aiplatform_v1beta1.types.Feature.ValueType
google.cloud.aiplatform_v1beta1.types.FeatureGroup
FeatureGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Vertex AI Feature Group.
See more: google.cloud.aiplatform_v1beta1.types.FeatureGroup
google.cloud.aiplatform_v1beta1.types.FeatureGroup.BigQuery
BigQuery(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input source type for BigQuery Tables and Views.
See more: google.cloud.aiplatform_v1beta1.types.FeatureGroup.BigQuery
google.cloud.aiplatform_v1beta1.types.FeatureGroup.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.FeatureGroup.LabelsEntry
google.cloud.aiplatform_v1beta1.types.FeatureNoiseSigma
FeatureNoiseSigma(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Noise sigma by features.
See more: google.cloud.aiplatform_v1beta1.types.FeatureNoiseSigma
google.cloud.aiplatform_v1beta1.types.FeatureNoiseSigma.NoiseSigmaForFeature
NoiseSigmaForFeature(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Noise sigma for a single feature.
See more: google.cloud.aiplatform_v1beta1.types.FeatureNoiseSigma.NoiseSigmaForFeature
google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore
FeatureOnlineStore(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Vertex AI Feature Online Store provides a centralized repository for serving ML features and embedding indexes at low latency.
See more: google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore
google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore.Bigtable
Bigtable(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore.Bigtable.AutoScaling
AutoScaling(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore.DedicatedServingEndpoint
DedicatedServingEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The dedicated serving endpoint for this FeatureOnlineStore.
See more: google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore.DedicatedServingEndpoint
google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore.EmbeddingManagement
EmbeddingManagement(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Deprecated: This sub message is no longer needed anymore and embedding management is automatically enabled when specifying Optimized storage type.
See more: google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore.EmbeddingManagement
google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore.LabelsEntry
google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore.Optimized
Optimized(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Optimized storage type.
See more: google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore.Optimized
google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore.State
State(value)
Possible states a featureOnlineStore can have.
See more: google.cloud.aiplatform_v1beta1.types.FeatureOnlineStore.State
google.cloud.aiplatform_v1beta1.types.FeatureSelector
FeatureSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Selector for Features of an EntityType.
See more: google.cloud.aiplatform_v1beta1.types.FeatureSelector
google.cloud.aiplatform_v1beta1.types.FeatureStatsAnomaly
FeatureStatsAnomaly(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Stats and Anomaly generated at specific timestamp for specific Feature.
See more: google.cloud.aiplatform_v1beta1.types.FeatureStatsAnomaly
google.cloud.aiplatform_v1beta1.types.FeatureValue
FeatureValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Value for a feature.
See more: google.cloud.aiplatform_v1beta1.types.FeatureValue
google.cloud.aiplatform_v1beta1.types.FeatureValue.Metadata
Metadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata of feature value.
See more: google.cloud.aiplatform_v1beta1.types.FeatureValue.Metadata
google.cloud.aiplatform_v1beta1.types.FeatureValueDestination
FeatureValueDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A destination location for Feature values and format.
See more: google.cloud.aiplatform_v1beta1.types.FeatureValueDestination
google.cloud.aiplatform_v1beta1.types.FeatureValueList
FeatureValueList(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Container for list of values.
See more: google.cloud.aiplatform_v1beta1.types.FeatureValueList
google.cloud.aiplatform_v1beta1.types.FeatureView
FeatureView(mapping=None, *, ignore_unknown_fields=False, **kwargs)
FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.
google.cloud.aiplatform_v1beta1.types.FeatureView.BigQuerySource
BigQuerySource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform_v1beta1.types.FeatureView.FeatureRegistrySource
FeatureRegistrySource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A Feature Registry source for features that need to be synced to Online Store.
See more: google.cloud.aiplatform_v1beta1.types.FeatureView.FeatureRegistrySource
google.cloud.aiplatform_v1beta1.types.FeatureView.FeatureRegistrySource.FeatureGroup
FeatureGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Features belonging to a single feature group that will be synced to Online Store.
See more: google.cloud.aiplatform_v1beta1.types.FeatureView.FeatureRegistrySource.FeatureGroup
google.cloud.aiplatform_v1beta1.types.FeatureView.IndexConfig
IndexConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for vector indexing.
See more: google.cloud.aiplatform_v1beta1.types.FeatureView.IndexConfig
google.cloud.aiplatform_v1beta1.types.FeatureView.IndexConfig.BruteForceConfig
BruteForceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration options for using brute force search.
See more: google.cloud.aiplatform_v1beta1.types.FeatureView.IndexConfig.BruteForceConfig
google.cloud.aiplatform_v1beta1.types.FeatureView.IndexConfig.DistanceMeasureType
DistanceMeasureType(value)
The distance measure used in nearest neighbor search.
See more: google.cloud.aiplatform_v1beta1.types.FeatureView.IndexConfig.DistanceMeasureType
google.cloud.aiplatform_v1beta1.types.FeatureView.IndexConfig.TreeAHConfig
TreeAHConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration options for the tree-AH algorithm.
See more: google.cloud.aiplatform_v1beta1.types.FeatureView.IndexConfig.TreeAHConfig
google.cloud.aiplatform_v1beta1.types.FeatureView.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.FeatureView.LabelsEntry
google.cloud.aiplatform_v1beta1.types.FeatureView.ServiceAgentType
ServiceAgentType(value)
Service agent type used during data sync.
See more: google.cloud.aiplatform_v1beta1.types.FeatureView.ServiceAgentType
google.cloud.aiplatform_v1beta1.types.FeatureView.SyncConfig
SyncConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for Sync.
See more: google.cloud.aiplatform_v1beta1.types.FeatureView.SyncConfig
google.cloud.aiplatform_v1beta1.types.FeatureView.VectorSearchConfig
VectorSearchConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Deprecated.
See more: google.cloud.aiplatform_v1beta1.types.FeatureView.VectorSearchConfig
google.cloud.aiplatform_v1beta1.types.FeatureView.VectorSearchConfig.DistanceMeasureType
DistanceMeasureType(value)
Values: DISTANCE_MEASURE_TYPE_UNSPECIFIED (0): Should not be set.
See more: google.cloud.aiplatform_v1beta1.types.FeatureView.VectorSearchConfig.DistanceMeasureType
google.cloud.aiplatform_v1beta1.types.FeatureView.VectorSearchConfig.TreeAHConfig
TreeAHConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform_v1beta1.types.FeatureViewDataFormat
FeatureViewDataFormat(value)
Format of the data in the Feature View.
See more: google.cloud.aiplatform_v1beta1.types.FeatureViewDataFormat
google.cloud.aiplatform_v1beta1.types.FeatureViewDataKey
FeatureViewDataKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Lookup key for a feature view.
See more: google.cloud.aiplatform_v1beta1.types.FeatureViewDataKey
google.cloud.aiplatform_v1beta1.types.FeatureViewDataKey.CompositeKey
CompositeKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)
ID that is comprised from several parts (columns).
See more: google.cloud.aiplatform_v1beta1.types.FeatureViewDataKey.CompositeKey
google.cloud.aiplatform_v1beta1.types.FeatureViewSync
FeatureViewSync(mapping=None, *, ignore_unknown_fields=False, **kwargs)
FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store.
See more: google.cloud.aiplatform_v1beta1.types.FeatureViewSync
google.cloud.aiplatform_v1beta1.types.FeatureViewSync.SyncSummary
SyncSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Summary from the Sync job.
See more: google.cloud.aiplatform_v1beta1.types.FeatureViewSync.SyncSummary
google.cloud.aiplatform_v1beta1.types.Featurestore
Featurestore(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Vertex AI Feature Store provides a centralized repository for organizing, storing, and serving ML features.
See more: google.cloud.aiplatform_v1beta1.types.Featurestore
google.cloud.aiplatform_v1beta1.types.Featurestore.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Featurestore.LabelsEntry
google.cloud.aiplatform_v1beta1.types.Featurestore.OnlineServingConfig
OnlineServingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
OnlineServingConfig specifies the details for provisioning online serving resources.
See more: google.cloud.aiplatform_v1beta1.types.Featurestore.OnlineServingConfig
google.cloud.aiplatform_v1beta1.types.Featurestore.OnlineServingConfig.Scaling
Scaling(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Online serving scaling configuration.
See more: google.cloud.aiplatform_v1beta1.types.Featurestore.OnlineServingConfig.Scaling
google.cloud.aiplatform_v1beta1.types.Featurestore.State
State(value)
Possible states a featurestore can have.
See more: google.cloud.aiplatform_v1beta1.types.Featurestore.State
google.cloud.aiplatform_v1beta1.types.FeaturestoreMonitoringConfig
FeaturestoreMonitoringConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Configuration of how features in Featurestore are monitored.
See more: google.cloud.aiplatform_v1beta1.types.FeaturestoreMonitoringConfig
google.cloud.aiplatform_v1beta1.types.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis
ImportFeaturesAnalysis(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration of the Featurestore's ImportFeature Analysis Based Monitoring.
See more: google.cloud.aiplatform_v1beta1.types.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis
google.cloud.aiplatform_v1beta1.types.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis.Baseline
Baseline(value)
Defines the baseline to do anomaly detection for feature values imported by each ImportFeatureValues operation.
See more: google.cloud.aiplatform_v1beta1.types.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis.Baseline
google.cloud.aiplatform_v1beta1.types.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis.State
State(value)
The state defines whether to enable ImportFeature analysis.
See more: google.cloud.aiplatform_v1beta1.types.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis.State
google.cloud.aiplatform_v1beta1.types.FeaturestoreMonitoringConfig.SnapshotAnalysis
SnapshotAnalysis(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration of the Featurestore's Snapshot Analysis Based Monitoring.
See more: google.cloud.aiplatform_v1beta1.types.FeaturestoreMonitoringConfig.SnapshotAnalysis
google.cloud.aiplatform_v1beta1.types.FeaturestoreMonitoringConfig.ThresholdConfig
ThresholdConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The config for Featurestore Monitoring threshold.
See more: google.cloud.aiplatform_v1beta1.types.FeaturestoreMonitoringConfig.ThresholdConfig
google.cloud.aiplatform_v1beta1.types.FetchFeatureValuesRequest
FetchFeatureValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreService.FetchFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.FetchFeatureValuesRequest
google.cloud.aiplatform_v1beta1.types.FetchFeatureValuesRequest.Format
Format(value)
Format of the response data.
See more: google.cloud.aiplatform_v1beta1.types.FetchFeatureValuesRequest.Format
google.cloud.aiplatform_v1beta1.types.FetchFeatureValuesResponse
FetchFeatureValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeatureOnlineStoreService.FetchFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.FetchFeatureValuesResponse
google.cloud.aiplatform_v1beta1.types.FetchFeatureValuesResponse.FeatureNameValuePairList
FeatureNameValuePairList(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response structure in the format of key (feature name) and (feature) value pair.
See more: google.cloud.aiplatform_v1beta1.types.FetchFeatureValuesResponse.FeatureNameValuePairList
google.cloud.aiplatform_v1beta1.types.FetchFeatureValuesResponse.FeatureNameValuePairList.FeatureNameValuePair
FeatureNameValuePair(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Feature name & value pair.
google.cloud.aiplatform_v1beta1.types.FileData
FileData(mapping=None, *, ignore_unknown_fields=False, **kwargs)
URI based data.
google.cloud.aiplatform_v1beta1.types.FilterSplit
FilterSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored.
google.cloud.aiplatform_v1beta1.types.FindNeighborsRequest
FindNeighborsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The request message for MatchService.FindNeighbors.
See more: google.cloud.aiplatform_v1beta1.types.FindNeighborsRequest
google.cloud.aiplatform_v1beta1.types.FindNeighborsRequest.Query
Query(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A query to find a number of the nearest neighbors (most similar vectors) of a vector.
See more: google.cloud.aiplatform_v1beta1.types.FindNeighborsRequest.Query
google.cloud.aiplatform_v1beta1.types.FindNeighborsResponse
FindNeighborsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The response message for MatchService.FindNeighbors.
See more: google.cloud.aiplatform_v1beta1.types.FindNeighborsResponse
google.cloud.aiplatform_v1beta1.types.FindNeighborsResponse.NearestNeighbors
NearestNeighbors(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Nearest neighbors for one query.
See more: google.cloud.aiplatform_v1beta1.types.FindNeighborsResponse.NearestNeighbors
google.cloud.aiplatform_v1beta1.types.FindNeighborsResponse.Neighbor
Neighbor(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A neighbor of the query vector.
See more: google.cloud.aiplatform_v1beta1.types.FindNeighborsResponse.Neighbor
google.cloud.aiplatform_v1beta1.types.FluencyInput
FluencyInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for fluency metric.
See more: google.cloud.aiplatform_v1beta1.types.FluencyInput
google.cloud.aiplatform_v1beta1.types.FluencyInstance
FluencyInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for fluency instance.
See more: google.cloud.aiplatform_v1beta1.types.FluencyInstance
google.cloud.aiplatform_v1beta1.types.FluencyResult
FluencyResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for fluency result.
See more: google.cloud.aiplatform_v1beta1.types.FluencyResult
google.cloud.aiplatform_v1beta1.types.FluencySpec
FluencySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for fluency score metric.
google.cloud.aiplatform_v1beta1.types.FractionSplit
FractionSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns the input data to training, validation, and test sets as per the given fractions.
See more: google.cloud.aiplatform_v1beta1.types.FractionSplit
google.cloud.aiplatform_v1beta1.types.FulfillmentInput
FulfillmentInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for fulfillment metric.
See more: google.cloud.aiplatform_v1beta1.types.FulfillmentInput
google.cloud.aiplatform_v1beta1.types.FulfillmentInstance
FulfillmentInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for fulfillment instance.
See more: google.cloud.aiplatform_v1beta1.types.FulfillmentInstance
google.cloud.aiplatform_v1beta1.types.FulfillmentResult
FulfillmentResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for fulfillment result.
See more: google.cloud.aiplatform_v1beta1.types.FulfillmentResult
google.cloud.aiplatform_v1beta1.types.FulfillmentSpec
FulfillmentSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for fulfillment metric.
See more: google.cloud.aiplatform_v1beta1.types.FulfillmentSpec
google.cloud.aiplatform_v1beta1.types.FunctionCall
FunctionCall(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.
See more: google.cloud.aiplatform_v1beta1.types.FunctionCall
google.cloud.aiplatform_v1beta1.types.FunctionCallingConfig
FunctionCallingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Function calling config.
See more: google.cloud.aiplatform_v1beta1.types.FunctionCallingConfig
google.cloud.aiplatform_v1beta1.types.FunctionCallingConfig.Mode
Mode(value)
Function calling mode.
See more: google.cloud.aiplatform_v1beta1.types.FunctionCallingConfig.Mode
google.cloud.aiplatform_v1beta1.types.FunctionDeclaration
FunctionDeclaration(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Structured representation of a function declaration as defined by
the OpenAPI 3.0
specification <https://spec.openapis.org/oas/v3.0.3>
__.
See more: google.cloud.aiplatform_v1beta1.types.FunctionDeclaration
google.cloud.aiplatform_v1beta1.types.FunctionResponse
FunctionResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model.
See more: google.cloud.aiplatform_v1beta1.types.FunctionResponse
google.cloud.aiplatform_v1beta1.types.GcsDestination
GcsDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The Google Cloud Storage location where the output is to be written to.
See more: google.cloud.aiplatform_v1beta1.types.GcsDestination
google.cloud.aiplatform_v1beta1.types.GcsSource
GcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The Google Cloud Storage location for the input content.
google.cloud.aiplatform_v1beta1.types.GenerateContentRequest
GenerateContentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for [PredictionService.GenerateContent].
See more: google.cloud.aiplatform_v1beta1.types.GenerateContentRequest
google.cloud.aiplatform_v1beta1.types.GenerateContentResponse
GenerateContentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for [PredictionService.GenerateContent].
See more: google.cloud.aiplatform_v1beta1.types.GenerateContentResponse
google.cloud.aiplatform_v1beta1.types.GenerateContentResponse.PromptFeedback
PromptFeedback(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Content filter results for a prompt sent in the request.
See more: google.cloud.aiplatform_v1beta1.types.GenerateContentResponse.PromptFeedback
google.cloud.aiplatform_v1beta1.types.GenerateContentResponse.PromptFeedback.BlockedReason
BlockedReason(value)
Blocked reason enumeration.
See more: google.cloud.aiplatform_v1beta1.types.GenerateContentResponse.PromptFeedback.BlockedReason
google.cloud.aiplatform_v1beta1.types.GenerateContentResponse.UsageMetadata
UsageMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Usage metadata about response(s).
See more: google.cloud.aiplatform_v1beta1.types.GenerateContentResponse.UsageMetadata
google.cloud.aiplatform_v1beta1.types.GenerationConfig
GenerationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Generation config.
See more: google.cloud.aiplatform_v1beta1.types.GenerationConfig
google.cloud.aiplatform_v1beta1.types.GenericOperationMetadata
GenericOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Generic Metadata shared by all operations.
See more: google.cloud.aiplatform_v1beta1.types.GenericOperationMetadata
google.cloud.aiplatform_v1beta1.types.GenieSource
GenieSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains information about the source of the models generated from Generative AI Studio.
google.cloud.aiplatform_v1beta1.types.GetAnnotationSpecRequest
GetAnnotationSpecRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.GetAnnotationSpec.
See more: google.cloud.aiplatform_v1beta1.types.GetAnnotationSpecRequest
google.cloud.aiplatform_v1beta1.types.GetArtifactRequest
GetArtifactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.GetArtifact.
See more: google.cloud.aiplatform_v1beta1.types.GetArtifactRequest
google.cloud.aiplatform_v1beta1.types.GetBatchPredictionJobRequest
GetBatchPredictionJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.GetBatchPredictionJob.
See more: google.cloud.aiplatform_v1beta1.types.GetBatchPredictionJobRequest
google.cloud.aiplatform_v1beta1.types.GetContextRequest
GetContextRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.GetContext.
See more: google.cloud.aiplatform_v1beta1.types.GetContextRequest
google.cloud.aiplatform_v1beta1.types.GetCustomJobRequest
GetCustomJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.GetCustomJob.
See more: google.cloud.aiplatform_v1beta1.types.GetCustomJobRequest
google.cloud.aiplatform_v1beta1.types.GetDataLabelingJobRequest
GetDataLabelingJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.GetDataLabelingJob.
See more: google.cloud.aiplatform_v1beta1.types.GetDataLabelingJobRequest
google.cloud.aiplatform_v1beta1.types.GetDatasetRequest
GetDatasetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.GetDataset.
See more: google.cloud.aiplatform_v1beta1.types.GetDatasetRequest
google.cloud.aiplatform_v1beta1.types.GetDatasetVersionRequest
GetDatasetVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.GetDatasetVersion.
See more: google.cloud.aiplatform_v1beta1.types.GetDatasetVersionRequest
google.cloud.aiplatform_v1beta1.types.GetDeploymentResourcePoolRequest
GetDeploymentResourcePoolRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for GetDeploymentResourcePool method.
See more: google.cloud.aiplatform_v1beta1.types.GetDeploymentResourcePoolRequest
google.cloud.aiplatform_v1beta1.types.GetEndpointRequest
GetEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.GetEndpoint .
See more: google.cloud.aiplatform_v1beta1.types.GetEndpointRequest
google.cloud.aiplatform_v1beta1.types.GetEntityTypeRequest
GetEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.GetEntityType.
See more: google.cloud.aiplatform_v1beta1.types.GetEntityTypeRequest
google.cloud.aiplatform_v1beta1.types.GetExecutionRequest
GetExecutionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.GetExecution.
See more: google.cloud.aiplatform_v1beta1.types.GetExecutionRequest
google.cloud.aiplatform_v1beta1.types.GetExtensionRequest
GetExtensionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ExtensionRegistryService.GetExtension.
See more: google.cloud.aiplatform_v1beta1.types.GetExtensionRequest
google.cloud.aiplatform_v1beta1.types.GetFeatureGroupRequest
GetFeatureGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureRegistryService.GetFeatureGroup.
See more: google.cloud.aiplatform_v1beta1.types.GetFeatureGroupRequest
google.cloud.aiplatform_v1beta1.types.GetFeatureOnlineStoreRequest
GetFeatureOnlineStoreRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeatureOnlineStoreAdminService.GetFeatureOnlineStore.
See more: google.cloud.aiplatform_v1beta1.types.GetFeatureOnlineStoreRequest
google.cloud.aiplatform_v1beta1.types.GetFeatureRequest
GetFeatureRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.GetFeature.
See more: google.cloud.aiplatform_v1beta1.types.GetFeatureRequest
google.cloud.aiplatform_v1beta1.types.GetFeatureViewRequest
GetFeatureViewRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.GetFeatureView.
See more: google.cloud.aiplatform_v1beta1.types.GetFeatureViewRequest
google.cloud.aiplatform_v1beta1.types.GetFeatureViewSyncRequest
GetFeatureViewSyncRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.GetFeatureViewSync.
See more: google.cloud.aiplatform_v1beta1.types.GetFeatureViewSyncRequest
google.cloud.aiplatform_v1beta1.types.GetFeaturestoreRequest
GetFeaturestoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.GetFeaturestore.
See more: google.cloud.aiplatform_v1beta1.types.GetFeaturestoreRequest
google.cloud.aiplatform_v1beta1.types.GetHyperparameterTuningJobRequest
GetHyperparameterTuningJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.GetHyperparameterTuningJob.
See more: google.cloud.aiplatform_v1beta1.types.GetHyperparameterTuningJobRequest
google.cloud.aiplatform_v1beta1.types.GetIndexEndpointRequest
GetIndexEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.GetIndexEndpoint .
See more: google.cloud.aiplatform_v1beta1.types.GetIndexEndpointRequest
google.cloud.aiplatform_v1beta1.types.GetIndexRequest
GetIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.GetIndex .
See more: google.cloud.aiplatform_v1beta1.types.GetIndexRequest
google.cloud.aiplatform_v1beta1.types.GetMetadataSchemaRequest
GetMetadataSchemaRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.GetMetadataSchema.
See more: google.cloud.aiplatform_v1beta1.types.GetMetadataSchemaRequest
google.cloud.aiplatform_v1beta1.types.GetMetadataStoreRequest
GetMetadataStoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.GetMetadataStore.
See more: google.cloud.aiplatform_v1beta1.types.GetMetadataStoreRequest
google.cloud.aiplatform_v1beta1.types.GetModelDeploymentMonitoringJobRequest
GetModelDeploymentMonitoringJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.GetModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1beta1.types.GetModelDeploymentMonitoringJobRequest
google.cloud.aiplatform_v1beta1.types.GetModelEvaluationRequest
GetModelEvaluationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.GetModelEvaluation.
See more: google.cloud.aiplatform_v1beta1.types.GetModelEvaluationRequest
google.cloud.aiplatform_v1beta1.types.GetModelEvaluationSliceRequest
GetModelEvaluationSliceRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ModelService.GetModelEvaluationSlice.
See more: google.cloud.aiplatform_v1beta1.types.GetModelEvaluationSliceRequest
google.cloud.aiplatform_v1beta1.types.GetModelRequest
GetModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.GetModel.
See more: google.cloud.aiplatform_v1beta1.types.GetModelRequest
google.cloud.aiplatform_v1beta1.types.GetNasJobRequest
GetNasJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.GetNasJob.
See more: google.cloud.aiplatform_v1beta1.types.GetNasJobRequest
google.cloud.aiplatform_v1beta1.types.GetNasTrialDetailRequest
GetNasTrialDetailRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.GetNasTrialDetail.
See more: google.cloud.aiplatform_v1beta1.types.GetNasTrialDetailRequest
google.cloud.aiplatform_v1beta1.types.GetNotebookRuntimeRequest
GetNotebookRuntimeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for NotebookService.GetNotebookRuntime .
See more: google.cloud.aiplatform_v1beta1.types.GetNotebookRuntimeRequest
google.cloud.aiplatform_v1beta1.types.GetNotebookRuntimeTemplateRequest
GetNotebookRuntimeTemplateRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.GetNotebookRuntimeTemplate .
See more: google.cloud.aiplatform_v1beta1.types.GetNotebookRuntimeTemplateRequest
google.cloud.aiplatform_v1beta1.types.GetPersistentResourceRequest
GetPersistentResourceRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PersistentResourceService.GetPersistentResource.
See more: google.cloud.aiplatform_v1beta1.types.GetPersistentResourceRequest
google.cloud.aiplatform_v1beta1.types.GetPipelineJobRequest
GetPipelineJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PipelineService.GetPipelineJob.
See more: google.cloud.aiplatform_v1beta1.types.GetPipelineJobRequest
google.cloud.aiplatform_v1beta1.types.GetPublisherModelRequest
GetPublisherModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelGardenService.GetPublisherModel .
See more: google.cloud.aiplatform_v1beta1.types.GetPublisherModelRequest
google.cloud.aiplatform_v1beta1.types.GetRagCorpusRequest
GetRagCorpusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VertexRagDataService.GetRagCorpus .
See more: google.cloud.aiplatform_v1beta1.types.GetRagCorpusRequest
google.cloud.aiplatform_v1beta1.types.GetRagFileRequest
GetRagFileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VertexRagDataService.GetRagFile .
See more: google.cloud.aiplatform_v1beta1.types.GetRagFileRequest
google.cloud.aiplatform_v1beta1.types.GetReasoningEngineRequest
GetReasoningEngineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ReasoningEngineService.GetReasoningEngine.
See more: google.cloud.aiplatform_v1beta1.types.GetReasoningEngineRequest
google.cloud.aiplatform_v1beta1.types.GetScheduleRequest
GetScheduleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.GetSchedule.
See more: google.cloud.aiplatform_v1beta1.types.GetScheduleRequest
google.cloud.aiplatform_v1beta1.types.GetSpecialistPoolRequest
GetSpecialistPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for SpecialistPoolService.GetSpecialistPool.
See more: google.cloud.aiplatform_v1beta1.types.GetSpecialistPoolRequest
google.cloud.aiplatform_v1beta1.types.GetStudyRequest
GetStudyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.GetStudy.
See more: google.cloud.aiplatform_v1beta1.types.GetStudyRequest
google.cloud.aiplatform_v1beta1.types.GetTensorboardExperimentRequest
GetTensorboardExperimentRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.GetTensorboardExperiment.
See more: google.cloud.aiplatform_v1beta1.types.GetTensorboardExperimentRequest
google.cloud.aiplatform_v1beta1.types.GetTensorboardRequest
GetTensorboardRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.GetTensorboard.
See more: google.cloud.aiplatform_v1beta1.types.GetTensorboardRequest
google.cloud.aiplatform_v1beta1.types.GetTensorboardRunRequest
GetTensorboardRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.GetTensorboardRun.
See more: google.cloud.aiplatform_v1beta1.types.GetTensorboardRunRequest
google.cloud.aiplatform_v1beta1.types.GetTensorboardTimeSeriesRequest
GetTensorboardTimeSeriesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.GetTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1beta1.types.GetTensorboardTimeSeriesRequest
google.cloud.aiplatform_v1beta1.types.GetTrainingPipelineRequest
GetTrainingPipelineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PipelineService.GetTrainingPipeline.
See more: google.cloud.aiplatform_v1beta1.types.GetTrainingPipelineRequest
google.cloud.aiplatform_v1beta1.types.GetTrialRequest
GetTrialRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.GetTrial.
See more: google.cloud.aiplatform_v1beta1.types.GetTrialRequest
google.cloud.aiplatform_v1beta1.types.GoogleDriveSource
GoogleDriveSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The Google Drive location for the input content.
See more: google.cloud.aiplatform_v1beta1.types.GoogleDriveSource
google.cloud.aiplatform_v1beta1.types.GoogleDriveSource.ResourceId
ResourceId(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The type and ID of the Google Drive resource.
See more: google.cloud.aiplatform_v1beta1.types.GoogleDriveSource.ResourceId
google.cloud.aiplatform_v1beta1.types.GoogleDriveSource.ResourceId.ResourceType
ResourceType(value)
The type of the Google Drive resource.
See more: google.cloud.aiplatform_v1beta1.types.GoogleDriveSource.ResourceId.ResourceType
google.cloud.aiplatform_v1beta1.types.GoogleSearchRetrieval
GoogleSearchRetrieval(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tool to retrieve public web data for grounding, powered by Google.
See more: google.cloud.aiplatform_v1beta1.types.GoogleSearchRetrieval
google.cloud.aiplatform_v1beta1.types.GroundednessInput
GroundednessInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for groundedness metric.
See more: google.cloud.aiplatform_v1beta1.types.GroundednessInput
google.cloud.aiplatform_v1beta1.types.GroundednessInstance
GroundednessInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for groundedness instance.
See more: google.cloud.aiplatform_v1beta1.types.GroundednessInstance
google.cloud.aiplatform_v1beta1.types.GroundednessResult
GroundednessResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for groundedness result.
See more: google.cloud.aiplatform_v1beta1.types.GroundednessResult
google.cloud.aiplatform_v1beta1.types.GroundednessSpec
GroundednessSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for groundedness metric.
See more: google.cloud.aiplatform_v1beta1.types.GroundednessSpec
google.cloud.aiplatform_v1beta1.types.GroundingAttribution
GroundingAttribution(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Grounding attribution.
See more: google.cloud.aiplatform_v1beta1.types.GroundingAttribution
google.cloud.aiplatform_v1beta1.types.GroundingAttribution.RetrievedContext
RetrievedContext(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Attribution from context retrieved by the retrieval tools.
See more: google.cloud.aiplatform_v1beta1.types.GroundingAttribution.RetrievedContext
google.cloud.aiplatform_v1beta1.types.GroundingAttribution.Web
Web(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Attribution from the web.
See more: google.cloud.aiplatform_v1beta1.types.GroundingAttribution.Web
google.cloud.aiplatform_v1beta1.types.GroundingMetadata
GroundingMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata returned to client when grounding is enabled.
See more: google.cloud.aiplatform_v1beta1.types.GroundingMetadata
google.cloud.aiplatform_v1beta1.types.HarmCategory
HarmCategory(value)
Harm categories that will block the content.
See more: google.cloud.aiplatform_v1beta1.types.HarmCategory
google.cloud.aiplatform_v1beta1.types.HttpElementLocation
HttpElementLocation(value)
Enum of location an HTTP element can be.
See more: google.cloud.aiplatform_v1beta1.types.HttpElementLocation
google.cloud.aiplatform_v1beta1.types.HyperparameterTuningJob
HyperparameterTuningJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a HyperparameterTuningJob.
See more: google.cloud.aiplatform_v1beta1.types.HyperparameterTuningJob
google.cloud.aiplatform_v1beta1.types.HyperparameterTuningJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.HyperparameterTuningJob.LabelsEntry
google.cloud.aiplatform_v1beta1.types.IdMatcher
IdMatcher(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Matcher for Features of an EntityType by Feature ID.
google.cloud.aiplatform_v1beta1.types.ImportDataConfig
ImportDataConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes the location from where we import data into a Dataset, together with the labels that will be applied to the DataItems and the Annotations.
See more: google.cloud.aiplatform_v1beta1.types.ImportDataConfig
google.cloud.aiplatform_v1beta1.types.ImportDataConfig.AnnotationLabelsEntry
AnnotationLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.ImportDataConfig.AnnotationLabelsEntry
google.cloud.aiplatform_v1beta1.types.ImportDataConfig.DataItemLabelsEntry
DataItemLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.ImportDataConfig.DataItemLabelsEntry
google.cloud.aiplatform_v1beta1.types.ImportDataOperationMetadata
ImportDataOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Runtime operation information for DatasetService.ImportData.
See more: google.cloud.aiplatform_v1beta1.types.ImportDataOperationMetadata
google.cloud.aiplatform_v1beta1.types.ImportDataRequest
ImportDataRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ImportData.
See more: google.cloud.aiplatform_v1beta1.types.ImportDataRequest
google.cloud.aiplatform_v1beta1.types.ImportDataResponse
ImportDataResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ImportData.
See more: google.cloud.aiplatform_v1beta1.types.ImportDataResponse
google.cloud.aiplatform_v1beta1.types.ImportExtensionOperationMetadata
ImportExtensionOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of ExtensionRegistryService.ImportExtension operation.
See more: google.cloud.aiplatform_v1beta1.types.ImportExtensionOperationMetadata
google.cloud.aiplatform_v1beta1.types.ImportExtensionRequest
ImportExtensionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ExtensionRegistryService.ImportExtension.
See more: google.cloud.aiplatform_v1beta1.types.ImportExtensionRequest
google.cloud.aiplatform_v1beta1.types.ImportFeatureValuesOperationMetadata
ImportFeatureValuesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform import Feature values.
See more: google.cloud.aiplatform_v1beta1.types.ImportFeatureValuesOperationMetadata
google.cloud.aiplatform_v1beta1.types.ImportFeatureValuesRequest
ImportFeatureValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.ImportFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.ImportFeatureValuesRequest
google.cloud.aiplatform_v1beta1.types.ImportFeatureValuesRequest.FeatureSpec
FeatureSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Defines the Feature value(s) to import.
See more: google.cloud.aiplatform_v1beta1.types.ImportFeatureValuesRequest.FeatureSpec
google.cloud.aiplatform_v1beta1.types.ImportFeatureValuesResponse
ImportFeatureValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.ImportFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.ImportFeatureValuesResponse
google.cloud.aiplatform_v1beta1.types.ImportModelEvaluationRequest
ImportModelEvaluationRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ModelService.ImportModelEvaluation .
See more: google.cloud.aiplatform_v1beta1.types.ImportModelEvaluationRequest
google.cloud.aiplatform_v1beta1.types.ImportRagFilesConfig
ImportRagFilesConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for importing RagFiles.
See more: google.cloud.aiplatform_v1beta1.types.ImportRagFilesConfig
google.cloud.aiplatform_v1beta1.types.ImportRagFilesOperationMetadata
ImportRagFilesOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for VertexRagDataService.ImportRagFiles.
See more: google.cloud.aiplatform_v1beta1.types.ImportRagFilesOperationMetadata
google.cloud.aiplatform_v1beta1.types.ImportRagFilesRequest
ImportRagFilesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VertexRagDataService.ImportRagFiles.
See more: google.cloud.aiplatform_v1beta1.types.ImportRagFilesRequest
google.cloud.aiplatform_v1beta1.types.ImportRagFilesResponse
ImportRagFilesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VertexRagDataService.ImportRagFiles.
See more: google.cloud.aiplatform_v1beta1.types.ImportRagFilesResponse
google.cloud.aiplatform_v1beta1.types.Index
Index(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.
google.cloud.aiplatform_v1beta1.types.Index.IndexUpdateMethod
IndexUpdateMethod(value)
The update method of an Index.
See more: google.cloud.aiplatform_v1beta1.types.Index.IndexUpdateMethod
google.cloud.aiplatform_v1beta1.types.Index.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Index.LabelsEntry
google.cloud.aiplatform_v1beta1.types.IndexDatapoint
IndexDatapoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A datapoint of Index.
See more: google.cloud.aiplatform_v1beta1.types.IndexDatapoint
google.cloud.aiplatform_v1beta1.types.IndexDatapoint.CrowdingTag
CrowdingTag(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Crowding tag is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute.
See more: google.cloud.aiplatform_v1beta1.types.IndexDatapoint.CrowdingTag
google.cloud.aiplatform_v1beta1.types.IndexDatapoint.NumericRestriction
NumericRestriction(mapping=None, *, ignore_unknown_fields=False, **kwargs)
This field allows restricts to be based on numeric comparisons rather than categorical tokens.
See more: google.cloud.aiplatform_v1beta1.types.IndexDatapoint.NumericRestriction
google.cloud.aiplatform_v1beta1.types.IndexDatapoint.NumericRestriction.Operator
Operator(value)
Which comparison operator to use.
See more: google.cloud.aiplatform_v1beta1.types.IndexDatapoint.NumericRestriction.Operator
google.cloud.aiplatform_v1beta1.types.IndexDatapoint.Restriction
Restriction(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Restriction of a datapoint which describe its attributes(tokens) from each of several attribute categories(namespaces).
See more: google.cloud.aiplatform_v1beta1.types.IndexDatapoint.Restriction
google.cloud.aiplatform_v1beta1.types.IndexEndpoint
IndexEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Indexes are deployed into it.
See more: google.cloud.aiplatform_v1beta1.types.IndexEndpoint
google.cloud.aiplatform_v1beta1.types.IndexEndpoint.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.IndexEndpoint.LabelsEntry
google.cloud.aiplatform_v1beta1.types.IndexPrivateEndpoints
IndexPrivateEndpoints(mapping=None, *, ignore_unknown_fields=False, **kwargs)
IndexPrivateEndpoints proto is used to provide paths for users to send requests via private endpoints (e.g.
See more: google.cloud.aiplatform_v1beta1.types.IndexPrivateEndpoints
google.cloud.aiplatform_v1beta1.types.IndexStats
IndexStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Stats of the Index.
google.cloud.aiplatform_v1beta1.types.InputDataConfig
InputDataConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model.
See more: google.cloud.aiplatform_v1beta1.types.InputDataConfig
google.cloud.aiplatform_v1beta1.types.Int64Array
Int64Array(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of int64 values.
google.cloud.aiplatform_v1beta1.types.IntegratedGradientsAttribution
IntegratedGradientsAttribution(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure.
See more: google.cloud.aiplatform_v1beta1.types.IntegratedGradientsAttribution
google.cloud.aiplatform_v1beta1.types.JobState
JobState(value)
Describes the state of a job.
google.cloud.aiplatform_v1beta1.types.LargeModelReference
LargeModelReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains information about the Large Model.
See more: google.cloud.aiplatform_v1beta1.types.LargeModelReference
google.cloud.aiplatform_v1beta1.types.LineageSubgraph
LineageSubgraph(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A subgraph of the overall lineage graph.
See more: google.cloud.aiplatform_v1beta1.types.LineageSubgraph
google.cloud.aiplatform_v1beta1.types.ListAnnotationsRequest
ListAnnotationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ListAnnotations.
See more: google.cloud.aiplatform_v1beta1.types.ListAnnotationsRequest
google.cloud.aiplatform_v1beta1.types.ListAnnotationsResponse
ListAnnotationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ListAnnotations.
See more: google.cloud.aiplatform_v1beta1.types.ListAnnotationsResponse
google.cloud.aiplatform_v1beta1.types.ListArtifactsRequest
ListArtifactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.ListArtifacts.
See more: google.cloud.aiplatform_v1beta1.types.ListArtifactsRequest
google.cloud.aiplatform_v1beta1.types.ListArtifactsResponse
ListArtifactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.ListArtifacts.
See more: google.cloud.aiplatform_v1beta1.types.ListArtifactsResponse
google.cloud.aiplatform_v1beta1.types.ListBatchPredictionJobsRequest
ListBatchPredictionJobsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.ListBatchPredictionJobs.
See more: google.cloud.aiplatform_v1beta1.types.ListBatchPredictionJobsRequest
google.cloud.aiplatform_v1beta1.types.ListBatchPredictionJobsResponse
ListBatchPredictionJobsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for JobService.ListBatchPredictionJobs .
See more: google.cloud.aiplatform_v1beta1.types.ListBatchPredictionJobsResponse
google.cloud.aiplatform_v1beta1.types.ListContextsRequest
ListContextsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.ListContexts .
See more: google.cloud.aiplatform_v1beta1.types.ListContextsRequest
google.cloud.aiplatform_v1beta1.types.ListContextsResponse
ListContextsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.ListContexts.
See more: google.cloud.aiplatform_v1beta1.types.ListContextsResponse
google.cloud.aiplatform_v1beta1.types.ListCustomJobsRequest
ListCustomJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.ListCustomJobs.
See more: google.cloud.aiplatform_v1beta1.types.ListCustomJobsRequest
google.cloud.aiplatform_v1beta1.types.ListCustomJobsResponse
ListCustomJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for JobService.ListCustomJobs .
See more: google.cloud.aiplatform_v1beta1.types.ListCustomJobsResponse
google.cloud.aiplatform_v1beta1.types.ListDataItemsRequest
ListDataItemsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ListDataItems.
See more: google.cloud.aiplatform_v1beta1.types.ListDataItemsRequest
google.cloud.aiplatform_v1beta1.types.ListDataItemsResponse
ListDataItemsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ListDataItems.
See more: google.cloud.aiplatform_v1beta1.types.ListDataItemsResponse
google.cloud.aiplatform_v1beta1.types.ListDataLabelingJobsRequest
ListDataLabelingJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.ListDataLabelingJobs.
See more: google.cloud.aiplatform_v1beta1.types.ListDataLabelingJobsRequest
google.cloud.aiplatform_v1beta1.types.ListDataLabelingJobsResponse
ListDataLabelingJobsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for JobService.ListDataLabelingJobs.
See more: google.cloud.aiplatform_v1beta1.types.ListDataLabelingJobsResponse
google.cloud.aiplatform_v1beta1.types.ListDatasetVersionsRequest
ListDatasetVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ListDatasetVersions.
See more: google.cloud.aiplatform_v1beta1.types.ListDatasetVersionsRequest
google.cloud.aiplatform_v1beta1.types.ListDatasetVersionsResponse
ListDatasetVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ListDatasetVersions.
See more: google.cloud.aiplatform_v1beta1.types.ListDatasetVersionsResponse
google.cloud.aiplatform_v1beta1.types.ListDatasetsRequest
ListDatasetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ListDatasets.
See more: google.cloud.aiplatform_v1beta1.types.ListDatasetsRequest
google.cloud.aiplatform_v1beta1.types.ListDatasetsResponse
ListDatasetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ListDatasets.
See more: google.cloud.aiplatform_v1beta1.types.ListDatasetsResponse
google.cloud.aiplatform_v1beta1.types.ListDeploymentResourcePoolsRequest
ListDeploymentResourcePoolsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ListDeploymentResourcePools method.
See more: google.cloud.aiplatform_v1beta1.types.ListDeploymentResourcePoolsRequest
google.cloud.aiplatform_v1beta1.types.ListDeploymentResourcePoolsResponse
ListDeploymentResourcePoolsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for ListDeploymentResourcePools method.
See more: google.cloud.aiplatform_v1beta1.types.ListDeploymentResourcePoolsResponse
google.cloud.aiplatform_v1beta1.types.ListEndpointsRequest
ListEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.ListEndpoints.
See more: google.cloud.aiplatform_v1beta1.types.ListEndpointsRequest
google.cloud.aiplatform_v1beta1.types.ListEndpointsResponse
ListEndpointsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for EndpointService.ListEndpoints.
See more: google.cloud.aiplatform_v1beta1.types.ListEndpointsResponse
google.cloud.aiplatform_v1beta1.types.ListEntityTypesRequest
ListEntityTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.ListEntityTypes.
See more: google.cloud.aiplatform_v1beta1.types.ListEntityTypesRequest
google.cloud.aiplatform_v1beta1.types.ListEntityTypesResponse
ListEntityTypesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.ListEntityTypes.
See more: google.cloud.aiplatform_v1beta1.types.ListEntityTypesResponse
google.cloud.aiplatform_v1beta1.types.ListExecutionsRequest
ListExecutionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.ListExecutions.
See more: google.cloud.aiplatform_v1beta1.types.ListExecutionsRequest
google.cloud.aiplatform_v1beta1.types.ListExecutionsResponse
ListExecutionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.ListExecutions.
See more: google.cloud.aiplatform_v1beta1.types.ListExecutionsResponse
google.cloud.aiplatform_v1beta1.types.ListExtensionsRequest
ListExtensionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ExtensionRegistryService.ListExtensions.
See more: google.cloud.aiplatform_v1beta1.types.ListExtensionsRequest
google.cloud.aiplatform_v1beta1.types.ListExtensionsResponse
ListExtensionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for ExtensionRegistryService.ListExtensions .
See more: google.cloud.aiplatform_v1beta1.types.ListExtensionsResponse
google.cloud.aiplatform_v1beta1.types.ListFeatureGroupsRequest
ListFeatureGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureRegistryService.ListFeatureGroups.
See more: google.cloud.aiplatform_v1beta1.types.ListFeatureGroupsRequest
google.cloud.aiplatform_v1beta1.types.ListFeatureGroupsResponse
ListFeatureGroupsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeatureRegistryService.ListFeatureGroups.
See more: google.cloud.aiplatform_v1beta1.types.ListFeatureGroupsResponse
google.cloud.aiplatform_v1beta1.types.ListFeatureOnlineStoresRequest
ListFeatureOnlineStoresRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeatureOnlineStoreAdminService.ListFeatureOnlineStores.
See more: google.cloud.aiplatform_v1beta1.types.ListFeatureOnlineStoresRequest
google.cloud.aiplatform_v1beta1.types.ListFeatureOnlineStoresResponse
ListFeatureOnlineStoresResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for FeatureOnlineStoreAdminService.ListFeatureOnlineStores.
See more: google.cloud.aiplatform_v1beta1.types.ListFeatureOnlineStoresResponse
google.cloud.aiplatform_v1beta1.types.ListFeatureViewSyncsRequest
ListFeatureViewSyncsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.ListFeatureViewSyncs.
See more: google.cloud.aiplatform_v1beta1.types.ListFeatureViewSyncsRequest
google.cloud.aiplatform_v1beta1.types.ListFeatureViewSyncsResponse
ListFeatureViewSyncsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for FeatureOnlineStoreAdminService.ListFeatureViewSyncs.
See more: google.cloud.aiplatform_v1beta1.types.ListFeatureViewSyncsResponse
google.cloud.aiplatform_v1beta1.types.ListFeatureViewsRequest
ListFeatureViewsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.ListFeatureViews.
See more: google.cloud.aiplatform_v1beta1.types.ListFeatureViewsRequest
google.cloud.aiplatform_v1beta1.types.ListFeatureViewsResponse
ListFeatureViewsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeatureOnlineStoreAdminService.ListFeatureViews.
See more: google.cloud.aiplatform_v1beta1.types.ListFeatureViewsResponse
google.cloud.aiplatform_v1beta1.types.ListFeaturesRequest
ListFeaturesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.ListFeatures.
See more: google.cloud.aiplatform_v1beta1.types.ListFeaturesRequest
google.cloud.aiplatform_v1beta1.types.ListFeaturesResponse
ListFeaturesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.ListFeatures.
See more: google.cloud.aiplatform_v1beta1.types.ListFeaturesResponse
google.cloud.aiplatform_v1beta1.types.ListFeaturestoresRequest
ListFeaturestoresRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.ListFeaturestores.
See more: google.cloud.aiplatform_v1beta1.types.ListFeaturestoresRequest
google.cloud.aiplatform_v1beta1.types.ListFeaturestoresResponse
ListFeaturestoresResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.ListFeaturestores.
See more: google.cloud.aiplatform_v1beta1.types.ListFeaturestoresResponse
google.cloud.aiplatform_v1beta1.types.ListHyperparameterTuningJobsRequest
ListHyperparameterTuningJobsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.ListHyperparameterTuningJobs.
See more: google.cloud.aiplatform_v1beta1.types.ListHyperparameterTuningJobsRequest
google.cloud.aiplatform_v1beta1.types.ListHyperparameterTuningJobsResponse
ListHyperparameterTuningJobsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for JobService.ListHyperparameterTuningJobs .
See more: google.cloud.aiplatform_v1beta1.types.ListHyperparameterTuningJobsResponse
google.cloud.aiplatform_v1beta1.types.ListIndexEndpointsRequest
ListIndexEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.ListIndexEndpoints.
See more: google.cloud.aiplatform_v1beta1.types.ListIndexEndpointsRequest
google.cloud.aiplatform_v1beta1.types.ListIndexEndpointsResponse
ListIndexEndpointsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexEndpointService.ListIndexEndpoints.
See more: google.cloud.aiplatform_v1beta1.types.ListIndexEndpointsResponse
google.cloud.aiplatform_v1beta1.types.ListIndexesRequest
ListIndexesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.ListIndexes.
See more: google.cloud.aiplatform_v1beta1.types.ListIndexesRequest
google.cloud.aiplatform_v1beta1.types.ListIndexesResponse
ListIndexesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexService.ListIndexes.
See more: google.cloud.aiplatform_v1beta1.types.ListIndexesResponse
google.cloud.aiplatform_v1beta1.types.ListMetadataSchemasRequest
ListMetadataSchemasRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.ListMetadataSchemas.
See more: google.cloud.aiplatform_v1beta1.types.ListMetadataSchemasRequest
google.cloud.aiplatform_v1beta1.types.ListMetadataSchemasResponse
ListMetadataSchemasResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.ListMetadataSchemas.
See more: google.cloud.aiplatform_v1beta1.types.ListMetadataSchemasResponse
google.cloud.aiplatform_v1beta1.types.ListMetadataStoresRequest
ListMetadataStoresRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.ListMetadataStores.
See more: google.cloud.aiplatform_v1beta1.types.ListMetadataStoresRequest
google.cloud.aiplatform_v1beta1.types.ListMetadataStoresResponse
ListMetadataStoresResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.ListMetadataStores.
See more: google.cloud.aiplatform_v1beta1.types.ListMetadataStoresResponse
google.cloud.aiplatform_v1beta1.types.ListModelDeploymentMonitoringJobsRequest
ListModelDeploymentMonitoringJobsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.ListModelDeploymentMonitoringJobs.
See more: google.cloud.aiplatform_v1beta1.types.ListModelDeploymentMonitoringJobsRequest
google.cloud.aiplatform_v1beta1.types.ListModelDeploymentMonitoringJobsResponse
ListModelDeploymentMonitoringJobsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for JobService.ListModelDeploymentMonitoringJobs.
See more: google.cloud.aiplatform_v1beta1.types.ListModelDeploymentMonitoringJobsResponse
google.cloud.aiplatform_v1beta1.types.ListModelEvaluationSlicesRequest
ListModelEvaluationSlicesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ModelService.ListModelEvaluationSlices.
See more: google.cloud.aiplatform_v1beta1.types.ListModelEvaluationSlicesRequest
google.cloud.aiplatform_v1beta1.types.ListModelEvaluationSlicesResponse
ListModelEvaluationSlicesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for ModelService.ListModelEvaluationSlices.
See more: google.cloud.aiplatform_v1beta1.types.ListModelEvaluationSlicesResponse
google.cloud.aiplatform_v1beta1.types.ListModelEvaluationsRequest
ListModelEvaluationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.ListModelEvaluations.
See more: google.cloud.aiplatform_v1beta1.types.ListModelEvaluationsRequest
google.cloud.aiplatform_v1beta1.types.ListModelEvaluationsResponse
ListModelEvaluationsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for ModelService.ListModelEvaluations.
See more: google.cloud.aiplatform_v1beta1.types.ListModelEvaluationsResponse
google.cloud.aiplatform_v1beta1.types.ListModelVersionsRequest
ListModelVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.ListModelVersions.
See more: google.cloud.aiplatform_v1beta1.types.ListModelVersionsRequest
google.cloud.aiplatform_v1beta1.types.ListModelVersionsResponse
ListModelVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for ModelService.ListModelVersions .
See more: google.cloud.aiplatform_v1beta1.types.ListModelVersionsResponse
google.cloud.aiplatform_v1beta1.types.ListModelsRequest
ListModelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.ListModels.
See more: google.cloud.aiplatform_v1beta1.types.ListModelsRequest
google.cloud.aiplatform_v1beta1.types.ListModelsResponse
ListModelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for ModelService.ListModels .
See more: google.cloud.aiplatform_v1beta1.types.ListModelsResponse
google.cloud.aiplatform_v1beta1.types.ListNasJobsRequest
ListNasJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.ListNasJobs.
See more: google.cloud.aiplatform_v1beta1.types.ListNasJobsRequest
google.cloud.aiplatform_v1beta1.types.ListNasJobsResponse
ListNasJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for JobService.ListNasJobs .
See more: google.cloud.aiplatform_v1beta1.types.ListNasJobsResponse
google.cloud.aiplatform_v1beta1.types.ListNasTrialDetailsRequest
ListNasTrialDetailsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for JobService.ListNasTrialDetails.
See more: google.cloud.aiplatform_v1beta1.types.ListNasTrialDetailsRequest
google.cloud.aiplatform_v1beta1.types.ListNasTrialDetailsResponse
ListNasTrialDetailsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for JobService.ListNasTrialDetails .
See more: google.cloud.aiplatform_v1beta1.types.ListNasTrialDetailsResponse
google.cloud.aiplatform_v1beta1.types.ListNotebookRuntimeTemplatesRequest
ListNotebookRuntimeTemplatesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.ListNotebookRuntimeTemplates.
See more: google.cloud.aiplatform_v1beta1.types.ListNotebookRuntimeTemplatesRequest
google.cloud.aiplatform_v1beta1.types.ListNotebookRuntimeTemplatesResponse
ListNotebookRuntimeTemplatesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for NotebookService.ListNotebookRuntimeTemplates.
See more: google.cloud.aiplatform_v1beta1.types.ListNotebookRuntimeTemplatesResponse
google.cloud.aiplatform_v1beta1.types.ListNotebookRuntimesRequest
ListNotebookRuntimesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for NotebookService.ListNotebookRuntimes.
See more: google.cloud.aiplatform_v1beta1.types.ListNotebookRuntimesRequest
google.cloud.aiplatform_v1beta1.types.ListNotebookRuntimesResponse
ListNotebookRuntimesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for NotebookService.ListNotebookRuntimes.
See more: google.cloud.aiplatform_v1beta1.types.ListNotebookRuntimesResponse
google.cloud.aiplatform_v1beta1.types.ListOptimalTrialsRequest
ListOptimalTrialsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.ListOptimalTrials.
See more: google.cloud.aiplatform_v1beta1.types.ListOptimalTrialsRequest
google.cloud.aiplatform_v1beta1.types.ListOptimalTrialsResponse
ListOptimalTrialsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VizierService.ListOptimalTrials.
See more: google.cloud.aiplatform_v1beta1.types.ListOptimalTrialsResponse
google.cloud.aiplatform_v1beta1.types.ListPersistentResourcesRequest
ListPersistentResourcesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for [PersistentResourceService.ListPersistentResource][].
See more: google.cloud.aiplatform_v1beta1.types.ListPersistentResourcesRequest
google.cloud.aiplatform_v1beta1.types.ListPersistentResourcesResponse
ListPersistentResourcesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for PersistentResourceService.ListPersistentResources .
See more: google.cloud.aiplatform_v1beta1.types.ListPersistentResourcesResponse
google.cloud.aiplatform_v1beta1.types.ListPipelineJobsRequest
ListPipelineJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PipelineService.ListPipelineJobs.
See more: google.cloud.aiplatform_v1beta1.types.ListPipelineJobsRequest
google.cloud.aiplatform_v1beta1.types.ListPipelineJobsResponse
ListPipelineJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PipelineService.ListPipelineJobs .
See more: google.cloud.aiplatform_v1beta1.types.ListPipelineJobsResponse
google.cloud.aiplatform_v1beta1.types.ListPublisherModelsRequest
ListPublisherModelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelGardenService.ListPublisherModels.
See more: google.cloud.aiplatform_v1beta1.types.ListPublisherModelsRequest
google.cloud.aiplatform_v1beta1.types.ListPublisherModelsResponse
ListPublisherModelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for ModelGardenService.ListPublisherModels.
See more: google.cloud.aiplatform_v1beta1.types.ListPublisherModelsResponse
google.cloud.aiplatform_v1beta1.types.ListRagCorporaRequest
ListRagCorporaRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VertexRagDataService.ListRagCorpora.
See more: google.cloud.aiplatform_v1beta1.types.ListRagCorporaRequest
google.cloud.aiplatform_v1beta1.types.ListRagCorporaResponse
ListRagCorporaResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VertexRagDataService.ListRagCorpora.
See more: google.cloud.aiplatform_v1beta1.types.ListRagCorporaResponse
google.cloud.aiplatform_v1beta1.types.ListRagFilesRequest
ListRagFilesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VertexRagDataService.ListRagFiles.
See more: google.cloud.aiplatform_v1beta1.types.ListRagFilesRequest
google.cloud.aiplatform_v1beta1.types.ListRagFilesResponse
ListRagFilesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VertexRagDataService.ListRagFiles.
See more: google.cloud.aiplatform_v1beta1.types.ListRagFilesResponse
google.cloud.aiplatform_v1beta1.types.ListReasoningEnginesRequest
ListReasoningEnginesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ReasoningEngineService.ListReasoningEngines.
See more: google.cloud.aiplatform_v1beta1.types.ListReasoningEnginesRequest
google.cloud.aiplatform_v1beta1.types.ListReasoningEnginesResponse
ListReasoningEnginesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for ReasoningEngineService.ListReasoningEngines .
See more: google.cloud.aiplatform_v1beta1.types.ListReasoningEnginesResponse
google.cloud.aiplatform_v1beta1.types.ListSavedQueriesRequest
ListSavedQueriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.ListSavedQueries.
See more: google.cloud.aiplatform_v1beta1.types.ListSavedQueriesRequest
google.cloud.aiplatform_v1beta1.types.ListSavedQueriesResponse
ListSavedQueriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.ListSavedQueries.
See more: google.cloud.aiplatform_v1beta1.types.ListSavedQueriesResponse
google.cloud.aiplatform_v1beta1.types.ListSchedulesRequest
ListSchedulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.ListSchedules.
See more: google.cloud.aiplatform_v1beta1.types.ListSchedulesRequest
google.cloud.aiplatform_v1beta1.types.ListSchedulesResponse
ListSchedulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for ScheduleService.ListSchedules .
See more: google.cloud.aiplatform_v1beta1.types.ListSchedulesResponse
google.cloud.aiplatform_v1beta1.types.ListSpecialistPoolsRequest
ListSpecialistPoolsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for SpecialistPoolService.ListSpecialistPools.
See more: google.cloud.aiplatform_v1beta1.types.ListSpecialistPoolsRequest
google.cloud.aiplatform_v1beta1.types.ListSpecialistPoolsResponse
ListSpecialistPoolsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for SpecialistPoolService.ListSpecialistPools.
See more: google.cloud.aiplatform_v1beta1.types.ListSpecialistPoolsResponse
google.cloud.aiplatform_v1beta1.types.ListStudiesRequest
ListStudiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.ListStudies.
See more: google.cloud.aiplatform_v1beta1.types.ListStudiesRequest
google.cloud.aiplatform_v1beta1.types.ListStudiesResponse
ListStudiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VizierService.ListStudies.
See more: google.cloud.aiplatform_v1beta1.types.ListStudiesResponse
google.cloud.aiplatform_v1beta1.types.ListTensorboardExperimentsRequest
ListTensorboardExperimentsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.ListTensorboardExperiments.
See more: google.cloud.aiplatform_v1beta1.types.ListTensorboardExperimentsRequest
google.cloud.aiplatform_v1beta1.types.ListTensorboardExperimentsResponse
ListTensorboardExperimentsResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.ListTensorboardExperiments.
See more: google.cloud.aiplatform_v1beta1.types.ListTensorboardExperimentsResponse
google.cloud.aiplatform_v1beta1.types.ListTensorboardRunsRequest
ListTensorboardRunsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.ListTensorboardRuns.
See more: google.cloud.aiplatform_v1beta1.types.ListTensorboardRunsRequest
google.cloud.aiplatform_v1beta1.types.ListTensorboardRunsResponse
ListTensorboardRunsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for TensorboardService.ListTensorboardRuns.
See more: google.cloud.aiplatform_v1beta1.types.ListTensorboardRunsResponse
google.cloud.aiplatform_v1beta1.types.ListTensorboardTimeSeriesRequest
ListTensorboardTimeSeriesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.ListTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1beta1.types.ListTensorboardTimeSeriesRequest
google.cloud.aiplatform_v1beta1.types.ListTensorboardTimeSeriesResponse
ListTensorboardTimeSeriesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.ListTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1beta1.types.ListTensorboardTimeSeriesResponse
google.cloud.aiplatform_v1beta1.types.ListTensorboardsRequest
ListTensorboardsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.ListTensorboards.
See more: google.cloud.aiplatform_v1beta1.types.ListTensorboardsRequest
google.cloud.aiplatform_v1beta1.types.ListTensorboardsResponse
ListTensorboardsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for TensorboardService.ListTensorboards.
See more: google.cloud.aiplatform_v1beta1.types.ListTensorboardsResponse
google.cloud.aiplatform_v1beta1.types.ListTrainingPipelinesRequest
ListTrainingPipelinesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PipelineService.ListTrainingPipelines.
See more: google.cloud.aiplatform_v1beta1.types.ListTrainingPipelinesRequest
google.cloud.aiplatform_v1beta1.types.ListTrainingPipelinesResponse
ListTrainingPipelinesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for PipelineService.ListTrainingPipelines .
See more: google.cloud.aiplatform_v1beta1.types.ListTrainingPipelinesResponse
google.cloud.aiplatform_v1beta1.types.ListTrialsRequest
ListTrialsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.ListTrials.
See more: google.cloud.aiplatform_v1beta1.types.ListTrialsRequest
google.cloud.aiplatform_v1beta1.types.ListTrialsResponse
ListTrialsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VizierService.ListTrials.
See more: google.cloud.aiplatform_v1beta1.types.ListTrialsResponse
google.cloud.aiplatform_v1beta1.types.LookupStudyRequest
LookupStudyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.LookupStudy.
See more: google.cloud.aiplatform_v1beta1.types.LookupStudyRequest
google.cloud.aiplatform_v1beta1.types.MachineSpec
MachineSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specification of a single machine.
google.cloud.aiplatform_v1beta1.types.ManualBatchTuningParameters
ManualBatchTuningParameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Manual batch tuning parameters.
See more: google.cloud.aiplatform_v1beta1.types.ManualBatchTuningParameters
google.cloud.aiplatform_v1beta1.types.Measurement
Measurement(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A message representing a Measurement of a Trial.
google.cloud.aiplatform_v1beta1.types.Measurement.Metric
Metric(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A message representing a metric in the measurement.
See more: google.cloud.aiplatform_v1beta1.types.Measurement.Metric
google.cloud.aiplatform_v1beta1.types.MergeVersionAliasesRequest
MergeVersionAliasesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.MergeVersionAliases.
See more: google.cloud.aiplatform_v1beta1.types.MergeVersionAliasesRequest
google.cloud.aiplatform_v1beta1.types.MetadataSchema
MetadataSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Instance of a general MetadataSchema.
See more: google.cloud.aiplatform_v1beta1.types.MetadataSchema
google.cloud.aiplatform_v1beta1.types.MetadataSchema.MetadataSchemaType
MetadataSchemaType(value)
Describes the type of the MetadataSchema.
See more: google.cloud.aiplatform_v1beta1.types.MetadataSchema.MetadataSchemaType
google.cloud.aiplatform_v1beta1.types.MetadataStore
MetadataStore(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Instance of a metadata store.
See more: google.cloud.aiplatform_v1beta1.types.MetadataStore
google.cloud.aiplatform_v1beta1.types.MetadataStore.MetadataStoreState
MetadataStoreState(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents state information for a MetadataStore.
See more: google.cloud.aiplatform_v1beta1.types.MetadataStore.MetadataStoreState
google.cloud.aiplatform_v1beta1.types.MigratableResource
MigratableResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents one resource that exists in automl.googleapis.com, datalabeling.googleapis.com or ml.googleapis.com.
See more: google.cloud.aiplatform_v1beta1.types.MigratableResource
google.cloud.aiplatform_v1beta1.types.MigratableResource.AutomlDataset
AutomlDataset(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents one Dataset in automl.googleapis.com.
See more: google.cloud.aiplatform_v1beta1.types.MigratableResource.AutomlDataset
google.cloud.aiplatform_v1beta1.types.MigratableResource.AutomlModel
AutomlModel(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents one Model in automl.googleapis.com.
See more: google.cloud.aiplatform_v1beta1.types.MigratableResource.AutomlModel
google.cloud.aiplatform_v1beta1.types.MigratableResource.DataLabelingDataset
DataLabelingDataset(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents one Dataset in datalabeling.googleapis.com.
See more: google.cloud.aiplatform_v1beta1.types.MigratableResource.DataLabelingDataset
google.cloud.aiplatform_v1beta1.types.MigratableResource.DataLabelingDataset.DataLabelingAnnotatedDataset
DataLabelingAnnotatedDataset(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Represents one AnnotatedDataset in datalabeling.googleapis.com.
google.cloud.aiplatform_v1beta1.types.MigratableResource.MlEngineModelVersion
MlEngineModelVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents one model Version in ml.googleapis.com.
See more: google.cloud.aiplatform_v1beta1.types.MigratableResource.MlEngineModelVersion
google.cloud.aiplatform_v1beta1.types.MigrateResourceRequest
MigrateResourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config of migrating one resource from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
See more: google.cloud.aiplatform_v1beta1.types.MigrateResourceRequest
google.cloud.aiplatform_v1beta1.types.MigrateResourceRequest.MigrateAutomlDatasetConfig
MigrateAutomlDatasetConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for migrating Dataset in automl.googleapis.com to Vertex AI's Dataset.
See more: google.cloud.aiplatform_v1beta1.types.MigrateResourceRequest.MigrateAutomlDatasetConfig
google.cloud.aiplatform_v1beta1.types.MigrateResourceRequest.MigrateAutomlModelConfig
MigrateAutomlModelConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for migrating Model in automl.googleapis.com to Vertex AI's Model.
See more: google.cloud.aiplatform_v1beta1.types.MigrateResourceRequest.MigrateAutomlModelConfig
google.cloud.aiplatform_v1beta1.types.MigrateResourceRequest.MigrateDataLabelingDatasetConfig
MigrateDataLabelingDatasetConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI's Dataset.
See more: google.cloud.aiplatform_v1beta1.types.MigrateResourceRequest.MigrateDataLabelingDatasetConfig
google.cloud.aiplatform_v1beta1.types.MigrateResourceRequest.MigrateDataLabelingDatasetConfig.MigrateDataLabelingAnnotatedDatasetConfig
MigrateDataLabelingAnnotatedDatasetConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Config for migrating AnnotatedDataset in datalabeling.googleapis.com to Vertex AI's SavedQuery.
google.cloud.aiplatform_v1beta1.types.MigrateResourceRequest.MigrateMlEngineModelVersionConfig
MigrateMlEngineModelVersionConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Config for migrating version in ml.googleapis.com to Vertex AI's Model.
See more: google.cloud.aiplatform_v1beta1.types.MigrateResourceRequest.MigrateMlEngineModelVersionConfig
google.cloud.aiplatform_v1beta1.types.MigrateResourceResponse
MigrateResourceResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes a successfully migrated resource.
See more: google.cloud.aiplatform_v1beta1.types.MigrateResourceResponse
google.cloud.aiplatform_v1beta1.types.Model
Model(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A trained machine learning Model.
google.cloud.aiplatform_v1beta1.types.Model.BaseModelSource
BaseModelSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
User input field to specify the base model source.
See more: google.cloud.aiplatform_v1beta1.types.Model.BaseModelSource
google.cloud.aiplatform_v1beta1.types.Model.DeploymentResourcesType
DeploymentResourcesType(value)
Identifies a type of Model's prediction resources.
See more: google.cloud.aiplatform_v1beta1.types.Model.DeploymentResourcesType
google.cloud.aiplatform_v1beta1.types.Model.ExportFormat
ExportFormat(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents export format supported by the Model.
See more: google.cloud.aiplatform_v1beta1.types.Model.ExportFormat
google.cloud.aiplatform_v1beta1.types.Model.ExportFormat.ExportableContent
ExportableContent(value)
The Model content that can be exported.
See more: google.cloud.aiplatform_v1beta1.types.Model.ExportFormat.ExportableContent
google.cloud.aiplatform_v1beta1.types.Model.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Model.LabelsEntry
google.cloud.aiplatform_v1beta1.types.Model.OriginalModelInfo
OriginalModelInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains information about the original Model if this Model is a copy.
See more: google.cloud.aiplatform_v1beta1.types.Model.OriginalModelInfo
google.cloud.aiplatform_v1beta1.types.ModelContainerSpec
ModelContainerSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specification of a container for serving predictions.
See more: google.cloud.aiplatform_v1beta1.types.ModelContainerSpec
google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringBigQueryTable
ModelDeploymentMonitoringBigQueryTable(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name as well as some information of the logs stored in this table.
See more: google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringBigQueryTable
google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringBigQueryTable.LogSource
LogSource(value)
Indicates where does the log come from.
See more: google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringBigQueryTable.LogSource
google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringBigQueryTable.LogType
LogType(value)
Indicates what type of traffic does the log belong to.
See more: google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringBigQueryTable.LogType
google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringJob
ModelDeploymentMonitoringJob(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Represents a job that runs periodically to monitor the deployed models in an endpoint.
See more: google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringJob
google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringJob.LabelsEntry
google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata
LatestMonitoringPipelineMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
All metadata of most recent monitoring pipelines.
See more: google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata
google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringJob.MonitoringScheduleState
MonitoringScheduleState(value)
The state to Specify the monitoring pipeline.
See more: google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringJob.MonitoringScheduleState
google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringObjectiveConfig
ModelDeploymentMonitoringObjectiveConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
ModelDeploymentMonitoringObjectiveConfig contains the pair of deployed_model_id to ModelMonitoringObjectiveConfig.
See more: google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringObjectiveConfig
google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringObjectiveType
ModelDeploymentMonitoringObjectiveType(value)
The Model Monitoring Objective types.
See more: google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringObjectiveType
google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringScheduleConfig
ModelDeploymentMonitoringScheduleConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The config for scheduling monitoring job.
See more: google.cloud.aiplatform_v1beta1.types.ModelDeploymentMonitoringScheduleConfig
google.cloud.aiplatform_v1beta1.types.ModelEvaluation
ModelEvaluation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A collection of metrics calculated by comparing Model's predictions on all of the test data against annotations from the test data.
See more: google.cloud.aiplatform_v1beta1.types.ModelEvaluation
google.cloud.aiplatform_v1beta1.types.ModelEvaluation.BiasConfig
BiasConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for bias detection.
See more: google.cloud.aiplatform_v1beta1.types.ModelEvaluation.BiasConfig
google.cloud.aiplatform_v1beta1.types.ModelEvaluation.ModelEvaluationExplanationSpec
ModelEvaluationExplanationSpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice
ModelEvaluationSlice(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A collection of metrics calculated by comparing Model's predictions on a slice of the test data against ground truth annotations.
See more: google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice
google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice.Slice
Slice(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Definition of a slice.
See more: google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice.Slice
google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice.Slice.SliceSpec
SliceSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specification for how the data should be sliced.
See more: google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice.Slice.SliceSpec
google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice.Slice.SliceSpec.ConfigsEntry
ConfigsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice.Slice.SliceSpec.ConfigsEntry
google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice.Slice.SliceSpec.Range
Range(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A range of values for slice(s).
See more: google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice.Slice.SliceSpec.Range
google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice.Slice.SliceSpec.SliceConfig
SliceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specification message containing the config for this SliceSpec.
See more: google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice.Slice.SliceSpec.SliceConfig
google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice.Slice.SliceSpec.Value
Value(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Single value that supports strings and floats.
See more: google.cloud.aiplatform_v1beta1.types.ModelEvaluationSlice.Slice.SliceSpec.Value
google.cloud.aiplatform_v1beta1.types.ModelExplanation
ModelExplanation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Aggregated explanation metrics for a Model over a set of instances.
See more: google.cloud.aiplatform_v1beta1.types.ModelExplanation
google.cloud.aiplatform_v1beta1.types.ModelGardenSource
ModelGardenSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains information about the source of the models generated from Model Garden.
See more: google.cloud.aiplatform_v1beta1.types.ModelGardenSource
google.cloud.aiplatform_v1beta1.types.ModelMonitoringAlertConfig
ModelMonitoringAlertConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The alert config for model monitoring.
See more: google.cloud.aiplatform_v1beta1.types.ModelMonitoringAlertConfig
google.cloud.aiplatform_v1beta1.types.ModelMonitoringAlertConfig.EmailAlertConfig
EmailAlertConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The config for email alert.
See more: google.cloud.aiplatform_v1beta1.types.ModelMonitoringAlertConfig.EmailAlertConfig
google.cloud.aiplatform_v1beta1.types.ModelMonitoringConfig
ModelMonitoringConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The model monitoring configuration used for Batch Prediction Job.
See more: google.cloud.aiplatform_v1beta1.types.ModelMonitoringConfig
google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig
ModelMonitoringObjectiveConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The objective configuration for model monitoring, including the information needed to detect anomalies for one particular model.
See more: google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig
google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.ExplanationConfig
ExplanationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The config for integrating with Vertex Explainable AI.
See more: google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.ExplanationConfig
google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline
ExplanationBaseline(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Output from BatchPredictionJob for Model Monitoring baseline dataset, which can be used to generate baseline attribution scores.
google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline.PredictionFormat
PredictionFormat(value)
The storage format of the predictions generated BatchPrediction job.
google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.PredictionDriftDetectionConfig
PredictionDriftDetectionConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The config for Prediction data drift detection.
See more: google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.PredictionDriftDetectionConfig
google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.PredictionDriftDetectionConfig.AttributionScoreDriftThresholdsEntry
AttributionScoreDriftThresholdsEntry(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The abstract base class for a message.
google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.PredictionDriftDetectionConfig.DriftThresholdsEntry
DriftThresholdsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.TrainingDataset
TrainingDataset(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Training Dataset information.
See more: google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.TrainingDataset
google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.TrainingPredictionSkewDetectionConfig
TrainingPredictionSkewDetectionConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The config for Training & Prediction data skew detection.
google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.TrainingPredictionSkewDetectionConfig.AttributionScoreSkewThresholdsEntry
AttributionScoreSkewThresholdsEntry(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The abstract base class for a message.
google.cloud.aiplatform_v1beta1.types.ModelMonitoringObjectiveConfig.TrainingPredictionSkewDetectionConfig.SkewThresholdsEntry
SkewThresholdsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
google.cloud.aiplatform_v1beta1.types.ModelMonitoringStatsAnomalies
ModelMonitoringStatsAnomalies(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Statistics and anomalies generated by Model Monitoring.
See more: google.cloud.aiplatform_v1beta1.types.ModelMonitoringStatsAnomalies
google.cloud.aiplatform_v1beta1.types.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies
FeatureHistoricStatsAnomalies(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Historical Stats (and Anomalies) for a specific Feature.
See more: google.cloud.aiplatform_v1beta1.types.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies
google.cloud.aiplatform_v1beta1.types.ModelSourceInfo
ModelSourceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Detail description of the source information of the model.
See more: google.cloud.aiplatform_v1beta1.types.ModelSourceInfo
google.cloud.aiplatform_v1beta1.types.ModelSourceInfo.ModelSourceType
ModelSourceType(value)
Source of the model.
See more: google.cloud.aiplatform_v1beta1.types.ModelSourceInfo.ModelSourceType
google.cloud.aiplatform_v1beta1.types.MutateDeployedIndexOperationMetadata
MutateDeployedIndexOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for IndexEndpointService.MutateDeployedIndex.
See more: google.cloud.aiplatform_v1beta1.types.MutateDeployedIndexOperationMetadata
google.cloud.aiplatform_v1beta1.types.MutateDeployedIndexRequest
MutateDeployedIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.MutateDeployedIndex.
See more: google.cloud.aiplatform_v1beta1.types.MutateDeployedIndexRequest
google.cloud.aiplatform_v1beta1.types.MutateDeployedIndexResponse
MutateDeployedIndexResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexEndpointService.MutateDeployedIndex.
See more: google.cloud.aiplatform_v1beta1.types.MutateDeployedIndexResponse
google.cloud.aiplatform_v1beta1.types.MutateDeployedModelOperationMetadata
MutateDeployedModelOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for EndpointService.MutateDeployedModel.
See more: google.cloud.aiplatform_v1beta1.types.MutateDeployedModelOperationMetadata
google.cloud.aiplatform_v1beta1.types.MutateDeployedModelRequest
MutateDeployedModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.MutateDeployedModel.
See more: google.cloud.aiplatform_v1beta1.types.MutateDeployedModelRequest
google.cloud.aiplatform_v1beta1.types.MutateDeployedModelResponse
MutateDeployedModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for EndpointService.MutateDeployedModel.
See more: google.cloud.aiplatform_v1beta1.types.MutateDeployedModelResponse
google.cloud.aiplatform_v1beta1.types.NasJob
NasJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a Neural Architecture Search (NAS) job.
google.cloud.aiplatform_v1beta1.types.NasJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.NasJob.LabelsEntry
google.cloud.aiplatform_v1beta1.types.NasJobOutput
NasJobOutput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a uCAIP NasJob output.
See more: google.cloud.aiplatform_v1beta1.types.NasJobOutput
google.cloud.aiplatform_v1beta1.types.NasJobOutput.MultiTrialJobOutput
MultiTrialJobOutput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The output of a multi-trial Neural Architecture Search (NAS) jobs.
See more: google.cloud.aiplatform_v1beta1.types.NasJobOutput.MultiTrialJobOutput
google.cloud.aiplatform_v1beta1.types.NasJobSpec
NasJobSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of a NasJob.
google.cloud.aiplatform_v1beta1.types.NasJobSpec.MultiTrialAlgorithmSpec
MultiTrialAlgorithmSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The spec of multi-trial Neural Architecture Search (NAS).
See more: google.cloud.aiplatform_v1beta1.types.NasJobSpec.MultiTrialAlgorithmSpec
google.cloud.aiplatform_v1beta1.types.NasJobSpec.MultiTrialAlgorithmSpec.MetricSpec
MetricSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a metric to optimize.
See more: google.cloud.aiplatform_v1beta1.types.NasJobSpec.MultiTrialAlgorithmSpec.MetricSpec
google.cloud.aiplatform_v1beta1.types.NasJobSpec.MultiTrialAlgorithmSpec.MetricSpec.GoalType
GoalType(value)
The available types of optimization goals.
See more: google.cloud.aiplatform_v1beta1.types.NasJobSpec.MultiTrialAlgorithmSpec.MetricSpec.GoalType
google.cloud.aiplatform_v1beta1.types.NasJobSpec.MultiTrialAlgorithmSpec.MultiTrialAlgorithm
MultiTrialAlgorithm(value)
The available types of multi-trial algorithms.
See more: google.cloud.aiplatform_v1beta1.types.NasJobSpec.MultiTrialAlgorithmSpec.MultiTrialAlgorithm
google.cloud.aiplatform_v1beta1.types.NasJobSpec.MultiTrialAlgorithmSpec.SearchTrialSpec
SearchTrialSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represent spec for search trials.
See more: google.cloud.aiplatform_v1beta1.types.NasJobSpec.MultiTrialAlgorithmSpec.SearchTrialSpec
google.cloud.aiplatform_v1beta1.types.NasJobSpec.MultiTrialAlgorithmSpec.TrainTrialSpec
TrainTrialSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represent spec for train trials.
See more: google.cloud.aiplatform_v1beta1.types.NasJobSpec.MultiTrialAlgorithmSpec.TrainTrialSpec
google.cloud.aiplatform_v1beta1.types.NasTrial
NasTrial(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a uCAIP NasJob trial.
google.cloud.aiplatform_v1beta1.types.NasTrial.State
State(value)
Describes a NasTrial state.
See more: google.cloud.aiplatform_v1beta1.types.NasTrial.State
google.cloud.aiplatform_v1beta1.types.NasTrialDetail
NasTrialDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a NasTrial details along with its parameters.
See more: google.cloud.aiplatform_v1beta1.types.NasTrialDetail
google.cloud.aiplatform_v1beta1.types.NearestNeighborQuery
NearestNeighborQuery(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A query to find a number of similar entities.
See more: google.cloud.aiplatform_v1beta1.types.NearestNeighborQuery
google.cloud.aiplatform_v1beta1.types.NearestNeighborQuery.Embedding
Embedding(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The embedding vector.
See more: google.cloud.aiplatform_v1beta1.types.NearestNeighborQuery.Embedding
google.cloud.aiplatform_v1beta1.types.NearestNeighborQuery.Parameters
Parameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Parameters that can be overrided in each query to tune query latency and recall.
See more: google.cloud.aiplatform_v1beta1.types.NearestNeighborQuery.Parameters
google.cloud.aiplatform_v1beta1.types.NearestNeighborQuery.StringFilter
StringFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)
String filter is used to search a subset of the entities by using boolean rules on string columns.
See more: google.cloud.aiplatform_v1beta1.types.NearestNeighborQuery.StringFilter
google.cloud.aiplatform_v1beta1.types.NearestNeighborSearchOperationMetadata
NearestNeighborSearchOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation metadata with regard to Matching Engine Index.
See more: google.cloud.aiplatform_v1beta1.types.NearestNeighborSearchOperationMetadata
google.cloud.aiplatform_v1beta1.types.NearestNeighborSearchOperationMetadata.ContentValidationStats
ContentValidationStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)
See more: google.cloud.aiplatform_v1beta1.types.NearestNeighborSearchOperationMetadata.ContentValidationStats
google.cloud.aiplatform_v1beta1.types.NearestNeighborSearchOperationMetadata.RecordError
RecordError(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform_v1beta1.types.NearestNeighborSearchOperationMetadata.RecordError.RecordErrorType
RecordErrorType(value)
Values: ERROR_TYPE_UNSPECIFIED (0): Default, shall not be used.
google.cloud.aiplatform_v1beta1.types.NearestNeighbors
NearestNeighbors(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Nearest neighbors for one query.
See more: google.cloud.aiplatform_v1beta1.types.NearestNeighbors
google.cloud.aiplatform_v1beta1.types.NearestNeighbors.Neighbor
Neighbor(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A neighbor of the query vector.
See more: google.cloud.aiplatform_v1beta1.types.NearestNeighbors.Neighbor
google.cloud.aiplatform_v1beta1.types.Neighbor
Neighbor(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Neighbors for example-based explanations.
google.cloud.aiplatform_v1beta1.types.NetworkSpec
NetworkSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Network spec.
google.cloud.aiplatform_v1beta1.types.NfsMount
NfsMount(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a mount configuration for Network File System (NFS) to mount.
google.cloud.aiplatform_v1beta1.types.NotebookEucConfig
NotebookEucConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The euc configuration of NotebookRuntimeTemplate.
See more: google.cloud.aiplatform_v1beta1.types.NotebookEucConfig
google.cloud.aiplatform_v1beta1.types.NotebookIdleShutdownConfig
NotebookIdleShutdownConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.
See more: google.cloud.aiplatform_v1beta1.types.NotebookIdleShutdownConfig
google.cloud.aiplatform_v1beta1.types.NotebookRuntime
NotebookRuntime(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.
See more: google.cloud.aiplatform_v1beta1.types.NotebookRuntime
google.cloud.aiplatform_v1beta1.types.NotebookRuntime.HealthState
HealthState(value)
The substate of the NotebookRuntime to display health information.
See more: google.cloud.aiplatform_v1beta1.types.NotebookRuntime.HealthState
google.cloud.aiplatform_v1beta1.types.NotebookRuntime.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.NotebookRuntime.LabelsEntry
google.cloud.aiplatform_v1beta1.types.NotebookRuntime.RuntimeState
RuntimeState(value)
The substate of the NotebookRuntime to display state of runtime.
See more: google.cloud.aiplatform_v1beta1.types.NotebookRuntime.RuntimeState
google.cloud.aiplatform_v1beta1.types.NotebookRuntimeTemplate
NotebookRuntimeTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc.
See more: google.cloud.aiplatform_v1beta1.types.NotebookRuntimeTemplate
google.cloud.aiplatform_v1beta1.types.NotebookRuntimeTemplate.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.NotebookRuntimeTemplate.LabelsEntry
google.cloud.aiplatform_v1beta1.types.NotebookRuntimeTemplateRef
NotebookRuntimeTemplateRef(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Points to a NotebookRuntimeTemplateRef.
See more: google.cloud.aiplatform_v1beta1.types.NotebookRuntimeTemplateRef
google.cloud.aiplatform_v1beta1.types.NotebookRuntimeType
NotebookRuntimeType(value)
Represents a notebook runtime type.
See more: google.cloud.aiplatform_v1beta1.types.NotebookRuntimeType
google.cloud.aiplatform_v1beta1.types.PairwiseChoice
PairwiseChoice(value)
Pairwise prediction autorater preference.
See more: google.cloud.aiplatform_v1beta1.types.PairwiseChoice
google.cloud.aiplatform_v1beta1.types.PairwiseQuestionAnsweringQualityInput
PairwiseQuestionAnsweringQualityInput(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Input for pairwise question answering quality metric.
See more: google.cloud.aiplatform_v1beta1.types.PairwiseQuestionAnsweringQualityInput
google.cloud.aiplatform_v1beta1.types.PairwiseQuestionAnsweringQualityInstance
PairwiseQuestionAnsweringQualityInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for pairwise question answering quality instance.
See more: google.cloud.aiplatform_v1beta1.types.PairwiseQuestionAnsweringQualityInstance
google.cloud.aiplatform_v1beta1.types.PairwiseQuestionAnsweringQualityResult
PairwiseQuestionAnsweringQualityResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for pairwise question answering quality result.
See more: google.cloud.aiplatform_v1beta1.types.PairwiseQuestionAnsweringQualityResult
google.cloud.aiplatform_v1beta1.types.PairwiseQuestionAnsweringQualitySpec
PairwiseQuestionAnsweringQualitySpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for pairwise question answering quality score metric.
See more: google.cloud.aiplatform_v1beta1.types.PairwiseQuestionAnsweringQualitySpec
google.cloud.aiplatform_v1beta1.types.PairwiseSummarizationQualityInput
PairwiseSummarizationQualityInput(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Input for pairwise summarization quality metric.
See more: google.cloud.aiplatform_v1beta1.types.PairwiseSummarizationQualityInput
google.cloud.aiplatform_v1beta1.types.PairwiseSummarizationQualityInstance
PairwiseSummarizationQualityInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for pairwise summarization quality instance.
See more: google.cloud.aiplatform_v1beta1.types.PairwiseSummarizationQualityInstance
google.cloud.aiplatform_v1beta1.types.PairwiseSummarizationQualityResult
PairwiseSummarizationQualityResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for pairwise summarization quality result.
See more: google.cloud.aiplatform_v1beta1.types.PairwiseSummarizationQualityResult
google.cloud.aiplatform_v1beta1.types.PairwiseSummarizationQualitySpec
PairwiseSummarizationQualitySpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for pairwise summarization quality score metric.
See more: google.cloud.aiplatform_v1beta1.types.PairwiseSummarizationQualitySpec
google.cloud.aiplatform_v1beta1.types.Part
Part(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A datatype containing media that is part of a multi-part Content
message.
google.cloud.aiplatform_v1beta1.types.PauseModelDeploymentMonitoringJobRequest
PauseModelDeploymentMonitoringJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.PauseModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1beta1.types.PauseModelDeploymentMonitoringJobRequest
google.cloud.aiplatform_v1beta1.types.PauseScheduleRequest
PauseScheduleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.PauseSchedule.
See more: google.cloud.aiplatform_v1beta1.types.PauseScheduleRequest
google.cloud.aiplatform_v1beta1.types.PersistentDiskSpec
PersistentDiskSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] options.
See more: google.cloud.aiplatform_v1beta1.types.PersistentDiskSpec
google.cloud.aiplatform_v1beta1.types.PersistentResource
PersistentResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents long-lasting resources that are dedicated to users to runs custom workloads.
See more: google.cloud.aiplatform_v1beta1.types.PersistentResource
google.cloud.aiplatform_v1beta1.types.PersistentResource.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.PersistentResource.LabelsEntry
google.cloud.aiplatform_v1beta1.types.PersistentResource.State
State(value)
Describes the PersistentResource state.
See more: google.cloud.aiplatform_v1beta1.types.PersistentResource.State
google.cloud.aiplatform_v1beta1.types.PipelineFailurePolicy
PipelineFailurePolicy(value)
Represents the failure policy of a pipeline.
See more: google.cloud.aiplatform_v1beta1.types.PipelineFailurePolicy
google.cloud.aiplatform_v1beta1.types.PipelineJob
PipelineJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An instance of a machine learning PipelineJob.
google.cloud.aiplatform_v1beta1.types.PipelineJob.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.PipelineJob.LabelsEntry
google.cloud.aiplatform_v1beta1.types.PipelineJob.RuntimeConfig
RuntimeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The runtime config of a PipelineJob.
See more: google.cloud.aiplatform_v1beta1.types.PipelineJob.RuntimeConfig
google.cloud.aiplatform_v1beta1.types.PipelineJob.RuntimeConfig.InputArtifact
InputArtifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The type of an input artifact.
See more: google.cloud.aiplatform_v1beta1.types.PipelineJob.RuntimeConfig.InputArtifact
google.cloud.aiplatform_v1beta1.types.PipelineJob.RuntimeConfig.InputArtifactsEntry
InputArtifactsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.PipelineJob.RuntimeConfig.InputArtifactsEntry
google.cloud.aiplatform_v1beta1.types.PipelineJob.RuntimeConfig.ParameterValuesEntry
ParameterValuesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.PipelineJob.RuntimeConfig.ParameterValuesEntry
google.cloud.aiplatform_v1beta1.types.PipelineJob.RuntimeConfig.ParametersEntry
ParametersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.PipelineJob.RuntimeConfig.ParametersEntry
google.cloud.aiplatform_v1beta1.types.PipelineJobDetail
PipelineJobDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The runtime detail of PipelineJob.
See more: google.cloud.aiplatform_v1beta1.types.PipelineJobDetail
google.cloud.aiplatform_v1beta1.types.PipelineState
PipelineState(value)
Describes the state of a pipeline.
See more: google.cloud.aiplatform_v1beta1.types.PipelineState
google.cloud.aiplatform_v1beta1.types.PipelineTaskDetail
PipelineTaskDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The runtime detail of a task execution.
See more: google.cloud.aiplatform_v1beta1.types.PipelineTaskDetail
google.cloud.aiplatform_v1beta1.types.PipelineTaskDetail.ArtifactList
ArtifactList(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of artifact metadata.
See more: google.cloud.aiplatform_v1beta1.types.PipelineTaskDetail.ArtifactList
google.cloud.aiplatform_v1beta1.types.PipelineTaskDetail.InputsEntry
InputsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.PipelineTaskDetail.InputsEntry
google.cloud.aiplatform_v1beta1.types.PipelineTaskDetail.OutputsEntry
OutputsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.PipelineTaskDetail.OutputsEntry
google.cloud.aiplatform_v1beta1.types.PipelineTaskDetail.PipelineTaskStatus
PipelineTaskStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A single record of the task status.
See more: google.cloud.aiplatform_v1beta1.types.PipelineTaskDetail.PipelineTaskStatus
google.cloud.aiplatform_v1beta1.types.PipelineTaskDetail.State
State(value)
Specifies state of TaskExecution.
See more: google.cloud.aiplatform_v1beta1.types.PipelineTaskDetail.State
google.cloud.aiplatform_v1beta1.types.PipelineTaskExecutorDetail
PipelineTaskExecutorDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The runtime detail of a pipeline executor.
See more: google.cloud.aiplatform_v1beta1.types.PipelineTaskExecutorDetail
google.cloud.aiplatform_v1beta1.types.PipelineTaskExecutorDetail.ContainerDetail
ContainerDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The detail of a container execution.
See more: google.cloud.aiplatform_v1beta1.types.PipelineTaskExecutorDetail.ContainerDetail
google.cloud.aiplatform_v1beta1.types.PipelineTaskExecutorDetail.CustomJobDetail
CustomJobDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The detailed info for a custom job executor.
See more: google.cloud.aiplatform_v1beta1.types.PipelineTaskExecutorDetail.CustomJobDetail
google.cloud.aiplatform_v1beta1.types.PipelineTemplateMetadata
PipelineTemplateMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Pipeline template metadata if PipelineJob.template_uri is from supported template registry.
See more: google.cloud.aiplatform_v1beta1.types.PipelineTemplateMetadata
google.cloud.aiplatform_v1beta1.types.Port
Port(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a network port in a container.
google.cloud.aiplatform_v1beta1.types.PredefinedSplit
PredefinedSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns input data to training, validation, and test sets based on the value of a provided key.
See more: google.cloud.aiplatform_v1beta1.types.PredefinedSplit
google.cloud.aiplatform_v1beta1.types.PredictRequest
PredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.Predict.
See more: google.cloud.aiplatform_v1beta1.types.PredictRequest
google.cloud.aiplatform_v1beta1.types.PredictRequestResponseLoggingConfig
PredictRequestResponseLoggingConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Configuration for logging request-response to a BigQuery table.
See more: google.cloud.aiplatform_v1beta1.types.PredictRequestResponseLoggingConfig
google.cloud.aiplatform_v1beta1.types.PredictResponse
PredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.Predict.
See more: google.cloud.aiplatform_v1beta1.types.PredictResponse
google.cloud.aiplatform_v1beta1.types.PredictSchemata
PredictSchemata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob.
See more: google.cloud.aiplatform_v1beta1.types.PredictSchemata
google.cloud.aiplatform_v1beta1.types.Presets
Presets(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Preset configuration for example-based explanations.
google.cloud.aiplatform_v1beta1.types.Presets.Modality
Modality(value)
Preset option controlling parameters for different modalities.
See more: google.cloud.aiplatform_v1beta1.types.Presets.Modality
google.cloud.aiplatform_v1beta1.types.Presets.Query
Query(value)
Preset option controlling parameters for query speed-precision trade-off.
See more: google.cloud.aiplatform_v1beta1.types.Presets.Query
google.cloud.aiplatform_v1beta1.types.PrivateEndpoints
PrivateEndpoints(mapping=None, *, ignore_unknown_fields=False, **kwargs)
PrivateEndpoints proto is used to provide paths for users to send requests privately.
See more: google.cloud.aiplatform_v1beta1.types.PrivateEndpoints
google.cloud.aiplatform_v1beta1.types.PrivateServiceConnectConfig
PrivateServiceConnectConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents configuration for private service connect.
See more: google.cloud.aiplatform_v1beta1.types.PrivateServiceConnectConfig
google.cloud.aiplatform_v1beta1.types.Probe
Probe(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
google.cloud.aiplatform_v1beta1.types.Probe.ExecAction
ExecAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)
ExecAction specifies a command to execute.
See more: google.cloud.aiplatform_v1beta1.types.Probe.ExecAction
google.cloud.aiplatform_v1beta1.types.PscAutomatedEndpoints
PscAutomatedEndpoints(mapping=None, *, ignore_unknown_fields=False, **kwargs)
PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig.
See more: google.cloud.aiplatform_v1beta1.types.PscAutomatedEndpoints
google.cloud.aiplatform_v1beta1.types.PublisherModel
PublisherModel(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A Model Garden Publisher Model.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel
google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction
CallToAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Actions could take on this Publisher Model.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction
google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.Deploy
Deploy(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.Deploy
google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.DeployGke
DeployGke(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configurations for PublisherModel GKE deployment .
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.DeployGke
google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.OpenFineTuningPipelines
OpenFineTuningPipelines(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Open fine tuning pipelines.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.OpenFineTuningPipelines
google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.OpenNotebooks
OpenNotebooks(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Open notebooks.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.OpenNotebooks
google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.RegionalResourceReferences
RegionalResourceReferences(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The regional resource name or the URI.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.RegionalResourceReferences
google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.RegionalResourceReferences.ReferencesEntry
ReferencesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.ViewRestApi
ViewRestApi(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Rest API docs.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.CallToAction.ViewRestApi
google.cloud.aiplatform_v1beta1.types.PublisherModel.Documentation
Documentation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A named piece of documentation.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.Documentation
google.cloud.aiplatform_v1beta1.types.PublisherModel.LaunchStage
LaunchStage(value)
An enum representing the launch stage of a PublisherModel.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.LaunchStage
google.cloud.aiplatform_v1beta1.types.PublisherModel.OpenSourceCategory
OpenSourceCategory(value)
An enum representing the open source category of a PublisherModel.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.OpenSourceCategory
google.cloud.aiplatform_v1beta1.types.PublisherModel.Parent
Parent(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The information about the parent of a model.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.Parent
google.cloud.aiplatform_v1beta1.types.PublisherModel.ResourceReference
ResourceReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Reference to a resource.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.ResourceReference
google.cloud.aiplatform_v1beta1.types.PublisherModel.VersionState
VersionState(value)
An enum representing the state of the PublicModelVersion.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModel.VersionState
google.cloud.aiplatform_v1beta1.types.PublisherModelView
PublisherModelView(value)
View enumeration of PublisherModel.
See more: google.cloud.aiplatform_v1beta1.types.PublisherModelView
google.cloud.aiplatform_v1beta1.types.PurgeArtifactsMetadata
PurgeArtifactsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Details of operations that perform MetadataService.PurgeArtifacts.
See more: google.cloud.aiplatform_v1beta1.types.PurgeArtifactsMetadata
google.cloud.aiplatform_v1beta1.types.PurgeArtifactsRequest
PurgeArtifactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.PurgeArtifacts.
See more: google.cloud.aiplatform_v1beta1.types.PurgeArtifactsRequest
google.cloud.aiplatform_v1beta1.types.PurgeArtifactsResponse
PurgeArtifactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.PurgeArtifacts.
See more: google.cloud.aiplatform_v1beta1.types.PurgeArtifactsResponse
google.cloud.aiplatform_v1beta1.types.PurgeContextsMetadata
PurgeContextsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Details of operations that perform MetadataService.PurgeContexts.
See more: google.cloud.aiplatform_v1beta1.types.PurgeContextsMetadata
google.cloud.aiplatform_v1beta1.types.PurgeContextsRequest
PurgeContextsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.PurgeContexts.
See more: google.cloud.aiplatform_v1beta1.types.PurgeContextsRequest
google.cloud.aiplatform_v1beta1.types.PurgeContextsResponse
PurgeContextsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.PurgeContexts.
See more: google.cloud.aiplatform_v1beta1.types.PurgeContextsResponse
google.cloud.aiplatform_v1beta1.types.PurgeExecutionsMetadata
PurgeExecutionsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Details of operations that perform MetadataService.PurgeExecutions.
See more: google.cloud.aiplatform_v1beta1.types.PurgeExecutionsMetadata
google.cloud.aiplatform_v1beta1.types.PurgeExecutionsRequest
PurgeExecutionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.PurgeExecutions.
See more: google.cloud.aiplatform_v1beta1.types.PurgeExecutionsRequest
google.cloud.aiplatform_v1beta1.types.PurgeExecutionsResponse
PurgeExecutionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for MetadataService.PurgeExecutions.
See more: google.cloud.aiplatform_v1beta1.types.PurgeExecutionsResponse
google.cloud.aiplatform_v1beta1.types.PythonPackageSpec
PythonPackageSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The spec of a Python packaged code.
See more: google.cloud.aiplatform_v1beta1.types.PythonPackageSpec
google.cloud.aiplatform_v1beta1.types.QueryArtifactLineageSubgraphRequest
QueryArtifactLineageSubgraphRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for MetadataService.QueryArtifactLineageSubgraph.
See more: google.cloud.aiplatform_v1beta1.types.QueryArtifactLineageSubgraphRequest
google.cloud.aiplatform_v1beta1.types.QueryContextLineageSubgraphRequest
QueryContextLineageSubgraphRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for MetadataService.QueryContextLineageSubgraph.
See more: google.cloud.aiplatform_v1beta1.types.QueryContextLineageSubgraphRequest
google.cloud.aiplatform_v1beta1.types.QueryDeployedModelsRequest
QueryDeployedModelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for QueryDeployedModels method.
See more: google.cloud.aiplatform_v1beta1.types.QueryDeployedModelsRequest
google.cloud.aiplatform_v1beta1.types.QueryDeployedModelsResponse
QueryDeployedModelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for QueryDeployedModels method.
See more: google.cloud.aiplatform_v1beta1.types.QueryDeployedModelsResponse
google.cloud.aiplatform_v1beta1.types.QueryExecutionInputsAndOutputsRequest
QueryExecutionInputsAndOutputsRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for MetadataService.QueryExecutionInputsAndOutputs.
See more: google.cloud.aiplatform_v1beta1.types.QueryExecutionInputsAndOutputsRequest
google.cloud.aiplatform_v1beta1.types.QueryExtensionRequest
QueryExtensionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ExtensionExecutionService.QueryExtension.
See more: google.cloud.aiplatform_v1beta1.types.QueryExtensionRequest
google.cloud.aiplatform_v1beta1.types.QueryExtensionResponse
QueryExtensionResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for ExtensionExecutionService.QueryExtension.
See more: google.cloud.aiplatform_v1beta1.types.QueryExtensionResponse
google.cloud.aiplatform_v1beta1.types.QueryReasoningEngineRequest
QueryReasoningEngineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for [ReasoningEngineExecutionService.Query][].
See more: google.cloud.aiplatform_v1beta1.types.QueryReasoningEngineRequest
google.cloud.aiplatform_v1beta1.types.QueryReasoningEngineResponse
QueryReasoningEngineResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for [ReasoningEngineExecutionService.Query][] .
See more: google.cloud.aiplatform_v1beta1.types.QueryReasoningEngineResponse
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringCorrectnessInput
QuestionAnsweringCorrectnessInput(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Input for question answering correctness metric.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringCorrectnessInput
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringCorrectnessInstance
QuestionAnsweringCorrectnessInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for question answering correctness instance.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringCorrectnessInstance
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringCorrectnessResult
QuestionAnsweringCorrectnessResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for question answering correctness result.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringCorrectnessResult
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringCorrectnessSpec
QuestionAnsweringCorrectnessSpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for question answering correctness metric.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringCorrectnessSpec
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringHelpfulnessInput
QuestionAnsweringHelpfulnessInput(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Input for question answering helpfulness metric.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringHelpfulnessInput
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringHelpfulnessInstance
QuestionAnsweringHelpfulnessInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for question answering helpfulness instance.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringHelpfulnessInstance
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringHelpfulnessResult
QuestionAnsweringHelpfulnessResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for question answering helpfulness result.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringHelpfulnessResult
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringHelpfulnessSpec
QuestionAnsweringHelpfulnessSpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for question answering helpfulness metric.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringHelpfulnessSpec
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringQualityInput
QuestionAnsweringQualityInput(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Input for question answering quality metric.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringQualityInput
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringQualityInstance
QuestionAnsweringQualityInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for question answering quality instance.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringQualityInstance
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringQualityResult
QuestionAnsweringQualityResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for question answering quality result.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringQualityResult
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringQualitySpec
QuestionAnsweringQualitySpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for question answering quality score metric.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringQualitySpec
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringRelevanceInput
QuestionAnsweringRelevanceInput(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Input for question answering relevance metric.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringRelevanceInput
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringRelevanceInstance
QuestionAnsweringRelevanceInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for question answering relevance instance.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringRelevanceInstance
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringRelevanceResult
QuestionAnsweringRelevanceResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for question answering relevance result.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringRelevanceResult
google.cloud.aiplatform_v1beta1.types.QuestionAnsweringRelevanceSpec
QuestionAnsweringRelevanceSpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for question answering relevance metric.
See more: google.cloud.aiplatform_v1beta1.types.QuestionAnsweringRelevanceSpec
google.cloud.aiplatform_v1beta1.types.RagContexts
RagContexts(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Relevant contexts for one query.
google.cloud.aiplatform_v1beta1.types.RagContexts.Context
Context(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A context of the query.
See more: google.cloud.aiplatform_v1beta1.types.RagContexts.Context
google.cloud.aiplatform_v1beta1.types.RagCorpus
RagCorpus(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A RagCorpus is a RagFile container and a project can have multiple RagCorpora.
google.cloud.aiplatform_v1beta1.types.RagFile
RagFile(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A RagFile contains user data for chunking, embedding and indexing.
google.cloud.aiplatform_v1beta1.types.RagFile.RagFileType
RagFileType(value)
The type of the RagFile.
See more: google.cloud.aiplatform_v1beta1.types.RagFile.RagFileType
google.cloud.aiplatform_v1beta1.types.RagFileChunkingConfig
RagFileChunkingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specifies the size and overlap of chunks for RagFiles.
See more: google.cloud.aiplatform_v1beta1.types.RagFileChunkingConfig
google.cloud.aiplatform_v1beta1.types.RagQuery
RagQuery(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A query to retrieve relevant contexts.
google.cloud.aiplatform_v1beta1.types.RawPredictRequest
RawPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.RawPredict.
See more: google.cloud.aiplatform_v1beta1.types.RawPredictRequest
google.cloud.aiplatform_v1beta1.types.RayMetricSpec
RayMetricSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for the Ray metrics.
See more: google.cloud.aiplatform_v1beta1.types.RayMetricSpec
google.cloud.aiplatform_v1beta1.types.RaySpec
RaySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration information for the Ray cluster.
google.cloud.aiplatform_v1beta1.types.RaySpec.ResourcePoolImagesEntry
ResourcePoolImagesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.RaySpec.ResourcePoolImagesEntry
google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesRequest
ReadFeatureValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreOnlineServingService.ReadFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesRequest
google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesResponse
ReadFeatureValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreOnlineServingService.ReadFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesResponse
google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesResponse.EntityView
EntityView(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Entity view with Feature values.
See more: google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesResponse.EntityView
google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesResponse.EntityView.Data
Data(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Container to hold value(s), successive in time, for one Feature from the request.
See more: google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesResponse.EntityView.Data
google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesResponse.FeatureDescriptor
FeatureDescriptor(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata for requested Features.
See more: google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesResponse.FeatureDescriptor
google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesResponse.Header
Header(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response header with metadata for the requested ReadFeatureValuesRequest.entity_type and Features.
See more: google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesResponse.Header
google.cloud.aiplatform_v1beta1.types.ReadIndexDatapointsRequest
ReadIndexDatapointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The request message for MatchService.ReadIndexDatapoints.
See more: google.cloud.aiplatform_v1beta1.types.ReadIndexDatapointsRequest
google.cloud.aiplatform_v1beta1.types.ReadIndexDatapointsResponse
ReadIndexDatapointsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The response message for MatchService.ReadIndexDatapoints.
See more: google.cloud.aiplatform_v1beta1.types.ReadIndexDatapointsResponse
google.cloud.aiplatform_v1beta1.types.ReadTensorboardBlobDataRequest
ReadTensorboardBlobDataRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.ReadTensorboardBlobData.
See more: google.cloud.aiplatform_v1beta1.types.ReadTensorboardBlobDataRequest
google.cloud.aiplatform_v1beta1.types.ReadTensorboardBlobDataResponse
ReadTensorboardBlobDataResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.ReadTensorboardBlobData.
See more: google.cloud.aiplatform_v1beta1.types.ReadTensorboardBlobDataResponse
google.cloud.aiplatform_v1beta1.types.ReadTensorboardSizeRequest
ReadTensorboardSizeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.ReadTensorboardSize.
See more: google.cloud.aiplatform_v1beta1.types.ReadTensorboardSizeRequest
google.cloud.aiplatform_v1beta1.types.ReadTensorboardSizeResponse
ReadTensorboardSizeResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for TensorboardService.ReadTensorboardSize.
See more: google.cloud.aiplatform_v1beta1.types.ReadTensorboardSizeResponse
google.cloud.aiplatform_v1beta1.types.ReadTensorboardTimeSeriesDataRequest
ReadTensorboardTimeSeriesDataRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.ReadTensorboardTimeSeriesData.
See more: google.cloud.aiplatform_v1beta1.types.ReadTensorboardTimeSeriesDataRequest
google.cloud.aiplatform_v1beta1.types.ReadTensorboardTimeSeriesDataResponse
ReadTensorboardTimeSeriesDataResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.ReadTensorboardTimeSeriesData.
See more: google.cloud.aiplatform_v1beta1.types.ReadTensorboardTimeSeriesDataResponse
google.cloud.aiplatform_v1beta1.types.ReadTensorboardUsageRequest
ReadTensorboardUsageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.ReadTensorboardUsage.
See more: google.cloud.aiplatform_v1beta1.types.ReadTensorboardUsageRequest
google.cloud.aiplatform_v1beta1.types.ReadTensorboardUsageResponse
ReadTensorboardUsageResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.ReadTensorboardUsage.
See more: google.cloud.aiplatform_v1beta1.types.ReadTensorboardUsageResponse
google.cloud.aiplatform_v1beta1.types.ReadTensorboardUsageResponse.MonthlyUsageDataEntry
MonthlyUsageDataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.ReadTensorboardUsageResponse.MonthlyUsageDataEntry
google.cloud.aiplatform_v1beta1.types.ReadTensorboardUsageResponse.PerMonthUsageData
PerMonthUsageData(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Per month usage data .
See more: google.cloud.aiplatform_v1beta1.types.ReadTensorboardUsageResponse.PerMonthUsageData
google.cloud.aiplatform_v1beta1.types.ReadTensorboardUsageResponse.PerUserUsageData
PerUserUsageData(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Per user usage data.
See more: google.cloud.aiplatform_v1beta1.types.ReadTensorboardUsageResponse.PerUserUsageData
google.cloud.aiplatform_v1beta1.types.ReasoningEngine
ReasoningEngine(mapping=None, *, ignore_unknown_fields=False, **kwargs)
ReasoningEngine provides a customizable runtime for models to determine which actions to take and in which order.
See more: google.cloud.aiplatform_v1beta1.types.ReasoningEngine
google.cloud.aiplatform_v1beta1.types.ReasoningEngineSpec
ReasoningEngineSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
ReasoningEngine configurations .
See more: google.cloud.aiplatform_v1beta1.types.ReasoningEngineSpec
google.cloud.aiplatform_v1beta1.types.ReasoningEngineSpec.PackageSpec
PackageSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
User provided package spec like pickled object and package requirements.
See more: google.cloud.aiplatform_v1beta1.types.ReasoningEngineSpec.PackageSpec
google.cloud.aiplatform_v1beta1.types.RebootPersistentResourceOperationMetadata
RebootPersistentResourceOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform reboot PersistentResource.
See more: google.cloud.aiplatform_v1beta1.types.RebootPersistentResourceOperationMetadata
google.cloud.aiplatform_v1beta1.types.RebootPersistentResourceRequest
RebootPersistentResourceRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PersistentResourceService.RebootPersistentResource.
See more: google.cloud.aiplatform_v1beta1.types.RebootPersistentResourceRequest
google.cloud.aiplatform_v1beta1.types.RemoveContextChildrenRequest
RemoveContextChildrenRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for [MetadataService.DeleteContextChildrenRequest][].
See more: google.cloud.aiplatform_v1beta1.types.RemoveContextChildrenRequest
google.cloud.aiplatform_v1beta1.types.RemoveContextChildrenResponse
RemoveContextChildrenResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for MetadataService.RemoveContextChildren.
See more: google.cloud.aiplatform_v1beta1.types.RemoveContextChildrenResponse
google.cloud.aiplatform_v1beta1.types.RemoveDatapointsRequest
RemoveDatapointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.RemoveDatapoints .
See more: google.cloud.aiplatform_v1beta1.types.RemoveDatapointsRequest
google.cloud.aiplatform_v1beta1.types.RemoveDatapointsResponse
RemoveDatapointsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexService.RemoveDatapoints .
See more: google.cloud.aiplatform_v1beta1.types.RemoveDatapointsResponse
google.cloud.aiplatform_v1beta1.types.ResourcePool
ResourcePool(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.
See more: google.cloud.aiplatform_v1beta1.types.ResourcePool
google.cloud.aiplatform_v1beta1.types.ResourcePool.AutoscalingSpec
AutoscalingSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The min/max number of replicas allowed if enabling autoscaling.
See more: google.cloud.aiplatform_v1beta1.types.ResourcePool.AutoscalingSpec
google.cloud.aiplatform_v1beta1.types.ResourceRuntime
ResourceRuntime(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Persistent Cluster runtime information as output .
See more: google.cloud.aiplatform_v1beta1.types.ResourceRuntime
google.cloud.aiplatform_v1beta1.types.ResourceRuntime.AccessUrisEntry
AccessUrisEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.ResourceRuntime.AccessUrisEntry
google.cloud.aiplatform_v1beta1.types.ResourceRuntimeSpec
ResourceRuntimeSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for the runtime on a PersistentResource instance, including but not limited to:.
See more: google.cloud.aiplatform_v1beta1.types.ResourceRuntimeSpec
google.cloud.aiplatform_v1beta1.types.ResourcesConsumed
ResourcesConsumed(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Statistics information about resource consumption.
See more: google.cloud.aiplatform_v1beta1.types.ResourcesConsumed
google.cloud.aiplatform_v1beta1.types.RestoreDatasetVersionOperationMetadata
RestoreDatasetVersionOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for DatasetService.RestoreDatasetVersion.
See more: google.cloud.aiplatform_v1beta1.types.RestoreDatasetVersionOperationMetadata
google.cloud.aiplatform_v1beta1.types.RestoreDatasetVersionRequest
RestoreDatasetVersionRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for DatasetService.RestoreDatasetVersion.
See more: google.cloud.aiplatform_v1beta1.types.RestoreDatasetVersionRequest
google.cloud.aiplatform_v1beta1.types.ResumeModelDeploymentMonitoringJobRequest
ResumeModelDeploymentMonitoringJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.ResumeModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1beta1.types.ResumeModelDeploymentMonitoringJobRequest
google.cloud.aiplatform_v1beta1.types.ResumeScheduleRequest
ResumeScheduleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.ResumeSchedule.
See more: google.cloud.aiplatform_v1beta1.types.ResumeScheduleRequest
google.cloud.aiplatform_v1beta1.types.Retrieval
Retrieval(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Defines a retrieval tool that model can call to access external knowledge.
google.cloud.aiplatform_v1beta1.types.RetrieveContextsRequest
RetrieveContextsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VertexRagService.RetrieveContexts.
See more: google.cloud.aiplatform_v1beta1.types.RetrieveContextsRequest
google.cloud.aiplatform_v1beta1.types.RetrieveContextsRequest.VertexRagStore
VertexRagStore(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The data source for Vertex RagStore.
See more: google.cloud.aiplatform_v1beta1.types.RetrieveContextsRequest.VertexRagStore
google.cloud.aiplatform_v1beta1.types.RetrieveContextsResponse
RetrieveContextsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VertexRagService.RetrieveContexts.
See more: google.cloud.aiplatform_v1beta1.types.RetrieveContextsResponse
google.cloud.aiplatform_v1beta1.types.RougeInput
RougeInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for rouge metric.
google.cloud.aiplatform_v1beta1.types.RougeInstance
RougeInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for rouge instance.
See more: google.cloud.aiplatform_v1beta1.types.RougeInstance
google.cloud.aiplatform_v1beta1.types.RougeMetricValue
RougeMetricValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Rouge metric value for an instance.
See more: google.cloud.aiplatform_v1beta1.types.RougeMetricValue
google.cloud.aiplatform_v1beta1.types.RougeResults
RougeResults(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Results for rouge metric.
See more: google.cloud.aiplatform_v1beta1.types.RougeResults
google.cloud.aiplatform_v1beta1.types.RougeSpec
RougeSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1.
google.cloud.aiplatform_v1beta1.types.RuntimeConfig
RuntimeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Runtime configuration to run the extension.
See more: google.cloud.aiplatform_v1beta1.types.RuntimeConfig
google.cloud.aiplatform_v1beta1.types.RuntimeConfig.CodeInterpreterRuntimeConfig
CodeInterpreterRuntimeConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
google.cloud.aiplatform_v1beta1.types.RuntimeConfig.VertexAISearchRuntimeConfig
VertexAISearchRuntimeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
google.cloud.aiplatform_v1beta1.types.SafetyInput
SafetyInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for safety metric.
google.cloud.aiplatform_v1beta1.types.SafetyInstance
SafetyInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for safety instance.
See more: google.cloud.aiplatform_v1beta1.types.SafetyInstance
google.cloud.aiplatform_v1beta1.types.SafetyRating
SafetyRating(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Safety rating corresponding to the generated content.
See more: google.cloud.aiplatform_v1beta1.types.SafetyRating
google.cloud.aiplatform_v1beta1.types.SafetyRating.HarmProbability
HarmProbability(value)
Harm probability levels in the content.
See more: google.cloud.aiplatform_v1beta1.types.SafetyRating.HarmProbability
google.cloud.aiplatform_v1beta1.types.SafetyRating.HarmSeverity
HarmSeverity(value)
Harm severity levels.
See more: google.cloud.aiplatform_v1beta1.types.SafetyRating.HarmSeverity
google.cloud.aiplatform_v1beta1.types.SafetyResult
SafetyResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for safety result.
See more: google.cloud.aiplatform_v1beta1.types.SafetyResult
google.cloud.aiplatform_v1beta1.types.SafetySetting
SafetySetting(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Safety settings.
See more: google.cloud.aiplatform_v1beta1.types.SafetySetting
google.cloud.aiplatform_v1beta1.types.SafetySetting.HarmBlockMethod
HarmBlockMethod(value)
Probability vs severity.
See more: google.cloud.aiplatform_v1beta1.types.SafetySetting.HarmBlockMethod
google.cloud.aiplatform_v1beta1.types.SafetySetting.HarmBlockThreshold
HarmBlockThreshold(value)
Probability based thresholds levels for blocking.
See more: google.cloud.aiplatform_v1beta1.types.SafetySetting.HarmBlockThreshold
google.cloud.aiplatform_v1beta1.types.SafetySpec
SafetySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for safety metric.
google.cloud.aiplatform_v1beta1.types.SampleConfig
SampleConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Active learning data sampling config.
See more: google.cloud.aiplatform_v1beta1.types.SampleConfig
google.cloud.aiplatform_v1beta1.types.SampleConfig.SampleStrategy
SampleStrategy(value)
Sample strategy decides which subset of DataItems should be selected for human labeling in every batch.
See more: google.cloud.aiplatform_v1beta1.types.SampleConfig.SampleStrategy
google.cloud.aiplatform_v1beta1.types.SampledShapleyAttribution
SampledShapleyAttribution(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An attribution method that approximates Shapley values for features that contribute to the label being predicted.
See more: google.cloud.aiplatform_v1beta1.types.SampledShapleyAttribution
google.cloud.aiplatform_v1beta1.types.SamplingStrategy
SamplingStrategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Sampling Strategy for logging, can be for both training and prediction dataset.
See more: google.cloud.aiplatform_v1beta1.types.SamplingStrategy
google.cloud.aiplatform_v1beta1.types.SamplingStrategy.RandomSampleConfig
RandomSampleConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Requests are randomly selected.
See more: google.cloud.aiplatform_v1beta1.types.SamplingStrategy.RandomSampleConfig
google.cloud.aiplatform_v1beta1.types.SavedQuery
SavedQuery(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A SavedQuery is a view of the dataset.
google.cloud.aiplatform_v1beta1.types.Scalar
Scalar(mapping=None, *, ignore_unknown_fields=False, **kwargs)
One point viewable on a scalar metric plot.
google.cloud.aiplatform_v1beta1.types.Schedule
Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
google.cloud.aiplatform_v1beta1.types.Schedule.RunResponse
RunResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Status of a scheduled run.
See more: google.cloud.aiplatform_v1beta1.types.Schedule.RunResponse
google.cloud.aiplatform_v1beta1.types.Schedule.State
State(value)
Possible state of the schedule.
See more: google.cloud.aiplatform_v1beta1.types.Schedule.State
google.cloud.aiplatform_v1beta1.types.Scheduling
Scheduling(mapping=None, *, ignore_unknown_fields=False, **kwargs)
All parameters related to queuing and scheduling of custom jobs.
google.cloud.aiplatform_v1beta1.types.Schema
Schema(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Schema is used to define the format of input/output data.
google.cloud.aiplatform_v1beta1.types.Schema.PropertiesEntry
PropertiesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Schema.PropertiesEntry
google.cloud.aiplatform_v1beta1.types.SearchDataItemsRequest
SearchDataItemsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.SearchDataItems.
See more: google.cloud.aiplatform_v1beta1.types.SearchDataItemsRequest
google.cloud.aiplatform_v1beta1.types.SearchDataItemsRequest.OrderByAnnotation
OrderByAnnotation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Expression that allows ranking results based on annotation's property.
See more: google.cloud.aiplatform_v1beta1.types.SearchDataItemsRequest.OrderByAnnotation
google.cloud.aiplatform_v1beta1.types.SearchDataItemsResponse
SearchDataItemsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for DatasetService.SearchDataItems.
See more: google.cloud.aiplatform_v1beta1.types.SearchDataItemsResponse
google.cloud.aiplatform_v1beta1.types.SearchFeaturesRequest
SearchFeaturesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.SearchFeatures.
See more: google.cloud.aiplatform_v1beta1.types.SearchFeaturesRequest
google.cloud.aiplatform_v1beta1.types.SearchFeaturesResponse
SearchFeaturesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreService.SearchFeatures.
See more: google.cloud.aiplatform_v1beta1.types.SearchFeaturesResponse
google.cloud.aiplatform_v1beta1.types.SearchMigratableResourcesRequest
SearchMigratableResourcesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for MigrationService.SearchMigratableResources.
See more: google.cloud.aiplatform_v1beta1.types.SearchMigratableResourcesRequest
google.cloud.aiplatform_v1beta1.types.SearchMigratableResourcesResponse
SearchMigratableResourcesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for MigrationService.SearchMigratableResources.
See more: google.cloud.aiplatform_v1beta1.types.SearchMigratableResourcesResponse
google.cloud.aiplatform_v1beta1.types.SearchModelDeploymentMonitoringStatsAnomaliesRequest
SearchModelDeploymentMonitoringStatsAnomaliesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.
See more: google.cloud.aiplatform_v1beta1.types.SearchModelDeploymentMonitoringStatsAnomaliesRequest
google.cloud.aiplatform_v1beta1.types.SearchModelDeploymentMonitoringStatsAnomaliesRequest.StatsAnomaliesObjective
StatsAnomaliesObjective(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Stats requested for specific objective.
google.cloud.aiplatform_v1beta1.types.SearchModelDeploymentMonitoringStatsAnomaliesResponse
SearchModelDeploymentMonitoringStatsAnomaliesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.
See more: google.cloud.aiplatform_v1beta1.types.SearchModelDeploymentMonitoringStatsAnomaliesResponse
google.cloud.aiplatform_v1beta1.types.SearchNearestEntitiesRequest
SearchNearestEntitiesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The request message for FeatureOnlineStoreService.SearchNearestEntities.
See more: google.cloud.aiplatform_v1beta1.types.SearchNearestEntitiesRequest
google.cloud.aiplatform_v1beta1.types.SearchNearestEntitiesResponse
SearchNearestEntitiesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for FeatureOnlineStoreService.SearchNearestEntities .
See more: google.cloud.aiplatform_v1beta1.types.SearchNearestEntitiesResponse
google.cloud.aiplatform_v1beta1.types.Segment
Segment(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Segment of the content.
google.cloud.aiplatform_v1beta1.types.ServiceAccountSpec
ServiceAccountSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for the use of custom service account to run the workloads.
See more: google.cloud.aiplatform_v1beta1.types.ServiceAccountSpec
google.cloud.aiplatform_v1beta1.types.ShieldedVmConfig
ShieldedVmConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A set of Shielded Instance options.
See more: google.cloud.aiplatform_v1beta1.types.ShieldedVmConfig
google.cloud.aiplatform_v1beta1.types.SmoothGradConfig
SmoothGradConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for SmoothGrad approximation of gradients.
See more: google.cloud.aiplatform_v1beta1.types.SmoothGradConfig
google.cloud.aiplatform_v1beta1.types.SpecialistPool
SpecialistPool(mapping=None, *, ignore_unknown_fields=False, **kwargs)
SpecialistPool represents customers' own workforce to work on their data labeling jobs.
See more: google.cloud.aiplatform_v1beta1.types.SpecialistPool
google.cloud.aiplatform_v1beta1.types.StartNotebookRuntimeOperationMetadata
StartNotebookRuntimeOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Metadata information for NotebookService.StartNotebookRuntime.
See more: google.cloud.aiplatform_v1beta1.types.StartNotebookRuntimeOperationMetadata
google.cloud.aiplatform_v1beta1.types.StartNotebookRuntimeRequest
StartNotebookRuntimeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for NotebookService.StartNotebookRuntime.
See more: google.cloud.aiplatform_v1beta1.types.StartNotebookRuntimeRequest
google.cloud.aiplatform_v1beta1.types.StartNotebookRuntimeResponse
StartNotebookRuntimeResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for NotebookService.StartNotebookRuntime.
See more: google.cloud.aiplatform_v1beta1.types.StartNotebookRuntimeResponse
google.cloud.aiplatform_v1beta1.types.StopTrialRequest
StopTrialRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.StopTrial.
See more: google.cloud.aiplatform_v1beta1.types.StopTrialRequest
google.cloud.aiplatform_v1beta1.types.StratifiedSplit
StratifiedSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns input data to the training, validation, and test sets so
that the distribution of values found in the categorical column (as
specified by the key
field) is mirrored within each split.
See more: google.cloud.aiplatform_v1beta1.types.StratifiedSplit
google.cloud.aiplatform_v1beta1.types.StreamDirectPredictRequest
StreamDirectPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.StreamDirectPredict.
See more: google.cloud.aiplatform_v1beta1.types.StreamDirectPredictRequest
google.cloud.aiplatform_v1beta1.types.StreamDirectPredictResponse
StreamDirectPredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.StreamDirectPredict.
See more: google.cloud.aiplatform_v1beta1.types.StreamDirectPredictResponse
google.cloud.aiplatform_v1beta1.types.StreamDirectRawPredictRequest
StreamDirectRawPredictRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for PredictionService.StreamDirectRawPredict.
See more: google.cloud.aiplatform_v1beta1.types.StreamDirectRawPredictRequest
google.cloud.aiplatform_v1beta1.types.StreamDirectRawPredictResponse
StreamDirectRawPredictResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for PredictionService.StreamDirectRawPredict.
See more: google.cloud.aiplatform_v1beta1.types.StreamDirectRawPredictResponse
google.cloud.aiplatform_v1beta1.types.StreamingFetchFeatureValuesRequest
StreamingFetchFeatureValuesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeatureOnlineStoreService.StreamingFetchFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.StreamingFetchFeatureValuesRequest
google.cloud.aiplatform_v1beta1.types.StreamingFetchFeatureValuesResponse
StreamingFetchFeatureValuesResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for FeatureOnlineStoreService.StreamingFetchFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.StreamingFetchFeatureValuesResponse
google.cloud.aiplatform_v1beta1.types.StreamingPredictRequest
StreamingPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.StreamingPredict.
See more: google.cloud.aiplatform_v1beta1.types.StreamingPredictRequest
google.cloud.aiplatform_v1beta1.types.StreamingPredictResponse
StreamingPredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.StreamingPredict.
See more: google.cloud.aiplatform_v1beta1.types.StreamingPredictResponse
google.cloud.aiplatform_v1beta1.types.StreamingRawPredictRequest
StreamingRawPredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for PredictionService.StreamingRawPredict.
See more: google.cloud.aiplatform_v1beta1.types.StreamingRawPredictRequest
google.cloud.aiplatform_v1beta1.types.StreamingRawPredictResponse
StreamingRawPredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for PredictionService.StreamingRawPredict.
See more: google.cloud.aiplatform_v1beta1.types.StreamingRawPredictResponse
google.cloud.aiplatform_v1beta1.types.StreamingReadFeatureValuesRequest
StreamingReadFeatureValuesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for [FeaturestoreOnlineServingService.StreamingFeatureValuesRead][].
See more: google.cloud.aiplatform_v1beta1.types.StreamingReadFeatureValuesRequest
google.cloud.aiplatform_v1beta1.types.StringArray
StringArray(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of string values.
google.cloud.aiplatform_v1beta1.types.Study
Study(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A message representing a Study.
google.cloud.aiplatform_v1beta1.types.Study.State
State(value)
Describes the Study state.
google.cloud.aiplatform_v1beta1.types.StudySpec
StudySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents specification of a Study.
google.cloud.aiplatform_v1beta1.types.StudySpec.Algorithm
Algorithm(value)
The available search algorithms for the Study.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.Algorithm
google.cloud.aiplatform_v1beta1.types.StudySpec.ConvexAutomatedStoppingSpec
ConvexAutomatedStoppingSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for ConvexAutomatedStoppingSpec.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.ConvexAutomatedStoppingSpec
google.cloud.aiplatform_v1beta1.types.StudySpec.ConvexStopConfig
ConvexStopConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for ConvexStopPolicy.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.ConvexStopConfig
google.cloud.aiplatform_v1beta1.types.StudySpec.DecayCurveAutomatedStoppingSpec
DecayCurveAutomatedStoppingSpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The decay curve automated stopping rule builds a Gaussian Process Regressor to predict the final objective value of a Trial based on the already completed Trials and the intermediate measurements of the current Trial.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.DecayCurveAutomatedStoppingSpec
google.cloud.aiplatform_v1beta1.types.StudySpec.MeasurementSelectionType
MeasurementSelectionType(value)
This indicates which measurement to use if/when the service automatically selects the final measurement from previously reported intermediate measurements.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.MeasurementSelectionType
google.cloud.aiplatform_v1beta1.types.StudySpec.MedianAutomatedStoppingSpec
MedianAutomatedStoppingSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The median automated stopping rule stops a pending Trial if the Trial's best objective_value is strictly below the median 'performance' of all completed Trials reported up to the Trial's last measurement.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.MedianAutomatedStoppingSpec
google.cloud.aiplatform_v1beta1.types.StudySpec.MetricSpec
MetricSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a metric to optimize.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.MetricSpec
google.cloud.aiplatform_v1beta1.types.StudySpec.MetricSpec.GoalType
GoalType(value)
The available types of optimization goals.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.MetricSpec.GoalType
google.cloud.aiplatform_v1beta1.types.StudySpec.MetricSpec.SafetyMetricConfig
SafetyMetricConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Used in safe optimization to specify threshold levels and risk tolerance.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.MetricSpec.SafetyMetricConfig
google.cloud.aiplatform_v1beta1.types.StudySpec.ObservationNoise
ObservationNoise(value)
Describes the noise level of the repeated observations.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.ObservationNoise
google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec
ParameterSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a single parameter to optimize.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec
google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.CategoricalValueSpec
CategoricalValueSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Value specification for a parameter in CATEGORICAL
type.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.CategoricalValueSpec
google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.ConditionalParameterSpec
ConditionalParameterSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a parameter spec with condition from its parent parameter.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.ConditionalParameterSpec
google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.ConditionalParameterSpec.CategoricalValueCondition
CategoricalValueCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec to match categorical values from parent parameter.
google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.ConditionalParameterSpec.DiscreteValueCondition
DiscreteValueCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec to match discrete values from parent parameter.
google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.ConditionalParameterSpec.IntValueCondition
IntValueCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec to match integer values from parent parameter.
google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.DiscreteValueSpec
DiscreteValueSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Value specification for a parameter in DISCRETE
type.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.DiscreteValueSpec
google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.DoubleValueSpec
DoubleValueSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Value specification for a parameter in DOUBLE
type.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.DoubleValueSpec
google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.IntegerValueSpec
IntegerValueSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Value specification for a parameter in INTEGER
type.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.IntegerValueSpec
google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.ScaleType
ScaleType(value)
The type of scaling that should be applied to this parameter.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.ParameterSpec.ScaleType
google.cloud.aiplatform_v1beta1.types.StudySpec.StudyStoppingConfig
StudyStoppingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The configuration (stopping conditions) for automated stopping of a Study.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.StudyStoppingConfig
google.cloud.aiplatform_v1beta1.types.StudySpec.TransferLearningConfig
TransferLearningConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
This contains flag for manually disabling transfer learning for a study.
See more: google.cloud.aiplatform_v1beta1.types.StudySpec.TransferLearningConfig
google.cloud.aiplatform_v1beta1.types.StudyTimeConstraint
StudyTimeConstraint(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Time-based Constraint for Study.
See more: google.cloud.aiplatform_v1beta1.types.StudyTimeConstraint
google.cloud.aiplatform_v1beta1.types.SuggestTrialsMetadata
SuggestTrialsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Details of operations that perform Trials suggestion.
See more: google.cloud.aiplatform_v1beta1.types.SuggestTrialsMetadata
google.cloud.aiplatform_v1beta1.types.SuggestTrialsRequest
SuggestTrialsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VizierService.SuggestTrials.
See more: google.cloud.aiplatform_v1beta1.types.SuggestTrialsRequest
google.cloud.aiplatform_v1beta1.types.SuggestTrialsResponse
SuggestTrialsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VizierService.SuggestTrials.
See more: google.cloud.aiplatform_v1beta1.types.SuggestTrialsResponse
google.cloud.aiplatform_v1beta1.types.SummarizationHelpfulnessInput
SummarizationHelpfulnessInput(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Input for summarization helpfulness metric.
See more: google.cloud.aiplatform_v1beta1.types.SummarizationHelpfulnessInput
google.cloud.aiplatform_v1beta1.types.SummarizationHelpfulnessInstance
SummarizationHelpfulnessInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for summarization helpfulness instance.
See more: google.cloud.aiplatform_v1beta1.types.SummarizationHelpfulnessInstance
google.cloud.aiplatform_v1beta1.types.SummarizationHelpfulnessResult
SummarizationHelpfulnessResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for summarization helpfulness result.
See more: google.cloud.aiplatform_v1beta1.types.SummarizationHelpfulnessResult
google.cloud.aiplatform_v1beta1.types.SummarizationHelpfulnessSpec
SummarizationHelpfulnessSpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for summarization helpfulness score metric.
See more: google.cloud.aiplatform_v1beta1.types.SummarizationHelpfulnessSpec
google.cloud.aiplatform_v1beta1.types.SummarizationQualityInput
SummarizationQualityInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for summarization quality metric.
See more: google.cloud.aiplatform_v1beta1.types.SummarizationQualityInput
google.cloud.aiplatform_v1beta1.types.SummarizationQualityInstance
SummarizationQualityInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for summarization quality instance.
See more: google.cloud.aiplatform_v1beta1.types.SummarizationQualityInstance
google.cloud.aiplatform_v1beta1.types.SummarizationQualityResult
SummarizationQualityResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for summarization quality result.
See more: google.cloud.aiplatform_v1beta1.types.SummarizationQualityResult
google.cloud.aiplatform_v1beta1.types.SummarizationQualitySpec
SummarizationQualitySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for summarization quality score metric.
See more: google.cloud.aiplatform_v1beta1.types.SummarizationQualitySpec
google.cloud.aiplatform_v1beta1.types.SummarizationVerbosityInput
SummarizationVerbosityInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for summarization verbosity metric.
See more: google.cloud.aiplatform_v1beta1.types.SummarizationVerbosityInput
google.cloud.aiplatform_v1beta1.types.SummarizationVerbosityInstance
SummarizationVerbosityInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for summarization verbosity instance.
See more: google.cloud.aiplatform_v1beta1.types.SummarizationVerbosityInstance
google.cloud.aiplatform_v1beta1.types.SummarizationVerbosityResult
SummarizationVerbosityResult(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for summarization verbosity result.
See more: google.cloud.aiplatform_v1beta1.types.SummarizationVerbosityResult
google.cloud.aiplatform_v1beta1.types.SummarizationVerbositySpec
SummarizationVerbositySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for summarization verbosity score metric.
See more: google.cloud.aiplatform_v1beta1.types.SummarizationVerbositySpec
google.cloud.aiplatform_v1beta1.types.SyncFeatureViewRequest
SyncFeatureViewRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.SyncFeatureView.
See more: google.cloud.aiplatform_v1beta1.types.SyncFeatureViewRequest
google.cloud.aiplatform_v1beta1.types.SyncFeatureViewResponse
SyncFeatureViewResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Respose message for FeatureOnlineStoreAdminService.SyncFeatureView.
See more: google.cloud.aiplatform_v1beta1.types.SyncFeatureViewResponse
google.cloud.aiplatform_v1beta1.types.TFRecordDestination
TFRecordDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The storage details for TFRecord output content.
See more: google.cloud.aiplatform_v1beta1.types.TFRecordDestination
google.cloud.aiplatform_v1beta1.types.Tensor
Tensor(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A tensor value type.
google.cloud.aiplatform_v1beta1.types.Tensor.DataType
DataType(value)
Data type of the tensor.
See more: google.cloud.aiplatform_v1beta1.types.Tensor.DataType
google.cloud.aiplatform_v1beta1.types.Tensor.StructValEntry
StructValEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Tensor.StructValEntry
google.cloud.aiplatform_v1beta1.types.Tensorboard
Tensorboard(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tensorboard is a physical database that stores users' training metrics.
google.cloud.aiplatform_v1beta1.types.Tensorboard.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Tensorboard.LabelsEntry
google.cloud.aiplatform_v1beta1.types.TensorboardBlob
TensorboardBlob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
One blob (e.g, image, graph) viewable on a blob metric plot.
See more: google.cloud.aiplatform_v1beta1.types.TensorboardBlob
google.cloud.aiplatform_v1beta1.types.TensorboardBlobSequence
TensorboardBlobSequence(mapping=None, *, ignore_unknown_fields=False, **kwargs)
One point viewable on a blob metric plot, but mostly just a wrapper
message to work around repeated fields can't be used directly within
oneof
fields.
See more: google.cloud.aiplatform_v1beta1.types.TensorboardBlobSequence
google.cloud.aiplatform_v1beta1.types.TensorboardExperiment
TensorboardExperiment(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.
See more: google.cloud.aiplatform_v1beta1.types.TensorboardExperiment
google.cloud.aiplatform_v1beta1.types.TensorboardExperiment.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.TensorboardExperiment.LabelsEntry
google.cloud.aiplatform_v1beta1.types.TensorboardRun
TensorboardRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)
TensorboardRun maps to a specific execution of a training job with a given set of hyperparameter values, model definition, dataset, etc .
See more: google.cloud.aiplatform_v1beta1.types.TensorboardRun
google.cloud.aiplatform_v1beta1.types.TensorboardRun.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.TensorboardRun.LabelsEntry
google.cloud.aiplatform_v1beta1.types.TensorboardTensor
TensorboardTensor(mapping=None, *, ignore_unknown_fields=False, **kwargs)
One point viewable on a tensor metric plot.
See more: google.cloud.aiplatform_v1beta1.types.TensorboardTensor
google.cloud.aiplatform_v1beta1.types.TensorboardTimeSeries
TensorboardTimeSeries(mapping=None, *, ignore_unknown_fields=False, **kwargs)
TensorboardTimeSeries maps to times series produced in training runs .
See more: google.cloud.aiplatform_v1beta1.types.TensorboardTimeSeries
google.cloud.aiplatform_v1beta1.types.TensorboardTimeSeries.Metadata
Metadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Describes metadata for a TensorboardTimeSeries.
See more: google.cloud.aiplatform_v1beta1.types.TensorboardTimeSeries.Metadata
google.cloud.aiplatform_v1beta1.types.TensorboardTimeSeries.ValueType
ValueType(value)
An enum representing the value type of a TensorboardTimeSeries.
See more: google.cloud.aiplatform_v1beta1.types.TensorboardTimeSeries.ValueType
google.cloud.aiplatform_v1beta1.types.ThresholdConfig
ThresholdConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The config for feature monitoring threshold.
See more: google.cloud.aiplatform_v1beta1.types.ThresholdConfig
google.cloud.aiplatform_v1beta1.types.TimeSeriesData
TimeSeriesData(mapping=None, *, ignore_unknown_fields=False, **kwargs)
All the data stored in a TensorboardTimeSeries.
See more: google.cloud.aiplatform_v1beta1.types.TimeSeriesData
google.cloud.aiplatform_v1beta1.types.TimeSeriesDataPoint
TimeSeriesDataPoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A TensorboardTimeSeries data point.
See more: google.cloud.aiplatform_v1beta1.types.TimeSeriesDataPoint
google.cloud.aiplatform_v1beta1.types.TimestampSplit
TimestampSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Assigns input data to training, validation, and test sets based on a provided timestamps.
See more: google.cloud.aiplatform_v1beta1.types.TimestampSplit
google.cloud.aiplatform_v1beta1.types.TokensInfo
TokensInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tokens info with a list of tokens and the corresponding list of token ids.
google.cloud.aiplatform_v1beta1.types.Tool
Tool(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tool details that the model may use to generate response.
google.cloud.aiplatform_v1beta1.types.ToolCallValidInput
ToolCallValidInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for tool call valid metric.
See more: google.cloud.aiplatform_v1beta1.types.ToolCallValidInput
google.cloud.aiplatform_v1beta1.types.ToolCallValidInstance
ToolCallValidInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for tool call valid instance.
See more: google.cloud.aiplatform_v1beta1.types.ToolCallValidInstance
google.cloud.aiplatform_v1beta1.types.ToolCallValidMetricValue
ToolCallValidMetricValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tool call valid metric value for an instance.
See more: google.cloud.aiplatform_v1beta1.types.ToolCallValidMetricValue
google.cloud.aiplatform_v1beta1.types.ToolCallValidResults
ToolCallValidResults(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Results for tool call valid metric.
See more: google.cloud.aiplatform_v1beta1.types.ToolCallValidResults
google.cloud.aiplatform_v1beta1.types.ToolCallValidSpec
ToolCallValidSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for tool call valid metric.
See more: google.cloud.aiplatform_v1beta1.types.ToolCallValidSpec
google.cloud.aiplatform_v1beta1.types.ToolConfig
ToolConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tool config.
google.cloud.aiplatform_v1beta1.types.ToolNameMatchInput
ToolNameMatchInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for tool name match metric.
See more: google.cloud.aiplatform_v1beta1.types.ToolNameMatchInput
google.cloud.aiplatform_v1beta1.types.ToolNameMatchInstance
ToolNameMatchInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for tool name match instance.
See more: google.cloud.aiplatform_v1beta1.types.ToolNameMatchInstance
google.cloud.aiplatform_v1beta1.types.ToolNameMatchMetricValue
ToolNameMatchMetricValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Tool name match metric value for an instance.
See more: google.cloud.aiplatform_v1beta1.types.ToolNameMatchMetricValue
google.cloud.aiplatform_v1beta1.types.ToolNameMatchResults
ToolNameMatchResults(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Results for tool name match metric.
See more: google.cloud.aiplatform_v1beta1.types.ToolNameMatchResults
google.cloud.aiplatform_v1beta1.types.ToolNameMatchSpec
ToolNameMatchSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for tool name match metric.
See more: google.cloud.aiplatform_v1beta1.types.ToolNameMatchSpec
google.cloud.aiplatform_v1beta1.types.ToolParameterKVMatchInput
ToolParameterKVMatchInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for tool parameter key value match metric.
See more: google.cloud.aiplatform_v1beta1.types.ToolParameterKVMatchInput
google.cloud.aiplatform_v1beta1.types.ToolParameterKVMatchInstance
ToolParameterKVMatchInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for tool parameter key value match instance.
See more: google.cloud.aiplatform_v1beta1.types.ToolParameterKVMatchInstance
google.cloud.aiplatform_v1beta1.types.ToolParameterKVMatchMetricValue
ToolParameterKVMatchMetricValue(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Tool parameter key value match metric value for an instance.
See more: google.cloud.aiplatform_v1beta1.types.ToolParameterKVMatchMetricValue
google.cloud.aiplatform_v1beta1.types.ToolParameterKVMatchResults
ToolParameterKVMatchResults(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Results for tool parameter key value match metric.
See more: google.cloud.aiplatform_v1beta1.types.ToolParameterKVMatchResults
google.cloud.aiplatform_v1beta1.types.ToolParameterKVMatchSpec
ToolParameterKVMatchSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for tool parameter key value match metric.
See more: google.cloud.aiplatform_v1beta1.types.ToolParameterKVMatchSpec
google.cloud.aiplatform_v1beta1.types.ToolParameterKeyMatchInput
ToolParameterKeyMatchInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Input for tool parameter key match metric.
See more: google.cloud.aiplatform_v1beta1.types.ToolParameterKeyMatchInput
google.cloud.aiplatform_v1beta1.types.ToolParameterKeyMatchInstance
ToolParameterKeyMatchInstance(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Spec for tool parameter key match instance.
See more: google.cloud.aiplatform_v1beta1.types.ToolParameterKeyMatchInstance
google.cloud.aiplatform_v1beta1.types.ToolParameterKeyMatchMetricValue
ToolParameterKeyMatchMetricValue(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Tool parameter key match metric value for an instance.
See more: google.cloud.aiplatform_v1beta1.types.ToolParameterKeyMatchMetricValue
google.cloud.aiplatform_v1beta1.types.ToolParameterKeyMatchResults
ToolParameterKeyMatchResults(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Results for tool parameter key match metric.
See more: google.cloud.aiplatform_v1beta1.types.ToolParameterKeyMatchResults
google.cloud.aiplatform_v1beta1.types.ToolParameterKeyMatchSpec
ToolParameterKeyMatchSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Spec for tool parameter key match metric.
See more: google.cloud.aiplatform_v1beta1.types.ToolParameterKeyMatchSpec
google.cloud.aiplatform_v1beta1.types.ToolUseExample
ToolUseExample(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A single example of the tool usage.
See more: google.cloud.aiplatform_v1beta1.types.ToolUseExample
google.cloud.aiplatform_v1beta1.types.ToolUseExample.ExtensionOperation
ExtensionOperation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Identifies one operation of the extension.
See more: google.cloud.aiplatform_v1beta1.types.ToolUseExample.ExtensionOperation
google.cloud.aiplatform_v1beta1.types.TrainingConfig
TrainingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
CMLE training config.
See more: google.cloud.aiplatform_v1beta1.types.TrainingConfig
google.cloud.aiplatform_v1beta1.types.TrainingPipeline
TrainingPipeline(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The TrainingPipeline orchestrates tasks associated with training a Model.
See more: google.cloud.aiplatform_v1beta1.types.TrainingPipeline
google.cloud.aiplatform_v1beta1.types.TrainingPipeline.LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.TrainingPipeline.LabelsEntry
google.cloud.aiplatform_v1beta1.types.Trial
Trial(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A message representing a Trial.
google.cloud.aiplatform_v1beta1.types.Trial.Parameter
Parameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A message representing a parameter to be tuned.
See more: google.cloud.aiplatform_v1beta1.types.Trial.Parameter
google.cloud.aiplatform_v1beta1.types.Trial.State
State(value)
Describes a Trial state.
google.cloud.aiplatform_v1beta1.types.Trial.WebAccessUrisEntry
WebAccessUrisEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.Trial.WebAccessUrisEntry
google.cloud.aiplatform_v1beta1.types.TrialContext
TrialContext(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Next ID: 3 .
See more: google.cloud.aiplatform_v1beta1.types.TrialContext
google.cloud.aiplatform_v1beta1.types.Type
Type(value)
Type contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/.
google.cloud.aiplatform_v1beta1.types.UndeployIndexOperationMetadata
UndeployIndexOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for IndexEndpointService.UndeployIndex.
See more: google.cloud.aiplatform_v1beta1.types.UndeployIndexOperationMetadata
google.cloud.aiplatform_v1beta1.types.UndeployIndexRequest
UndeployIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.UndeployIndex.
See more: google.cloud.aiplatform_v1beta1.types.UndeployIndexRequest
google.cloud.aiplatform_v1beta1.types.UndeployIndexResponse
UndeployIndexResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexEndpointService.UndeployIndex.
See more: google.cloud.aiplatform_v1beta1.types.UndeployIndexResponse
google.cloud.aiplatform_v1beta1.types.UndeployModelOperationMetadata
UndeployModelOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for EndpointService.UndeployModel.
See more: google.cloud.aiplatform_v1beta1.types.UndeployModelOperationMetadata
google.cloud.aiplatform_v1beta1.types.UndeployModelRequest
UndeployModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.UndeployModel.
See more: google.cloud.aiplatform_v1beta1.types.UndeployModelRequest
google.cloud.aiplatform_v1beta1.types.UndeployModelRequest.TrafficSplitEntry
TrafficSplitEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.UndeployModelRequest.TrafficSplitEntry
google.cloud.aiplatform_v1beta1.types.UndeployModelResponse
UndeployModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for EndpointService.UndeployModel.
See more: google.cloud.aiplatform_v1beta1.types.UndeployModelResponse
google.cloud.aiplatform_v1beta1.types.UnmanagedContainerModel
UnmanagedContainerModel(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains model information necessary to perform batch prediction without requiring a full model import.
See more: google.cloud.aiplatform_v1beta1.types.UnmanagedContainerModel
google.cloud.aiplatform_v1beta1.types.UpdateArtifactRequest
UpdateArtifactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.UpdateArtifact.
See more: google.cloud.aiplatform_v1beta1.types.UpdateArtifactRequest
google.cloud.aiplatform_v1beta1.types.UpdateContextRequest
UpdateContextRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.UpdateContext.
See more: google.cloud.aiplatform_v1beta1.types.UpdateContextRequest
google.cloud.aiplatform_v1beta1.types.UpdateDatasetRequest
UpdateDatasetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for DatasetService.UpdateDataset.
See more: google.cloud.aiplatform_v1beta1.types.UpdateDatasetRequest
google.cloud.aiplatform_v1beta1.types.UpdateDeploymentResourcePoolOperationMetadata
UpdateDeploymentResourcePoolOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for UpdateDeploymentResourcePool method.
See more: google.cloud.aiplatform_v1beta1.types.UpdateDeploymentResourcePoolOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpdateEndpointRequest
UpdateEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for EndpointService.UpdateEndpoint.
See more: google.cloud.aiplatform_v1beta1.types.UpdateEndpointRequest
google.cloud.aiplatform_v1beta1.types.UpdateEntityTypeRequest
UpdateEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.UpdateEntityType.
See more: google.cloud.aiplatform_v1beta1.types.UpdateEntityTypeRequest
google.cloud.aiplatform_v1beta1.types.UpdateExecutionRequest
UpdateExecutionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for MetadataService.UpdateExecution.
See more: google.cloud.aiplatform_v1beta1.types.UpdateExecutionRequest
google.cloud.aiplatform_v1beta1.types.UpdateExplanationDatasetOperationMetadata
UpdateExplanationDatasetOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for ModelService.UpdateExplanationDataset.
See more: google.cloud.aiplatform_v1beta1.types.UpdateExplanationDatasetOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpdateExplanationDatasetRequest
UpdateExplanationDatasetRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for ModelService.UpdateExplanationDataset.
See more: google.cloud.aiplatform_v1beta1.types.UpdateExplanationDatasetRequest
google.cloud.aiplatform_v1beta1.types.UpdateExplanationDatasetResponse
UpdateExplanationDatasetResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message of ModelService.UpdateExplanationDataset operation.
See more: google.cloud.aiplatform_v1beta1.types.UpdateExplanationDatasetResponse
google.cloud.aiplatform_v1beta1.types.UpdateExtensionRequest
UpdateExtensionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ExtensionRegistryService.UpdateExtension.
See more: google.cloud.aiplatform_v1beta1.types.UpdateExtensionRequest
google.cloud.aiplatform_v1beta1.types.UpdateFeatureGroupOperationMetadata
UpdateFeatureGroupOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update FeatureGroup.
See more: google.cloud.aiplatform_v1beta1.types.UpdateFeatureGroupOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpdateFeatureGroupRequest
UpdateFeatureGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureRegistryService.UpdateFeatureGroup.
See more: google.cloud.aiplatform_v1beta1.types.UpdateFeatureGroupRequest
google.cloud.aiplatform_v1beta1.types.UpdateFeatureOnlineStoreOperationMetadata
UpdateFeatureOnlineStoreOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update FeatureOnlineStore.
See more: google.cloud.aiplatform_v1beta1.types.UpdateFeatureOnlineStoreOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpdateFeatureOnlineStoreRequest
UpdateFeatureOnlineStoreRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for FeatureOnlineStoreAdminService.UpdateFeatureOnlineStore.
See more: google.cloud.aiplatform_v1beta1.types.UpdateFeatureOnlineStoreRequest
google.cloud.aiplatform_v1beta1.types.UpdateFeatureOperationMetadata
UpdateFeatureOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update Feature.
See more: google.cloud.aiplatform_v1beta1.types.UpdateFeatureOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpdateFeatureRequest
UpdateFeatureRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.UpdateFeature.
See more: google.cloud.aiplatform_v1beta1.types.UpdateFeatureRequest
google.cloud.aiplatform_v1beta1.types.UpdateFeatureViewOperationMetadata
UpdateFeatureViewOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update FeatureView.
See more: google.cloud.aiplatform_v1beta1.types.UpdateFeatureViewOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpdateFeatureViewRequest
UpdateFeatureViewRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeatureOnlineStoreAdminService.UpdateFeatureView.
See more: google.cloud.aiplatform_v1beta1.types.UpdateFeatureViewRequest
google.cloud.aiplatform_v1beta1.types.UpdateFeaturestoreOperationMetadata
UpdateFeaturestoreOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update Featurestore.
See more: google.cloud.aiplatform_v1beta1.types.UpdateFeaturestoreOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpdateFeaturestoreRequest
UpdateFeaturestoreRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreService.UpdateFeaturestore.
See more: google.cloud.aiplatform_v1beta1.types.UpdateFeaturestoreRequest
google.cloud.aiplatform_v1beta1.types.UpdateIndexEndpointRequest
UpdateIndexEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexEndpointService.UpdateIndexEndpoint.
See more: google.cloud.aiplatform_v1beta1.types.UpdateIndexEndpointRequest
google.cloud.aiplatform_v1beta1.types.UpdateIndexOperationMetadata
UpdateIndexOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for IndexService.UpdateIndex.
See more: google.cloud.aiplatform_v1beta1.types.UpdateIndexOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpdateIndexRequest
UpdateIndexRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.UpdateIndex.
See more: google.cloud.aiplatform_v1beta1.types.UpdateIndexRequest
google.cloud.aiplatform_v1beta1.types.UpdateModelDeploymentMonitoringJobOperationMetadata
UpdateModelDeploymentMonitoringJobOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation information for JobService.UpdateModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1beta1.types.UpdateModelDeploymentMonitoringJobOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpdateModelDeploymentMonitoringJobRequest
UpdateModelDeploymentMonitoringJobRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for JobService.UpdateModelDeploymentMonitoringJob.
See more: google.cloud.aiplatform_v1beta1.types.UpdateModelDeploymentMonitoringJobRequest
google.cloud.aiplatform_v1beta1.types.UpdateModelRequest
UpdateModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.UpdateModel.
See more: google.cloud.aiplatform_v1beta1.types.UpdateModelRequest
google.cloud.aiplatform_v1beta1.types.UpdatePersistentResourceOperationMetadata
UpdatePersistentResourceOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update PersistentResource.
See more: google.cloud.aiplatform_v1beta1.types.UpdatePersistentResourceOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpdatePersistentResourceRequest
UpdatePersistentResourceRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for UpdatePersistentResource method.
See more: google.cloud.aiplatform_v1beta1.types.UpdatePersistentResourceRequest
google.cloud.aiplatform_v1beta1.types.UpdateScheduleRequest
UpdateScheduleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ScheduleService.UpdateSchedule.
See more: google.cloud.aiplatform_v1beta1.types.UpdateScheduleRequest
google.cloud.aiplatform_v1beta1.types.UpdateSpecialistPoolOperationMetadata
UpdateSpecialistPoolOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Runtime operation metadata for SpecialistPoolService.UpdateSpecialistPool.
See more: google.cloud.aiplatform_v1beta1.types.UpdateSpecialistPoolOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpdateSpecialistPoolRequest
UpdateSpecialistPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for SpecialistPoolService.UpdateSpecialistPool.
See more: google.cloud.aiplatform_v1beta1.types.UpdateSpecialistPoolRequest
google.cloud.aiplatform_v1beta1.types.UpdateTensorboardExperimentRequest
UpdateTensorboardExperimentRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.UpdateTensorboardExperiment.
See more: google.cloud.aiplatform_v1beta1.types.UpdateTensorboardExperimentRequest
google.cloud.aiplatform_v1beta1.types.UpdateTensorboardOperationMetadata
UpdateTensorboardOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of operations that perform update Tensorboard.
See more: google.cloud.aiplatform_v1beta1.types.UpdateTensorboardOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpdateTensorboardRequest
UpdateTensorboardRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.UpdateTensorboard.
See more: google.cloud.aiplatform_v1beta1.types.UpdateTensorboardRequest
google.cloud.aiplatform_v1beta1.types.UpdateTensorboardRunRequest
UpdateTensorboardRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for TensorboardService.UpdateTensorboardRun.
See more: google.cloud.aiplatform_v1beta1.types.UpdateTensorboardRunRequest
google.cloud.aiplatform_v1beta1.types.UpdateTensorboardTimeSeriesRequest
UpdateTensorboardTimeSeriesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.UpdateTensorboardTimeSeries.
See more: google.cloud.aiplatform_v1beta1.types.UpdateTensorboardTimeSeriesRequest
google.cloud.aiplatform_v1beta1.types.UpgradeNotebookRuntimeOperationMetadata
UpgradeNotebookRuntimeOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Metadata information for NotebookService.UpgradeNotebookRuntime.
See more: google.cloud.aiplatform_v1beta1.types.UpgradeNotebookRuntimeOperationMetadata
google.cloud.aiplatform_v1beta1.types.UpgradeNotebookRuntimeRequest
UpgradeNotebookRuntimeRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for NotebookService.UpgradeNotebookRuntime.
See more: google.cloud.aiplatform_v1beta1.types.UpgradeNotebookRuntimeRequest
google.cloud.aiplatform_v1beta1.types.UpgradeNotebookRuntimeResponse
UpgradeNotebookRuntimeResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for NotebookService.UpgradeNotebookRuntime.
See more: google.cloud.aiplatform_v1beta1.types.UpgradeNotebookRuntimeResponse
google.cloud.aiplatform_v1beta1.types.UploadModelOperationMetadata
UploadModelOperationMetadata(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Details of ModelService.UploadModel operation.
See more: google.cloud.aiplatform_v1beta1.types.UploadModelOperationMetadata
google.cloud.aiplatform_v1beta1.types.UploadModelRequest
UploadModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for ModelService.UploadModel.
See more: google.cloud.aiplatform_v1beta1.types.UploadModelRequest
google.cloud.aiplatform_v1beta1.types.UploadModelResponse
UploadModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message of ModelService.UploadModel operation.
See more: google.cloud.aiplatform_v1beta1.types.UploadModelResponse
google.cloud.aiplatform_v1beta1.types.UploadRagFileConfig
UploadRagFileConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Config for uploading RagFile.
See more: google.cloud.aiplatform_v1beta1.types.UploadRagFileConfig
google.cloud.aiplatform_v1beta1.types.UploadRagFileRequest
UploadRagFileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VertexRagDataService.UploadRagFile.
See more: google.cloud.aiplatform_v1beta1.types.UploadRagFileRequest
google.cloud.aiplatform_v1beta1.types.UploadRagFileResponse
UploadRagFileResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for VertexRagDataService.UploadRagFile.
See more: google.cloud.aiplatform_v1beta1.types.UploadRagFileResponse
google.cloud.aiplatform_v1beta1.types.UpsertDatapointsRequest
UpsertDatapointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for IndexService.UpsertDatapoints .
See more: google.cloud.aiplatform_v1beta1.types.UpsertDatapointsRequest
google.cloud.aiplatform_v1beta1.types.UpsertDatapointsResponse
UpsertDatapointsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for IndexService.UpsertDatapoints .
See more: google.cloud.aiplatform_v1beta1.types.UpsertDatapointsResponse
google.cloud.aiplatform_v1beta1.types.UserActionReference
UserActionReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)
References an API call.
See more: google.cloud.aiplatform_v1beta1.types.UserActionReference
google.cloud.aiplatform_v1beta1.types.Value
Value(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Value is the value of the field.
google.cloud.aiplatform_v1beta1.types.VertexAISearch
VertexAISearch(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Retrieve from Vertex AI Search datastore for grounding.
See more: google.cloud.aiplatform_v1beta1.types.VertexAISearch
google.cloud.aiplatform_v1beta1.types.VertexRagStore
VertexRagStore(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Retrieve from Vertex RAG Store for grounding.
See more: google.cloud.aiplatform_v1beta1.types.VertexRagStore
google.cloud.aiplatform_v1beta1.types.VideoMetadata
VideoMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Metadata describes the input video content.
See more: google.cloud.aiplatform_v1beta1.types.VideoMetadata
google.cloud.aiplatform_v1beta1.types.WorkerPoolSpec
WorkerPoolSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of a worker pool in a job.
See more: google.cloud.aiplatform_v1beta1.types.WorkerPoolSpec
google.cloud.aiplatform_v1beta1.types.WriteFeatureValuesPayload
WriteFeatureValuesPayload(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains Feature values to be written for a specific entity.
See more: google.cloud.aiplatform_v1beta1.types.WriteFeatureValuesPayload
google.cloud.aiplatform_v1beta1.types.WriteFeatureValuesPayload.FeatureValuesEntry
FeatureValuesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
See more: google.cloud.aiplatform_v1beta1.types.WriteFeatureValuesPayload.FeatureValuesEntry
google.cloud.aiplatform_v1beta1.types.WriteFeatureValuesRequest
WriteFeatureValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for FeaturestoreOnlineServingService.WriteFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.WriteFeatureValuesRequest
google.cloud.aiplatform_v1beta1.types.WriteFeatureValuesResponse
WriteFeatureValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response message for FeaturestoreOnlineServingService.WriteFeatureValues.
See more: google.cloud.aiplatform_v1beta1.types.WriteFeatureValuesResponse
google.cloud.aiplatform_v1beta1.types.WriteTensorboardExperimentDataRequest
WriteTensorboardExperimentDataRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.WriteTensorboardExperimentData.
See more: google.cloud.aiplatform_v1beta1.types.WriteTensorboardExperimentDataRequest
google.cloud.aiplatform_v1beta1.types.WriteTensorboardExperimentDataResponse
WriteTensorboardExperimentDataResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.WriteTensorboardExperimentData.
See more: google.cloud.aiplatform_v1beta1.types.WriteTensorboardExperimentDataResponse
google.cloud.aiplatform_v1beta1.types.WriteTensorboardRunDataRequest
WriteTensorboardRunDataRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Request message for TensorboardService.WriteTensorboardRunData.
See more: google.cloud.aiplatform_v1beta1.types.WriteTensorboardRunDataRequest
google.cloud.aiplatform_v1beta1.types.WriteTensorboardRunDataResponse
WriteTensorboardRunDataResponse(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
Response message for TensorboardService.WriteTensorboardRunData.
See more: google.cloud.aiplatform_v1beta1.types.WriteTensorboardRunDataResponse
google.cloud.aiplatform_v1beta1.types.XraiAttribution
XraiAttribution(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure.
See more: google.cloud.aiplatform_v1beta1.types.XraiAttribution
vertexai.generative_models.ChatSession.send_message
send_message(
content: typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
typing.List[
typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
]
],
],
*,
generation_config: typing.Optional[
typing.Union[
vertexai.generative_models._generative_models.GenerationConfig,
typing.Dict[str, typing.Any],
]
] = None,
safety_settings: typing.Optional[
typing.Union[
typing.List[vertexai.generative_models._generative_models.SafetySetting],
typing.Dict[
google.cloud.aiplatform_v1beta1.types.content.HarmCategory,
google.cloud.aiplatform_v1beta1.types.content.SafetySetting.HarmBlockThreshold,
],
]
] = None,
tools: typing.Optional[
typing.List[vertexai.generative_models._generative_models.Tool]
] = None,
stream: bool = False
) -> typing.Union[
vertexai.generative_models._generative_models.GenerationResponse,
typing.Iterable[vertexai.generative_models._generative_models.GenerationResponse],
]
Generates content.
See more: vertexai.generative_models.ChatSession.send_message
vertexai.generative_models.ChatSession.send_message_async
send_message_async(
content: typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
typing.List[
typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
]
],
],
*,
generation_config: typing.Optional[
typing.Union[
vertexai.generative_models._generative_models.GenerationConfig,
typing.Dict[str, typing.Any],
]
] = None,
safety_settings: typing.Optional[
typing.Union[
typing.List[vertexai.generative_models._generative_models.SafetySetting],
typing.Dict[
google.cloud.aiplatform_v1beta1.types.content.HarmCategory,
google.cloud.aiplatform_v1beta1.types.content.SafetySetting.HarmBlockThreshold,
],
]
] = None,
tools: typing.Optional[
typing.List[vertexai.generative_models._generative_models.Tool]
] = None,
stream: bool = False
) -> typing.Union[
typing.Awaitable[vertexai.generative_models._generative_models.GenerationResponse],
typing.Awaitable[
typing.AsyncIterable[
vertexai.generative_models._generative_models.GenerationResponse
]
],
]
Generates content asynchronously.
See more: vertexai.generative_models.ChatSession.send_message_async
vertexai.generative_models.FunctionDeclaration
FunctionDeclaration(
*,
name: str,
parameters: typing.Dict[str, typing.Any],
description: typing.Optional[str] = None
)
Constructs a FunctionDeclaration.
vertexai.generative_models.GenerationConfig
GenerationConfig(
*,
temperature: typing.Optional[float] = None,
top_p: typing.Optional[float] = None,
top_k: typing.Optional[int] = None,
candidate_count: typing.Optional[int] = None,
max_output_tokens: typing.Optional[int] = None,
stop_sequences: typing.Optional[typing.List[str]] = None
)
Constructs a GenerationConfig object.
vertexai.generative_models.GenerativeModel.count_tokens
count_tokens(
contents: typing.Union[
typing.List[vertexai.generative_models._generative_models.Content],
typing.List[typing.Dict[str, typing.Any]],
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
typing.List[
typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
]
],
]
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.CountTokensResponse
Counts tokens.
See more: vertexai.generative_models.GenerativeModel.count_tokens
vertexai.generative_models.GenerativeModel.count_tokens_async
count_tokens_async(
contents: typing.Union[
typing.List[vertexai.generative_models._generative_models.Content],
typing.List[typing.Dict[str, typing.Any]],
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
typing.List[
typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
]
],
]
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.CountTokensResponse
Counts tokens asynchronously.
See more: vertexai.generative_models.GenerativeModel.count_tokens_async
vertexai.generative_models.GenerativeModel.generate_content
generate_content(
contents: typing.Union[
typing.List[vertexai.generative_models._generative_models.Content],
typing.List[typing.Dict[str, typing.Any]],
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
typing.List[
typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
]
],
],
*,
generation_config: typing.Optional[
typing.Union[
vertexai.generative_models._generative_models.GenerationConfig,
typing.Dict[str, typing.Any],
]
] = None,
safety_settings: typing.Optional[
typing.Union[
typing.List[vertexai.generative_models._generative_models.SafetySetting],
typing.Dict[
google.cloud.aiplatform_v1beta1.types.content.HarmCategory,
google.cloud.aiplatform_v1beta1.types.content.SafetySetting.HarmBlockThreshold,
],
]
] = None,
tools: typing.Optional[
typing.List[vertexai.generative_models._generative_models.Tool]
] = None,
tool_config: typing.Optional[
vertexai.generative_models._generative_models.ToolConfig
] = None,
stream: bool = False
) -> typing.Union[
vertexai.generative_models._generative_models.GenerationResponse,
typing.Iterable[vertexai.generative_models._generative_models.GenerationResponse],
]
Generates content.
See more: vertexai.generative_models.GenerativeModel.generate_content
vertexai.generative_models.GenerativeModel.generate_content_async
generate_content_async(
contents: typing.Union[
typing.List[vertexai.generative_models._generative_models.Content],
typing.List[typing.Dict[str, typing.Any]],
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
typing.List[
typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
]
],
],
*,
generation_config: typing.Optional[
typing.Union[
vertexai.generative_models._generative_models.GenerationConfig,
typing.Dict[str, typing.Any],
]
] = None,
safety_settings: typing.Optional[
typing.Union[
typing.List[vertexai.generative_models._generative_models.SafetySetting],
typing.Dict[
google.cloud.aiplatform_v1beta1.types.content.HarmCategory,
google.cloud.aiplatform_v1beta1.types.content.SafetySetting.HarmBlockThreshold,
],
]
] = None,
tools: typing.Optional[
typing.List[vertexai.generative_models._generative_models.Tool]
] = None,
tool_config: typing.Optional[
vertexai.generative_models._generative_models.ToolConfig
] = None,
stream: bool = False
) -> typing.Union[
vertexai.generative_models._generative_models.GenerationResponse,
typing.AsyncIterable[
vertexai.generative_models._generative_models.GenerationResponse
],
]
Generates content asynchronously.
See more: vertexai.generative_models.GenerativeModel.generate_content_async
vertexai.generative_models.GenerativeModel.start_chat
start_chat(
*,
history: typing.Optional[
typing.List[vertexai.generative_models._generative_models.Content]
] = None,
response_validation: bool = True
) -> vertexai.generative_models._generative_models.ChatSession
Creates a stateful chat session.
See more: vertexai.generative_models.GenerativeModel.start_chat
vertexai.generative_models.Image.from_bytes
from_bytes(data: bytes) -> vertexai.generative_models._generative_models.Image
Loads image from image bytes.
vertexai.generative_models.Image.load_from_file
load_from_file(
location: str,
) -> vertexai.generative_models._generative_models.Image
Loads image from file.
vertexai.generative_models.ResponseValidationError.with_traceback
Exception.with_traceback(tb) -- set self.traceback to tb and return self.
See more: vertexai.generative_models.ResponseValidationError.with_traceback
vertexai.generative_models.SafetySetting
SafetySetting(
*,
category: google.cloud.aiplatform_v1beta1.types.content.HarmCategory,
threshold: google.cloud.aiplatform_v1beta1.types.content.SafetySetting.HarmBlockThreshold,
method: typing.Optional[
google.cloud.aiplatform_v1beta1.types.content.SafetySetting.HarmBlockMethod
] = None
)
Safety settings.
See more: vertexai.generative_models.SafetySetting
vertexai.language_models.ChatModel
ChatModel(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a LanguageModel.
See more: vertexai.language_models.ChatModel
vertexai.language_models.ChatModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.language_models.ChatModel.from_pretrained
vertexai.language_models.ChatModel.get_tuned_model
get_tuned_model(
tuned_model_name: str,
) -> vertexai.language_models._language_models._LanguageModel
Loads the specified tuned language model.
See more: vertexai.language_models.ChatModel.get_tuned_model
vertexai.language_models.ChatModel.list_tuned_model_names
list_tuned_model_names() -> typing.Sequence[str]
Lists the names of tuned models.
See more: vertexai.language_models.ChatModel.list_tuned_model_names
vertexai.language_models.ChatModel.start_chat
start_chat(
*,
context: typing.Optional[str] = None,
examples: typing.Optional[
typing.List[vertexai.language_models.InputOutputTextPair]
] = None,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
top_k: typing.Optional[int] = None,
top_p: typing.Optional[float] = None,
message_history: typing.Optional[
typing.List[vertexai.language_models.ChatMessage]
] = None,
stop_sequences: typing.Optional[typing.List[str]] = None
) -> vertexai.language_models.ChatSession
Starts a chat session with the model.
vertexai.language_models.ChatModel.tune_model
tune_model(
training_data: typing.Union[str, pandas.core.frame.DataFrame],
*,
train_steps: typing.Optional[int] = None,
learning_rate_multiplier: typing.Optional[float] = None,
tuning_job_location: typing.Optional[str] = None,
tuned_model_location: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
default_context: typing.Optional[str] = None,
accelerator_type: typing.Optional[typing.Literal["TPU", "GPU"]] = None,
tuning_evaluation_spec: typing.Optional[TuningEvaluationSpec] = None
) -> _LanguageModelTuningJob
Tunes a model based on training data.
vertexai.language_models.ChatModel.tune_model_rlhf
tune_model_rlhf(
*,
prompt_data: typing.Union[str, pandas.core.frame.DataFrame],
preference_data: typing.Union[str, pandas.core.frame.DataFrame],
model_display_name: typing.Optional[str] = None,
prompt_sequence_length: typing.Optional[int] = None,
target_sequence_length: typing.Optional[int] = None,
reward_model_learning_rate_multiplier: typing.Optional[float] = None,
reinforcement_learning_rate_multiplier: typing.Optional[float] = None,
reward_model_train_steps: typing.Optional[int] = None,
reinforcement_learning_train_steps: typing.Optional[int] = None,
kl_coeff: typing.Optional[float] = None,
default_context: typing.Optional[str] = None,
tuning_job_location: typing.Optional[str] = None,
accelerator_type: typing.Optional[typing.Literal["TPU", "GPU"]] = None,
tuning_evaluation_spec: typing.Optional[TuningEvaluationSpec] = None
) -> _LanguageModelTuningJob
Tunes a model using reinforcement learning from human feedback.
See more: vertexai.language_models.ChatModel.tune_model_rlhf
vertexai.language_models.ChatSession.send_message
send_message(
message: str,
*,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
top_k: typing.Optional[int] = None,
top_p: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None,
candidate_count: typing.Optional[int] = None,
grounding_source: typing.Optional[
typing.Union[
vertexai.language_models._language_models.WebSearch,
vertexai.language_models._language_models.VertexAISearch,
vertexai.language_models._language_models.InlineContext,
]
] = None
) -> vertexai.language_models.MultiCandidateTextGenerationResponse
Sends message to the language model and gets a response.
vertexai.language_models.ChatSession.send_message_async
send_message_async(
message: str,
*,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
top_k: typing.Optional[int] = None,
top_p: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None,
candidate_count: typing.Optional[int] = None,
grounding_source: typing.Optional[
typing.Union[
vertexai.language_models._language_models.WebSearch,
vertexai.language_models._language_models.VertexAISearch,
vertexai.language_models._language_models.InlineContext,
]
] = None
) -> vertexai.language_models.MultiCandidateTextGenerationResponse
Asynchronously sends message to the language model and gets a response.
See more: vertexai.language_models.ChatSession.send_message_async
vertexai.language_models.ChatSession.send_message_streaming
send_message_streaming(
message: str,
*,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
top_k: typing.Optional[int] = None,
top_p: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None
) -> typing.Iterator[vertexai.language_models.TextGenerationResponse]
Sends message to the language model and gets a streamed response.
See more: vertexai.language_models.ChatSession.send_message_streaming
vertexai.language_models.ChatSession.send_message_streaming_async
send_message_streaming_async(
message: str,
*,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
top_k: typing.Optional[int] = None,
top_p: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None
) -> typing.AsyncIterator[vertexai.language_models.TextGenerationResponse]
Asynchronously sends message to the language model and gets a streamed response.
See more: vertexai.language_models.ChatSession.send_message_streaming_async
vertexai.language_models.CodeChatModel
CodeChatModel(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a LanguageModel.
See more: vertexai.language_models.CodeChatModel
vertexai.language_models.CodeChatModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.language_models.CodeChatModel.from_pretrained
vertexai.language_models.CodeChatModel.get_tuned_model
get_tuned_model(
tuned_model_name: str,
) -> vertexai.language_models._language_models._LanguageModel
Loads the specified tuned language model.
See more: vertexai.language_models.CodeChatModel.get_tuned_model
vertexai.language_models.CodeChatModel.list_tuned_model_names
list_tuned_model_names() -> typing.Sequence[str]
Lists the names of tuned models.
See more: vertexai.language_models.CodeChatModel.list_tuned_model_names
vertexai.language_models.CodeChatModel.start_chat
start_chat(
*,
context: typing.Optional[str] = None,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
message_history: typing.Optional[
typing.List[vertexai.language_models.ChatMessage]
] = None,
stop_sequences: typing.Optional[typing.List[str]] = None
) -> vertexai.language_models.CodeChatSession
Starts a chat session with the code chat model.
vertexai.language_models.CodeChatModel.tune_model
tune_model(
training_data: typing.Union[str, pandas.core.frame.DataFrame],
*,
train_steps: typing.Optional[int] = None,
learning_rate_multiplier: typing.Optional[float] = None,
tuning_job_location: typing.Optional[str] = None,
tuned_model_location: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
default_context: typing.Optional[str] = None,
accelerator_type: typing.Optional[typing.Literal["TPU", "GPU"]] = None,
tuning_evaluation_spec: typing.Optional[TuningEvaluationSpec] = None
) -> _LanguageModelTuningJob
Tunes a model based on training data.
vertexai.language_models.CodeChatSession.send_message
send_message(
message: str,
*,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None,
candidate_count: typing.Optional[int] = None
) -> vertexai.language_models.MultiCandidateTextGenerationResponse
Sends message to the code chat model and gets a response.
See more: vertexai.language_models.CodeChatSession.send_message
vertexai.language_models.CodeChatSession.send_message_async
send_message_async(
message: str,
*,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
candidate_count: typing.Optional[int] = None
) -> vertexai.language_models.MultiCandidateTextGenerationResponse
Asynchronously sends message to the code chat model and gets a response.
See more: vertexai.language_models.CodeChatSession.send_message_async
vertexai.language_models.CodeChatSession.send_message_streaming
send_message_streaming(
message: str,
*,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None
) -> typing.Iterator[vertexai.language_models.TextGenerationResponse]
Sends message to the language model and gets a streamed response.
See more: vertexai.language_models.CodeChatSession.send_message_streaming
vertexai.language_models.CodeChatSession.send_message_streaming_async
send_message_streaming_async(
message: str,
*,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None
) -> typing.AsyncIterator[vertexai.language_models.TextGenerationResponse]
Asynchronously sends message to the language model and gets a streamed response.
See more: vertexai.language_models.CodeChatSession.send_message_streaming_async
vertexai.language_models.CodeGenerationModel.batch_predict
batch_predict(
*,
dataset: typing.Union[str, typing.List[str]],
destination_uri_prefix: str,
model_parameters: typing.Optional[typing.Dict] = None
) -> google.cloud.aiplatform.jobs.BatchPredictionJob
Starts a batch prediction job with the model.
See more: vertexai.language_models.CodeGenerationModel.batch_predict
vertexai.language_models.CodeGenerationModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.language_models.CodeGenerationModel.from_pretrained
vertexai.language_models.CodeGenerationModel.get_tuned_model
get_tuned_model(
tuned_model_name: str,
) -> vertexai.language_models._language_models._LanguageModel
Loads the specified tuned language model.
See more: vertexai.language_models.CodeGenerationModel.get_tuned_model
vertexai.language_models.CodeGenerationModel.list_tuned_model_names
list_tuned_model_names() -> typing.Sequence[str]
Lists the names of tuned models.
See more: vertexai.language_models.CodeGenerationModel.list_tuned_model_names
vertexai.language_models.CodeGenerationModel.predict
predict(
prefix: str,
suffix: typing.Optional[str] = None,
*,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None,
candidate_count: typing.Optional[int] = None
) -> vertexai.language_models.TextGenerationResponse
Gets model response for a single prompt.
See more: vertexai.language_models.CodeGenerationModel.predict
vertexai.language_models.CodeGenerationModel.predict_async
predict_async(
prefix: str,
suffix: typing.Optional[str] = None,
*,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None,
candidate_count: typing.Optional[int] = None
) -> vertexai.language_models.TextGenerationResponse
Asynchronously gets model response for a single prompt.
See more: vertexai.language_models.CodeGenerationModel.predict_async
vertexai.language_models.CodeGenerationModel.predict_streaming
predict_streaming(
prefix: str,
suffix: typing.Optional[str] = None,
*,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None
) -> typing.Iterator[vertexai.language_models.TextGenerationResponse]
Predicts the code based on previous code.
See more: vertexai.language_models.CodeGenerationModel.predict_streaming
vertexai.language_models.CodeGenerationModel.predict_streaming_async
predict_streaming_async(
prefix: str,
suffix: typing.Optional[str] = None,
*,
max_output_tokens: typing.Optional[int] = None,
temperature: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None
) -> typing.AsyncIterator[vertexai.language_models.TextGenerationResponse]
Asynchronously predicts the code based on previous code.
See more: vertexai.language_models.CodeGenerationModel.predict_streaming_async
vertexai.language_models.CodeGenerationModel.tune_model
tune_model(
training_data: typing.Union[str, pandas.core.frame.DataFrame],
*,
train_steps: typing.Optional[int] = None,
learning_rate_multiplier: typing.Optional[float] = None,
tuning_job_location: typing.Optional[str] = None,
tuned_model_location: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
tuning_evaluation_spec: typing.Optional[TuningEvaluationSpec] = None,
accelerator_type: typing.Optional[typing.Literal["TPU", "GPU"]] = None,
max_context_length: typing.Optional[str] = None
) -> _LanguageModelTuningJob
Tunes a model based on training data.
See more: vertexai.language_models.CodeGenerationModel.tune_model
vertexai.language_models.TextEmbeddingModel
TextEmbeddingModel(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a LanguageModel.
vertexai.language_models.TextEmbeddingModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.language_models.TextEmbeddingModel.from_pretrained
vertexai.language_models.TextEmbeddingModel.get_embeddings
get_embeddings(
texts: typing.List[typing.Union[str, vertexai.language_models.TextEmbeddingInput]],
*,
auto_truncate: bool = True,
output_dimensionality: typing.Optional[int] = None
) -> typing.List[vertexai.language_models.TextEmbedding]
Calculates embeddings for the given texts.
See more: vertexai.language_models.TextEmbeddingModel.get_embeddings
vertexai.language_models.TextEmbeddingModel.get_embeddings_async
get_embeddings_async(
texts: typing.List[typing.Union[str, vertexai.language_models.TextEmbeddingInput]],
*,
auto_truncate: bool = True,
output_dimensionality: typing.Optional[int] = None
) -> typing.List[vertexai.language_models.TextEmbedding]
Asynchronously calculates embeddings for the given texts.
See more: vertexai.language_models.TextEmbeddingModel.get_embeddings_async
vertexai.language_models.TextGenerationModel.batch_predict
batch_predict(
*,
dataset: typing.Union[str, typing.List[str]],
destination_uri_prefix: str,
model_parameters: typing.Optional[typing.Dict] = None
) -> google.cloud.aiplatform.jobs.BatchPredictionJob
Starts a batch prediction job with the model.
See more: vertexai.language_models.TextGenerationModel.batch_predict
vertexai.language_models.TextGenerationModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.language_models.TextGenerationModel.from_pretrained
vertexai.language_models.TextGenerationModel.get_tuned_model
get_tuned_model(
tuned_model_name: str,
) -> vertexai.language_models._language_models._LanguageModel
Loads the specified tuned language model.
See more: vertexai.language_models.TextGenerationModel.get_tuned_model
vertexai.language_models.TextGenerationModel.list_tuned_model_names
list_tuned_model_names() -> typing.Sequence[str]
Lists the names of tuned models.
See more: vertexai.language_models.TextGenerationModel.list_tuned_model_names
vertexai.language_models.TextGenerationModel.predict
predict(
prompt: str,
*,
max_output_tokens: typing.Optional[int] = 128,
temperature: typing.Optional[float] = None,
top_k: typing.Optional[int] = None,
top_p: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None,
candidate_count: typing.Optional[int] = None,
grounding_source: typing.Optional[
typing.Union[
vertexai.language_models._language_models.WebSearch,
vertexai.language_models._language_models.VertexAISearch,
vertexai.language_models._language_models.InlineContext,
]
] = None,
logprobs: typing.Optional[int] = None,
presence_penalty: typing.Optional[float] = None,
frequency_penalty: typing.Optional[float] = None,
logit_bias: typing.Optional[typing.Dict[int, float]] = None
) -> vertexai.language_models.MultiCandidateTextGenerationResponse
Gets model response for a single prompt.
See more: vertexai.language_models.TextGenerationModel.predict
vertexai.language_models.TextGenerationModel.predict_async
predict_async(
prompt: str,
*,
max_output_tokens: typing.Optional[int] = 128,
temperature: typing.Optional[float] = None,
top_k: typing.Optional[int] = None,
top_p: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None,
candidate_count: typing.Optional[int] = None,
grounding_source: typing.Optional[
typing.Union[
vertexai.language_models._language_models.WebSearch,
vertexai.language_models._language_models.VertexAISearch,
vertexai.language_models._language_models.InlineContext,
]
] = None,
logprobs: typing.Optional[int] = None,
presence_penalty: typing.Optional[float] = None,
frequency_penalty: typing.Optional[float] = None,
logit_bias: typing.Optional[typing.Dict[int, float]] = None
) -> vertexai.language_models.MultiCandidateTextGenerationResponse
Asynchronously gets model response for a single prompt.
See more: vertexai.language_models.TextGenerationModel.predict_async
vertexai.language_models.TextGenerationModel.predict_streaming
predict_streaming(
prompt: str,
*,
max_output_tokens: int = 128,
temperature: typing.Optional[float] = None,
top_k: typing.Optional[int] = None,
top_p: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None,
logprobs: typing.Optional[int] = None,
presence_penalty: typing.Optional[float] = None,
frequency_penalty: typing.Optional[float] = None,
logit_bias: typing.Optional[typing.Dict[int, float]] = None
) -> typing.Iterator[vertexai.language_models.TextGenerationResponse]
Gets a streaming model response for a single prompt.
See more: vertexai.language_models.TextGenerationModel.predict_streaming
vertexai.language_models.TextGenerationModel.predict_streaming_async
predict_streaming_async(
prompt: str,
*,
max_output_tokens: int = 128,
temperature: typing.Optional[float] = None,
top_k: typing.Optional[int] = None,
top_p: typing.Optional[float] = None,
stop_sequences: typing.Optional[typing.List[str]] = None,
logprobs: typing.Optional[int] = None,
presence_penalty: typing.Optional[float] = None,
frequency_penalty: typing.Optional[float] = None,
logit_bias: typing.Optional[typing.Dict[int, float]] = None
) -> typing.AsyncIterator[vertexai.language_models.TextGenerationResponse]
Asynchronously gets a streaming model response for a single prompt.
See more: vertexai.language_models.TextGenerationModel.predict_streaming_async
vertexai.language_models.TextGenerationModel.tune_model
tune_model(
training_data: typing.Union[str, pandas.core.frame.DataFrame],
*,
train_steps: typing.Optional[int] = None,
learning_rate_multiplier: typing.Optional[float] = None,
tuning_job_location: typing.Optional[str] = None,
tuned_model_location: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
tuning_evaluation_spec: typing.Optional[TuningEvaluationSpec] = None,
accelerator_type: typing.Optional[typing.Literal["TPU", "GPU"]] = None,
max_context_length: typing.Optional[str] = None
) -> _LanguageModelTuningJob
Tunes a model based on training data.
See more: vertexai.language_models.TextGenerationModel.tune_model
vertexai.language_models.TextGenerationModel.tune_model_rlhf
tune_model_rlhf(
*,
prompt_data: typing.Union[str, pandas.core.frame.DataFrame],
preference_data: typing.Union[str, pandas.core.frame.DataFrame],
model_display_name: typing.Optional[str] = None,
prompt_sequence_length: typing.Optional[int] = None,
target_sequence_length: typing.Optional[int] = None,
reward_model_learning_rate_multiplier: typing.Optional[float] = None,
reinforcement_learning_rate_multiplier: typing.Optional[float] = None,
reward_model_train_steps: typing.Optional[int] = None,
reinforcement_learning_train_steps: typing.Optional[int] = None,
kl_coeff: typing.Optional[float] = None,
default_context: typing.Optional[str] = None,
tuning_job_location: typing.Optional[str] = None,
accelerator_type: typing.Optional[typing.Literal["TPU", "GPU"]] = None,
tuning_evaluation_spec: typing.Optional[TuningEvaluationSpec] = None
) -> _LanguageModelTuningJob
Tunes a model using reinforcement learning from human feedback.
See more: vertexai.language_models.TextGenerationModel.tune_model_rlhf
vertexai.language_models._language_models._TunableModelMixin
_TunableModelMixin(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a LanguageModel.
See more: vertexai.language_models._language_models._TunableModelMixin
vertexai.language_models._language_models._TunableModelMixin.tune_model
tune_model(
training_data: typing.Union[str, pandas.core.frame.DataFrame],
*,
train_steps: typing.Optional[int] = None,
learning_rate: typing.Optional[float] = None,
learning_rate_multiplier: typing.Optional[float] = None,
tuning_job_location: typing.Optional[str] = None,
tuned_model_location: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
tuning_evaluation_spec: typing.Optional[TuningEvaluationSpec] = None,
default_context: typing.Optional[str] = None,
accelerator_type: typing.Optional[typing.Literal["TPU", "GPU"]] = None,
max_context_length: typing.Optional[str] = None
) -> _LanguageModelTuningJob
Tunes a model based on training data.
See more: vertexai.language_models._language_models._TunableModelMixin.tune_model
vertexai.preview.evaluation.CustomMetric
CustomMetric(
name: str,
metric_function: typing.Callable[
[typing.Dict[str, typing.Any]], typing.Dict[str, typing.Any]
],
)
Initializes the evaluation metric.
See more: vertexai.preview.evaluation.CustomMetric
vertexai.preview.evaluation.EvalTask
EvalTask(
*,
dataset: typing.Union[pd.DataFrame, str, typing.Dict[str, typing.Any]],
metrics: typing.List[
typing.Union[
typing.Literal[
"exact_match",
"bleu",
"rouge_1",
"rouge_2",
"rouge_l",
"rouge_l_sum",
"coherence",
"fluency",
"safety",
"groundedness",
"fulfillment",
"summarization_quality",
"summarization_helpfulness",
"summarization_verbosity",
"question_answering_quality",
"question_answering_relevance",
"question_answering_helpfulness",
"question_answering_correctness",
"text_generation_similarity",
"text_generation_quality",
"text_generation_instruction_following",
"text_generation_safety",
"text_generation_factuality",
"summarization_pointwise_reference_free",
"qa_pointwise_reference_free",
"qa_pointwise_reference_based",
"tool_call_quality",
],
vertexai.preview.evaluation.metrics._base.CustomMetric,
]
],
experiment: typing.Optional[str] = None,
content_column_name: str = "content",
reference_column_name: str = "reference",
response_column_name: str = "response"
)
Initializes an EvalTask.
See more: vertexai.preview.evaluation.EvalTask
vertexai.preview.evaluation.EvalTask.display_runs
display_runs()
Displays experiment runs associated with this EvalTask.
vertexai.preview.evaluation.EvalTask.evaluate
evaluate(
*,
model: typing.Optional[
typing.Union[
vertexai.generative_models.GenerativeModel, typing.Callable[[str], str]
]
] = None,
prompt_template: typing.Optional[str] = None,
experiment_run_name: typing.Optional[str] = None,
response_column_name: str = "response"
) -> vertexai.preview.evaluation._base.EvalResult
Runs an evaluation for the EvalTask.
vertexai.preview.evaluation.PromptTemplate
PromptTemplate(template: str)
Initializes the PromptTemplate with a given template.
vertexai.preview.evaluation.PromptTemplate.__repr__
__repr__() -> str
Returns a string representation of the PromptTemplate.
vertexai.preview.evaluation.PromptTemplate.__str__
__str__() -> str
Returns the template string.
vertexai.preview.evaluation.PromptTemplate.assemble
assemble(**kwargs) -> vertexai.preview.evaluation.prompt_template.PromptTemplate
Replaces only the provided placeholders in the template with specific values.
See more: vertexai.preview.evaluation.PromptTemplate.assemble
vertexai.preview.generative_models.AutomaticFunctionCallingResponder
AutomaticFunctionCallingResponder(max_automatic_function_calls: int = 1)
Initializes the responder.
See more: vertexai.preview.generative_models.AutomaticFunctionCallingResponder
vertexai.preview.generative_models.CallableFunctionDeclaration
CallableFunctionDeclaration(
name: str,
function: typing.Callable[[...], typing.Any],
parameters: typing.Dict[str, typing.Any],
description: typing.Optional[str] = None,
)
Constructs a FunctionDeclaration.
See more: vertexai.preview.generative_models.CallableFunctionDeclaration
vertexai.preview.generative_models.CallableFunctionDeclaration.from_func
from_func(
func: typing.Callable[[...], typing.Any]
) -> vertexai.generative_models._generative_models.CallableFunctionDeclaration
Automatically creates a CallableFunctionDeclaration from a Python function.
See more: vertexai.preview.generative_models.CallableFunctionDeclaration.from_func
vertexai.preview.generative_models.ChatSession.send_message
send_message(
content: typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
typing.List[
typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
]
],
],
*,
generation_config: typing.Optional[
typing.Union[
vertexai.generative_models._generative_models.GenerationConfig,
typing.Dict[str, typing.Any],
]
] = None,
safety_settings: typing.Optional[
typing.Union[
typing.List[vertexai.generative_models._generative_models.SafetySetting],
typing.Dict[
google.cloud.aiplatform_v1beta1.types.content.HarmCategory,
google.cloud.aiplatform_v1beta1.types.content.SafetySetting.HarmBlockThreshold,
],
]
] = None,
tools: typing.Optional[
typing.List[vertexai.generative_models._generative_models.Tool]
] = None,
stream: bool = False
) -> typing.Union[
vertexai.generative_models._generative_models.GenerationResponse,
typing.Iterable[vertexai.generative_models._generative_models.GenerationResponse],
]
Generates content.
See more: vertexai.preview.generative_models.ChatSession.send_message
vertexai.preview.generative_models.ChatSession.send_message_async
send_message_async(
content: typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
typing.List[
typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
]
],
],
*,
generation_config: typing.Optional[
typing.Union[
vertexai.generative_models._generative_models.GenerationConfig,
typing.Dict[str, typing.Any],
]
] = None,
safety_settings: typing.Optional[
typing.Union[
typing.List[vertexai.generative_models._generative_models.SafetySetting],
typing.Dict[
google.cloud.aiplatform_v1beta1.types.content.HarmCategory,
google.cloud.aiplatform_v1beta1.types.content.SafetySetting.HarmBlockThreshold,
],
]
] = None,
tools: typing.Optional[
typing.List[vertexai.generative_models._generative_models.Tool]
] = None,
stream: bool = False
) -> typing.Union[
typing.Awaitable[vertexai.generative_models._generative_models.GenerationResponse],
typing.Awaitable[
typing.AsyncIterable[
vertexai.generative_models._generative_models.GenerationResponse
]
],
]
Generates content asynchronously.
See more: vertexai.preview.generative_models.ChatSession.send_message_async
vertexai.preview.generative_models.FunctionDeclaration
FunctionDeclaration(
*,
name: str,
parameters: typing.Dict[str, typing.Any],
description: typing.Optional[str] = None
)
Constructs a FunctionDeclaration.
See more: vertexai.preview.generative_models.FunctionDeclaration
vertexai.preview.generative_models.GenerationConfig
GenerationConfig(
*,
temperature: typing.Optional[float] = None,
top_p: typing.Optional[float] = None,
top_k: typing.Optional[int] = None,
candidate_count: typing.Optional[int] = None,
max_output_tokens: typing.Optional[int] = None,
stop_sequences: typing.Optional[typing.List[str]] = None
)
Constructs a GenerationConfig object.
See more: vertexai.preview.generative_models.GenerationConfig
vertexai.preview.generative_models.GenerativeModel.count_tokens
count_tokens(
contents: typing.Union[
typing.List[vertexai.generative_models._generative_models.Content],
typing.List[typing.Dict[str, typing.Any]],
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
typing.List[
typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
]
],
]
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.CountTokensResponse
Counts tokens.
See more: vertexai.preview.generative_models.GenerativeModel.count_tokens
vertexai.preview.generative_models.GenerativeModel.count_tokens_async
count_tokens_async(
contents: typing.Union[
typing.List[vertexai.generative_models._generative_models.Content],
typing.List[typing.Dict[str, typing.Any]],
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
typing.List[
typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
]
],
]
) -> google.cloud.aiplatform_v1beta1.types.prediction_service.CountTokensResponse
Counts tokens asynchronously.
See more: vertexai.preview.generative_models.GenerativeModel.count_tokens_async
vertexai.preview.generative_models.GenerativeModel.generate_content
generate_content(
contents: typing.Union[
typing.List[vertexai.generative_models._generative_models.Content],
typing.List[typing.Dict[str, typing.Any]],
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
typing.List[
typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
]
],
],
*,
generation_config: typing.Optional[
typing.Union[
vertexai.generative_models._generative_models.GenerationConfig,
typing.Dict[str, typing.Any],
]
] = None,
safety_settings: typing.Optional[
typing.Union[
typing.List[vertexai.generative_models._generative_models.SafetySetting],
typing.Dict[
google.cloud.aiplatform_v1beta1.types.content.HarmCategory,
google.cloud.aiplatform_v1beta1.types.content.SafetySetting.HarmBlockThreshold,
],
]
] = None,
tools: typing.Optional[
typing.List[vertexai.generative_models._generative_models.Tool]
] = None,
tool_config: typing.Optional[
vertexai.generative_models._generative_models.ToolConfig
] = None,
stream: bool = False
) -> typing.Union[
vertexai.generative_models._generative_models.GenerationResponse,
typing.Iterable[vertexai.generative_models._generative_models.GenerationResponse],
]
Generates content.
See more: vertexai.preview.generative_models.GenerativeModel.generate_content
vertexai.preview.generative_models.GenerativeModel.generate_content_async
generate_content_async(
contents: typing.Union[
typing.List[vertexai.generative_models._generative_models.Content],
typing.List[typing.Dict[str, typing.Any]],
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
typing.List[
typing.Union[
str,
vertexai.generative_models._generative_models.Image,
vertexai.generative_models._generative_models.Part,
]
],
],
*,
generation_config: typing.Optional[
typing.Union[
vertexai.generative_models._generative_models.GenerationConfig,
typing.Dict[str, typing.Any],
]
] = None,
safety_settings: typing.Optional[
typing.Union[
typing.List[vertexai.generative_models._generative_models.SafetySetting],
typing.Dict[
google.cloud.aiplatform_v1beta1.types.content.HarmCategory,
google.cloud.aiplatform_v1beta1.types.content.SafetySetting.HarmBlockThreshold,
],
]
] = None,
tools: typing.Optional[
typing.List[vertexai.generative_models._generative_models.Tool]
] = None,
tool_config: typing.Optional[
vertexai.generative_models._generative_models.ToolConfig
] = None,
stream: bool = False
) -> typing.Union[
vertexai.generative_models._generative_models.GenerationResponse,
typing.AsyncIterable[
vertexai.generative_models._generative_models.GenerationResponse
],
]
Generates content asynchronously.
See more: vertexai.preview.generative_models.GenerativeModel.generate_content_async
vertexai.preview.generative_models.GenerativeModel.start_chat
start_chat(
*,
history: typing.Optional[
typing.List[vertexai.generative_models._generative_models.Content]
] = None,
response_validation: bool = True,
responder: typing.Optional[
vertexai.generative_models._generative_models.AutomaticFunctionCallingResponder
] = None
) -> vertexai.generative_models._generative_models.ChatSession
Creates a stateful chat session.
See more: vertexai.preview.generative_models.GenerativeModel.start_chat
vertexai.preview.generative_models.Image.from_bytes
from_bytes(data: bytes) -> vertexai.generative_models._generative_models.Image
Loads image from image bytes.
See more: vertexai.preview.generative_models.Image.from_bytes
vertexai.preview.generative_models.Image.load_from_file
load_from_file(
location: str,
) -> vertexai.generative_models._generative_models.Image
Loads image from file.
See more: vertexai.preview.generative_models.Image.load_from_file
vertexai.preview.generative_models.ResponseBlockedError.with_traceback
Exception.with_traceback(tb) -- set self.traceback to tb and return self.
See more: vertexai.preview.generative_models.ResponseBlockedError.with_traceback
vertexai.preview.generative_models.ResponseValidationError.with_traceback
Exception.with_traceback(tb) -- set self.traceback to tb and return self.
See more: vertexai.preview.generative_models.ResponseValidationError.with_traceback
vertexai.preview.generative_models.SafetySetting
SafetySetting(
*,
category: google.cloud.aiplatform_v1beta1.types.content.HarmCategory,
threshold: google.cloud.aiplatform_v1beta1.types.content.SafetySetting.HarmBlockThreshold,
method: typing.Optional[
google.cloud.aiplatform_v1beta1.types.content.SafetySetting.HarmBlockMethod
] = None
)
Safety settings.
vertexai.preview.generative_models.grounding.GoogleSearchRetrieval
GoogleSearchRetrieval(disable_attribution: typing.Optional[bool] = None)
Initializes a Google Search Retrieval tool.
See more: vertexai.preview.generative_models.grounding.GoogleSearchRetrieval
vertexai.preview.generative_models.grounding.Retrieval
Retrieval(
source: vertexai.generative_models._generative_models.grounding.VertexAISearch,
disable_attribution: typing.Optional[bool] = None,
)
Initializes a Retrieval tool.
See more: vertexai.preview.generative_models.grounding.Retrieval
vertexai.preview.generative_models.grounding.VertexAISearch
VertexAISearch(datastore: str)
Initializes a Vertex AI Search tool.
See more: vertexai.preview.generative_models.grounding.VertexAISearch
vertexai.preview.reasoning_engines.LangchainAgent
LangchainAgent(
model: str,
*,
prompt: typing.Optional[RunnableSerializable] = None,
tools: typing.Optional[
typing.Sequence[typing.Union[typing.Callable, BaseTool]]
] = None,
output_parser: typing.Optional[RunnableSerializable] = None,
chat_history: typing.Optional[GetSessionHistoryCallable] = None,
model_kwargs: typing.Optional[typing.Mapping[str, typing.Any]] = None,
agent_executor_kwargs: typing.Optional[typing.Mapping[str, typing.Any]] = None,
runnable_kwargs: typing.Optional[typing.Mapping[str, typing.Any]] = None
)
Initializes the LangchainAgent.
vertexai.preview.reasoning_engines.LangchainAgent.query
query(
*,
input: typing.Union[str, typing.Mapping[str, typing.Any]],
config: typing.Optional[RunnableConfig] = None,
**kwargs: typing.Any
) -> typing.Mapping[str, typing.Any]
Queries the Agent with the given input and config.
See more: vertexai.preview.reasoning_engines.LangchainAgent.query
vertexai.preview.reasoning_engines.LangchainAgent.set_up
set_up()
Sets up the agent for execution of queries at runtime.
See more: vertexai.preview.reasoning_engines.LangchainAgent.set_up
vertexai.preview.reasoning_engines.Queryable.query
query(**kwargs)
Runs the Reasoning Engine to serve the user query.
See more: vertexai.preview.reasoning_engines.Queryable.query
vertexai.preview.reasoning_engines.ReasoningEngine
ReasoningEngine(reasoning_engine_name: str)
Retrieves a Reasoning Engine resource.
See more: vertexai.preview.reasoning_engines.ReasoningEngine
vertexai.preview.reasoning_engines.ReasoningEngine.create
create(
reasoning_engine: vertexai.reasoning_engines._reasoning_engines.Queryable,
*,
requirements: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
reasoning_engine_name: typing.Optional[str] = None,
display_name: typing.Optional[str] = None,
description: typing.Optional[str] = None,
gcs_dir_name: str = "reasoning_engine",
sys_version: typing.Optional[str] = None,
extra_packages: typing.Optional[typing.Sequence[str]] = None
) -> vertexai.reasoning_engines._reasoning_engines.ReasoningEngine
Creates a new ReasoningEngine.
See more: vertexai.preview.reasoning_engines.ReasoningEngine.create
vertexai.preview.reasoning_engines.ReasoningEngine.delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource.
See more: vertexai.preview.reasoning_engines.ReasoningEngine.delete
vertexai.preview.reasoning_engines.ReasoningEngine.list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
parent: typing.Optional[str] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]
List all instances of this Vertex AI Resource.
See more: vertexai.preview.reasoning_engines.ReasoningEngine.list
vertexai.preview.reasoning_engines.ReasoningEngine.operation_schemas
operation_schemas() -> typing.Sequence[typing.Dict[str, typing.Any]]
Returns the (Open)API schemas for the Reasoning Engine.
See more: vertexai.preview.reasoning_engines.ReasoningEngine.operation_schemas
vertexai.preview.reasoning_engines.ReasoningEngine.query
query(**kwargs) -> typing.Dict[str, typing.Any]
Runs the Reasoning Engine to serve the user query.
See more: vertexai.preview.reasoning_engines.ReasoningEngine.query
vertexai.preview.reasoning_engines.ReasoningEngine.to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
See more: vertexai.preview.reasoning_engines.ReasoningEngine.to_dict
vertexai.preview.reasoning_engines.ReasoningEngine.wait
wait()
Helper method that blocks until all futures are complete.
See more: vertexai.preview.reasoning_engines.ReasoningEngine.wait
vertexai.preview.vision_models.GeneratedImage
GeneratedImage(
image_bytes: typing.Optional[bytes],
generation_parameters: typing.Dict[str, typing.Any],
gcs_uri: typing.Optional[str] = None,
)
Creates a GeneratedImage
object.
vertexai.preview.vision_models.GeneratedImage.load_from_file
load_from_file(location: str) -> vertexai.preview.vision_models.GeneratedImage
Loads image from file.
See more: vertexai.preview.vision_models.GeneratedImage.load_from_file
vertexai.preview.vision_models.GeneratedImage.save
save(location: str, include_generation_parameters: bool = True)
Saves image to a file.
See more: vertexai.preview.vision_models.GeneratedImage.save
vertexai.preview.vision_models.GeneratedImage.show
show()
Shows the image.
See more: vertexai.preview.vision_models.GeneratedImage.show
vertexai.preview.vision_models.Image
Image(
image_bytes: typing.Optional[bytes] = None, gcs_uri: typing.Optional[str] = None
)
Creates an Image
object.
See more: vertexai.preview.vision_models.Image
vertexai.preview.vision_models.Image.load_from_file
load_from_file(location: str) -> vertexai.vision_models.Image
Loads image from local file or Google Cloud Storage.
See more: vertexai.preview.vision_models.Image.load_from_file
vertexai.preview.vision_models.Image.save
save(location: str)
Saves image to a file.
vertexai.preview.vision_models.Image.show
show()
Shows the image.
vertexai.preview.vision_models.ImageCaptioningModel
ImageCaptioningModel(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a _ModelGardenModel.
See more: vertexai.preview.vision_models.ImageCaptioningModel
vertexai.preview.vision_models.ImageCaptioningModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.preview.vision_models.ImageCaptioningModel.from_pretrained
vertexai.preview.vision_models.ImageCaptioningModel.get_captions
get_captions(
image: vertexai.vision_models.Image,
*,
number_of_results: int = 1,
language: str = "en",
output_gcs_uri: typing.Optional[str] = None
) -> typing.List[str]
Generates captions for a given image.
See more: vertexai.preview.vision_models.ImageCaptioningModel.get_captions
vertexai.preview.vision_models.ImageGenerationModel
ImageGenerationModel(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a _ModelGardenModel.
See more: vertexai.preview.vision_models.ImageGenerationModel
vertexai.preview.vision_models.ImageGenerationModel.edit_image
edit_image(
*,
prompt: str,
base_image: vertexai.vision_models.Image,
mask: typing.Optional[vertexai.vision_models.Image] = None,
negative_prompt: typing.Optional[str] = None,
number_of_images: int = 1,
guidance_scale: typing.Optional[float] = None,
edit_mode: typing.Optional[
typing.Literal[
"inpainting-insert", "inpainting-remove", "outpainting", "product-image"
]
] = None,
mask_mode: typing.Optional[
typing.Literal["background", "foreground", "semantic"]
] = None,
segmentation_classes: typing.Optional[typing.List[str]] = None,
mask_dilation: typing.Optional[float] = None,
product_position: typing.Optional[typing.Literal["fixed", "reposition"]] = None,
output_mime_type: typing.Optional[typing.Literal["image/png", "image/jpeg"]] = None,
compression_quality: typing.Optional[float] = None,
language: typing.Optional[str] = None,
seed: typing.Optional[int] = None,
output_gcs_uri: typing.Optional[str] = None,
safety_filter_level: typing.Optional[
typing.Literal["block_most", "block_some", "block_few", "block_fewest"]
] = None,
person_generation: typing.Optional[
typing.Literal["dont_allow", "allow_adult", "allow_all"]
] = None
) -> vertexai.preview.vision_models.ImageGenerationResponse
Edits an existing image based on text prompt.
See more: vertexai.preview.vision_models.ImageGenerationModel.edit_image
vertexai.preview.vision_models.ImageGenerationModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.preview.vision_models.ImageGenerationModel.from_pretrained
vertexai.preview.vision_models.ImageGenerationModel.generate_images
generate_images(
prompt: str,
*,
negative_prompt: typing.Optional[str] = None,
number_of_images: int = 1,
aspect_ratio: typing.Optional[
typing.Literal["1:1", "9:16", "16:9", "4;3", "3:4"]
] = None,
guidance_scale: typing.Optional[float] = None,
language: typing.Optional[str] = None,
seed: typing.Optional[int] = None,
output_gcs_uri: typing.Optional[str] = None,
add_watermark: typing.Optional[bool] = True,
safety_filter_level: typing.Optional[
typing.Literal["block_most", "block_some", "block_few", "block_fewest"]
] = None,
person_generation: typing.Optional[
typing.Literal["dont_allow", "allow_adult", "allow_all"]
] = None
) -> vertexai.preview.vision_models.ImageGenerationResponse
Generates images from text prompt.
See more: vertexai.preview.vision_models.ImageGenerationModel.generate_images
vertexai.preview.vision_models.ImageGenerationModel.upscale_image
upscale_image(
image: typing.Union[
vertexai.vision_models.Image, vertexai.preview.vision_models.GeneratedImage
],
new_size: typing.Optional[int] = 2048,
output_gcs_uri: typing.Optional[str] = None,
) -> vertexai.vision_models.Image
Upscales an image.
See more: vertexai.preview.vision_models.ImageGenerationModel.upscale_image
vertexai.preview.vision_models.ImageGenerationResponse.__getitem__
__getitem__(idx: int) -> vertexai.preview.vision_models.GeneratedImage
Gets the generated image by index.
See more: vertexai.preview.vision_models.ImageGenerationResponse.getitem
vertexai.preview.vision_models.ImageGenerationResponse.__iter__
__iter__() -> typing.Iterator[vertexai.preview.vision_models.GeneratedImage]
Iterates through the generated images.
See more: vertexai.preview.vision_models.ImageGenerationResponse.iter
vertexai.preview.vision_models.ImageQnAModel
ImageQnAModel(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a _ModelGardenModel.
vertexai.preview.vision_models.ImageQnAModel.ask_question
ask_question(
image: vertexai.vision_models.Image, question: str, *, number_of_results: int = 1
) -> typing.List[str]
Answers questions about an image.
See more: vertexai.preview.vision_models.ImageQnAModel.ask_question
vertexai.preview.vision_models.ImageQnAModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.preview.vision_models.ImageQnAModel.from_pretrained
vertexai.preview.vision_models.ImageTextModel
ImageTextModel(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a _ModelGardenModel.
vertexai.preview.vision_models.ImageTextModel.ask_question
ask_question(
image: vertexai.vision_models.Image, question: str, *, number_of_results: int = 1
) -> typing.List[str]
Answers questions about an image.
See more: vertexai.preview.vision_models.ImageTextModel.ask_question
vertexai.preview.vision_models.ImageTextModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.preview.vision_models.ImageTextModel.from_pretrained
vertexai.preview.vision_models.ImageTextModel.get_captions
get_captions(
image: vertexai.vision_models.Image,
*,
number_of_results: int = 1,
language: str = "en",
output_gcs_uri: typing.Optional[str] = None
) -> typing.List[str]
Generates captions for a given image.
See more: vertexai.preview.vision_models.ImageTextModel.get_captions
vertexai.preview.vision_models.MultiModalEmbeddingModel
MultiModalEmbeddingModel(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a _ModelGardenModel.
See more: vertexai.preview.vision_models.MultiModalEmbeddingModel
vertexai.preview.vision_models.MultiModalEmbeddingModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.preview.vision_models.MultiModalEmbeddingModel.from_pretrained
vertexai.preview.vision_models.MultiModalEmbeddingModel.get_embeddings
get_embeddings(
image: typing.Optional[vertexai.vision_models.Image] = None,
video: typing.Optional[vertexai.vision_models.Video] = None,
contextual_text: typing.Optional[str] = None,
dimension: typing.Optional[int] = None,
video_segment_config: typing.Optional[
vertexai.vision_models.VideoSegmentConfig
] = None,
) -> vertexai.vision_models.MultiModalEmbeddingResponse
Gets embedding vectors from the provided image.
See more: vertexai.preview.vision_models.MultiModalEmbeddingModel.get_embeddings
vertexai.preview.vision_models.Video
Video(
video_bytes: typing.Optional[bytes] = None, gcs_uri: typing.Optional[str] = None
)
Creates an Image
object.
See more: vertexai.preview.vision_models.Video
vertexai.preview.vision_models.Video.load_from_file
load_from_file(location: str) -> vertexai.vision_models.Video
Loads video from local file or Google Cloud Storage.
See more: vertexai.preview.vision_models.Video.load_from_file
vertexai.preview.vision_models.Video.save
save(location: str)
Saves video to a file.
vertexai.preview.vision_models.VideoEmbedding
VideoEmbedding(
start_offset_sec: int, end_offset_sec: int, embedding: typing.List[float]
)
Creates a VideoEmbedding
object.
vertexai.preview.vision_models.VideoSegmentConfig
VideoSegmentConfig(
start_offset_sec: int = 0, end_offset_sec: int = 120, interval_sec: int = 16
)
Creates a VideoSegmentConfig
object.
vertexai.preview.vision_models.WatermarkVerificationModel
WatermarkVerificationModel(
model_id: str, endpoint_name: typing.Optional[str] = None
)
Creates a _ModelGardenModel.
See more: vertexai.preview.vision_models.WatermarkVerificationModel
vertexai.preview.vision_models.WatermarkVerificationModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.preview.vision_models.WatermarkVerificationModel.from_pretrained
vertexai.preview.vision_models.WatermarkVerificationModel.verify_image
verify_image(
image: vertexai.vision_models.Image,
) -> vertexai.preview.vision_models.WatermarkVerificationResponse
Verifies the watermark of an image.
See more: vertexai.preview.vision_models.WatermarkVerificationModel.verify_image
vertexai.vision_models.Image
Image(
image_bytes: typing.Optional[bytes] = None, gcs_uri: typing.Optional[str] = None
)
Creates an Image
object.
See more: vertexai.vision_models.Image
vertexai.vision_models.Image.load_from_file
load_from_file(location: str) -> vertexai.vision_models.Image
Loads image from local file or Google Cloud Storage.
vertexai.vision_models.Image.save
save(location: str)
Saves image to a file.
See more: vertexai.vision_models.Image.save
vertexai.vision_models.Image.show
show()
Shows the image.
See more: vertexai.vision_models.Image.show
vertexai.vision_models.ImageCaptioningModel
ImageCaptioningModel(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a _ModelGardenModel.
vertexai.vision_models.ImageCaptioningModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.vision_models.ImageCaptioningModel.from_pretrained
vertexai.vision_models.ImageCaptioningModel.get_captions
get_captions(
image: vertexai.vision_models.Image,
*,
number_of_results: int = 1,
language: str = "en",
output_gcs_uri: typing.Optional[str] = None
) -> typing.List[str]
Generates captions for a given image.
See more: vertexai.vision_models.ImageCaptioningModel.get_captions
vertexai.vision_models.ImageQnAModel
ImageQnAModel(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a _ModelGardenModel.
See more: vertexai.vision_models.ImageQnAModel
vertexai.vision_models.ImageQnAModel.ask_question
ask_question(
image: vertexai.vision_models.Image, question: str, *, number_of_results: int = 1
) -> typing.List[str]
Answers questions about an image.
vertexai.vision_models.ImageQnAModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.vision_models.ImageQnAModel.from_pretrained
vertexai.vision_models.ImageTextModel
ImageTextModel(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a _ModelGardenModel.
See more: vertexai.vision_models.ImageTextModel
vertexai.vision_models.ImageTextModel.ask_question
ask_question(
image: vertexai.vision_models.Image, question: str, *, number_of_results: int = 1
) -> typing.List[str]
Answers questions about an image.
See more: vertexai.vision_models.ImageTextModel.ask_question
vertexai.vision_models.ImageTextModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.vision_models.ImageTextModel.from_pretrained
vertexai.vision_models.ImageTextModel.get_captions
get_captions(
image: vertexai.vision_models.Image,
*,
number_of_results: int = 1,
language: str = "en",
output_gcs_uri: typing.Optional[str] = None
) -> typing.List[str]
Generates captions for a given image.
See more: vertexai.vision_models.ImageTextModel.get_captions
vertexai.vision_models.MultiModalEmbeddingModel
MultiModalEmbeddingModel(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a _ModelGardenModel.
vertexai.vision_models.MultiModalEmbeddingModel.from_pretrained
from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T
Loads a _ModelGardenModel.
See more: vertexai.vision_models.MultiModalEmbeddingModel.from_pretrained
vertexai.vision_models.MultiModalEmbeddingModel.get_embeddings
get_embeddings(
image: typing.Optional[vertexai.vision_models.Image] = None,
video: typing.Optional[vertexai.vision_models.Video] = None,
contextual_text: typing.Optional[str] = None,
dimension: typing.Optional[int] = None,
video_segment_config: typing.Optional[
vertexai.vision_models.VideoSegmentConfig
] = None,
) -> vertexai.vision_models.MultiModalEmbeddingResponse
Gets embedding vectors from the provided image.
See more: vertexai.vision_models.MultiModalEmbeddingModel.get_embeddings
vertexai.vision_models.Video
Video(
video_bytes: typing.Optional[bytes] = None, gcs_uri: typing.Optional[str] = None
)
Creates an Image
object.
See more: vertexai.vision_models.Video
vertexai.vision_models.Video.load_from_file
load_from_file(location: str) -> vertexai.vision_models.Video
Loads video from local file or Google Cloud Storage.
vertexai.vision_models.Video.save
save(location: str)
Saves video to a file.
See more: vertexai.vision_models.Video.save
vertexai.vision_models.VideoEmbedding
VideoEmbedding(
start_offset_sec: int, end_offset_sec: int, embedding: typing.List[float]
)
Creates a VideoEmbedding
object.
See more: vertexai.vision_models.VideoEmbedding
vertexai.vision_models.VideoSegmentConfig
VideoSegmentConfig(
start_offset_sec: int = 0, end_offset_sec: int = 120, interval_sec: int = 16
)
Creates a VideoSegmentConfig
object.