aiplatformpb

package
v1.67.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 8, 2024 License: Apache-2.0 Imports: 21 Imported by: 12

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	AcceleratorType_name = map[int32]string{
		0:  "ACCELERATOR_TYPE_UNSPECIFIED",
		1:  "NVIDIA_TESLA_K80",
		2:  "NVIDIA_TESLA_P100",
		3:  "NVIDIA_TESLA_V100",
		4:  "NVIDIA_TESLA_P4",
		5:  "NVIDIA_TESLA_T4",
		8:  "NVIDIA_TESLA_A100",
		9:  "NVIDIA_A100_80GB",
		11: "NVIDIA_L4",
		13: "NVIDIA_H100_80GB",
		6:  "TPU_V2",
		7:  "TPU_V3",
		10: "TPU_V4_POD",
	}
	AcceleratorType_value = map[string]int32{
		"ACCELERATOR_TYPE_UNSPECIFIED": 0,
		"NVIDIA_TESLA_K80":             1,
		"NVIDIA_TESLA_P100":            2,
		"NVIDIA_TESLA_V100":            3,
		"NVIDIA_TESLA_P4":              4,
		"NVIDIA_TESLA_T4":              5,
		"NVIDIA_TESLA_A100":            8,
		"NVIDIA_A100_80GB":             9,
		"NVIDIA_L4":                    11,
		"NVIDIA_H100_80GB":             13,
		"TPU_V2":                       6,
		"TPU_V3":                       7,
		"TPU_V4_POD":                   10,
	}
)

Enum value maps for AcceleratorType.

View Source
var (
	Artifact_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "PENDING",
		2: "LIVE",
	}
	Artifact_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"PENDING":           1,
		"LIVE":              2,
	}
)

Enum value maps for Artifact_State.

View Source
var (
	HarmCategory_name = map[int32]string{
		0: "HARM_CATEGORY_UNSPECIFIED",
		1: "HARM_CATEGORY_HATE_SPEECH",
		2: "HARM_CATEGORY_DANGEROUS_CONTENT",
		3: "HARM_CATEGORY_HARASSMENT",
		4: "HARM_CATEGORY_SEXUALLY_EXPLICIT",
	}
	HarmCategory_value = map[string]int32{
		"HARM_CATEGORY_UNSPECIFIED":       0,
		"HARM_CATEGORY_HATE_SPEECH":       1,
		"HARM_CATEGORY_DANGEROUS_CONTENT": 2,
		"HARM_CATEGORY_HARASSMENT":        3,
		"HARM_CATEGORY_SEXUALLY_EXPLICIT": 4,
	}
)

Enum value maps for HarmCategory.

View Source
var (
	SafetySetting_HarmBlockThreshold_name = map[int32]string{
		0: "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
		1: "BLOCK_LOW_AND_ABOVE",
		2: "BLOCK_MEDIUM_AND_ABOVE",
		3: "BLOCK_ONLY_HIGH",
		4: "BLOCK_NONE",
	}
	SafetySetting_HarmBlockThreshold_value = map[string]int32{
		"HARM_BLOCK_THRESHOLD_UNSPECIFIED": 0,
		"BLOCK_LOW_AND_ABOVE":              1,
		"BLOCK_MEDIUM_AND_ABOVE":           2,
		"BLOCK_ONLY_HIGH":                  3,
		"BLOCK_NONE":                       4,
	}
)

Enum value maps for SafetySetting_HarmBlockThreshold.

View Source
var (
	SafetySetting_HarmBlockMethod_name = map[int32]string{
		0: "HARM_BLOCK_METHOD_UNSPECIFIED",
		1: "SEVERITY",
		2: "PROBABILITY",
	}
	SafetySetting_HarmBlockMethod_value = map[string]int32{
		"HARM_BLOCK_METHOD_UNSPECIFIED": 0,
		"SEVERITY":                      1,
		"PROBABILITY":                   2,
	}
)

Enum value maps for SafetySetting_HarmBlockMethod.

View Source
var (
	SafetyRating_HarmProbability_name = map[int32]string{
		0: "HARM_PROBABILITY_UNSPECIFIED",
		1: "NEGLIGIBLE",
		2: "LOW",
		3: "MEDIUM",
		4: "HIGH",
	}
	SafetyRating_HarmProbability_value = map[string]int32{
		"HARM_PROBABILITY_UNSPECIFIED": 0,
		"NEGLIGIBLE":                   1,
		"LOW":                          2,
		"MEDIUM":                       3,
		"HIGH":                         4,
	}
)

Enum value maps for SafetyRating_HarmProbability.

View Source
var (
	SafetyRating_HarmSeverity_name = map[int32]string{
		0: "HARM_SEVERITY_UNSPECIFIED",
		1: "HARM_SEVERITY_NEGLIGIBLE",
		2: "HARM_SEVERITY_LOW",
		3: "HARM_SEVERITY_MEDIUM",
		4: "HARM_SEVERITY_HIGH",
	}
	SafetyRating_HarmSeverity_value = map[string]int32{
		"HARM_SEVERITY_UNSPECIFIED": 0,
		"HARM_SEVERITY_NEGLIGIBLE":  1,
		"HARM_SEVERITY_LOW":         2,
		"HARM_SEVERITY_MEDIUM":      3,
		"HARM_SEVERITY_HIGH":        4,
	}
)

Enum value maps for SafetyRating_HarmSeverity.

View Source
var (
	Candidate_FinishReason_name = map[int32]string{
		0: "FINISH_REASON_UNSPECIFIED",
		1: "STOP",
		2: "MAX_TOKENS",
		3: "SAFETY",
		4: "RECITATION",
		5: "OTHER",
		6: "BLOCKLIST",
		7: "PROHIBITED_CONTENT",
		8: "SPII",
	}
	Candidate_FinishReason_value = map[string]int32{
		"FINISH_REASON_UNSPECIFIED": 0,
		"STOP":                      1,
		"MAX_TOKENS":                2,
		"SAFETY":                    3,
		"RECITATION":                4,
		"OTHER":                     5,
		"BLOCKLIST":                 6,
		"PROHIBITED_CONTENT":        7,
		"SPII":                      8,
	}
)

Enum value maps for Candidate_FinishReason.

View Source
var (
	SampleConfig_SampleStrategy_name = map[int32]string{
		0: "SAMPLE_STRATEGY_UNSPECIFIED",
		1: "UNCERTAINTY",
	}
	SampleConfig_SampleStrategy_value = map[string]int32{
		"SAMPLE_STRATEGY_UNSPECIFIED": 0,
		"UNCERTAINTY":                 1,
	}
)

Enum value maps for SampleConfig_SampleStrategy.

View Source
var (
	ExportDataConfig_ExportUse_name = map[int32]string{
		0: "EXPORT_USE_UNSPECIFIED",
		6: "CUSTOM_CODE_TRAINING",
	}
	ExportDataConfig_ExportUse_value = map[string]int32{
		"EXPORT_USE_UNSPECIFIED": 0,
		"CUSTOM_CODE_TRAINING":   6,
	}
)

Enum value maps for ExportDataConfig_ExportUse.

View Source
var (
	EvaluatedAnnotation_EvaluatedAnnotationType_name = map[int32]string{
		0: "EVALUATED_ANNOTATION_TYPE_UNSPECIFIED",
		1: "TRUE_POSITIVE",
		2: "FALSE_POSITIVE",
		3: "FALSE_NEGATIVE",
	}
	EvaluatedAnnotation_EvaluatedAnnotationType_value = map[string]int32{
		"EVALUATED_ANNOTATION_TYPE_UNSPECIFIED": 0,
		"TRUE_POSITIVE":                         1,
		"FALSE_POSITIVE":                        2,
		"FALSE_NEGATIVE":                        3,
	}
)

Enum value maps for EvaluatedAnnotation_EvaluatedAnnotationType.

View Source
var (
	ErrorAnalysisAnnotation_QueryType_name = map[int32]string{
		0: "QUERY_TYPE_UNSPECIFIED",
		1: "ALL_SIMILAR",
		2: "SAME_CLASS_SIMILAR",
		3: "SAME_CLASS_DISSIMILAR",
	}
	ErrorAnalysisAnnotation_QueryType_value = map[string]int32{
		"QUERY_TYPE_UNSPECIFIED": 0,
		"ALL_SIMILAR":            1,
		"SAME_CLASS_SIMILAR":     2,
		"SAME_CLASS_DISSIMILAR":  3,
	}
)

Enum value maps for ErrorAnalysisAnnotation_QueryType.

View Source
var (
	Event_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "INPUT",
		2: "OUTPUT",
	}
	Event_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"INPUT":            1,
		"OUTPUT":           2,
	}
)

Enum value maps for Event_Type.

View Source
var (
	Execution_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "NEW",
		2: "RUNNING",
		3: "COMPLETE",
		4: "FAILED",
		5: "CACHED",
		6: "CANCELLED",
	}
	Execution_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"NEW":               1,
		"RUNNING":           2,
		"COMPLETE":          3,
		"FAILED":            4,
		"CACHED":            5,
		"CANCELLED":         6,
	}
)

Enum value maps for Execution_State.

View Source
var (
	Examples_ExampleGcsSource_DataFormat_name = map[int32]string{
		0: "DATA_FORMAT_UNSPECIFIED",
		1: "JSONL",
	}
	Examples_ExampleGcsSource_DataFormat_value = map[string]int32{
		"DATA_FORMAT_UNSPECIFIED": 0,
		"JSONL":                   1,
	}
)

Enum value maps for Examples_ExampleGcsSource_DataFormat.

View Source
var (
	Presets_Query_name = map[int32]string{
		0: "PRECISE",
		1: "FAST",
	}
	Presets_Query_value = map[string]int32{
		"PRECISE": 0,
		"FAST":    1,
	}
)

Enum value maps for Presets_Query.

View Source
var (
	Presets_Modality_name = map[int32]string{
		0: "MODALITY_UNSPECIFIED",
		1: "IMAGE",
		2: "TEXT",
		3: "TABULAR",
	}
	Presets_Modality_value = map[string]int32{
		"MODALITY_UNSPECIFIED": 0,
		"IMAGE":                1,
		"TEXT":                 2,
		"TABULAR":              3,
	}
)

Enum value maps for Presets_Modality.

View Source
var (
	ExamplesOverride_DataFormat_name = map[int32]string{
		0: "DATA_FORMAT_UNSPECIFIED",
		1: "INSTANCES",
		2: "EMBEDDINGS",
	}
	ExamplesOverride_DataFormat_value = map[string]int32{
		"DATA_FORMAT_UNSPECIFIED": 0,
		"INSTANCES":               1,
		"EMBEDDINGS":              2,
	}
)

Enum value maps for ExamplesOverride_DataFormat.

View Source
var (
	ExplanationMetadata_InputMetadata_Encoding_name = map[int32]string{
		0: "ENCODING_UNSPECIFIED",
		1: "IDENTITY",
		2: "BAG_OF_FEATURES",
		3: "BAG_OF_FEATURES_SPARSE",
		4: "INDICATOR",
		5: "COMBINED_EMBEDDING",
		6: "CONCAT_EMBEDDING",
	}
	ExplanationMetadata_InputMetadata_Encoding_value = map[string]int32{
		"ENCODING_UNSPECIFIED":   0,
		"IDENTITY":               1,
		"BAG_OF_FEATURES":        2,
		"BAG_OF_FEATURES_SPARSE": 3,
		"INDICATOR":              4,
		"COMBINED_EMBEDDING":     5,
		"CONCAT_EMBEDDING":       6,
	}
)

Enum value maps for ExplanationMetadata_InputMetadata_Encoding.

View Source
var (
	ExplanationMetadata_InputMetadata_Visualization_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "PIXELS",
		2: "OUTLINES",
	}
	ExplanationMetadata_InputMetadata_Visualization_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"PIXELS":           1,
		"OUTLINES":         2,
	}
)

Enum value maps for ExplanationMetadata_InputMetadata_Visualization_Type.

View Source
var (
	ExplanationMetadata_InputMetadata_Visualization_Polarity_name = map[int32]string{
		0: "POLARITY_UNSPECIFIED",
		1: "POSITIVE",
		2: "NEGATIVE",
		3: "BOTH",
	}
	ExplanationMetadata_InputMetadata_Visualization_Polarity_value = map[string]int32{
		"POLARITY_UNSPECIFIED": 0,
		"POSITIVE":             1,
		"NEGATIVE":             2,
		"BOTH":                 3,
	}
)

Enum value maps for ExplanationMetadata_InputMetadata_Visualization_Polarity.

View Source
var (
	ExplanationMetadata_InputMetadata_Visualization_ColorMap_name = map[int32]string{
		0: "COLOR_MAP_UNSPECIFIED",
		1: "PINK_GREEN",
		2: "VIRIDIS",
		3: "RED",
		4: "GREEN",
		6: "RED_GREEN",
		5: "PINK_WHITE_GREEN",
	}
	ExplanationMetadata_InputMetadata_Visualization_ColorMap_value = map[string]int32{
		"COLOR_MAP_UNSPECIFIED": 0,
		"PINK_GREEN":            1,
		"VIRIDIS":               2,
		"RED":                   3,
		"GREEN":                 4,
		"RED_GREEN":             6,
		"PINK_WHITE_GREEN":      5,
	}
)

Enum value maps for ExplanationMetadata_InputMetadata_Visualization_ColorMap.

View Source
var (
	ExplanationMetadata_InputMetadata_Visualization_OverlayType_name = map[int32]string{
		0: "OVERLAY_TYPE_UNSPECIFIED",
		1: "NONE",
		2: "ORIGINAL",
		3: "GRAYSCALE",
		4: "MASK_BLACK",
	}
	ExplanationMetadata_InputMetadata_Visualization_OverlayType_value = map[string]int32{
		"OVERLAY_TYPE_UNSPECIFIED": 0,
		"NONE":                     1,
		"ORIGINAL":                 2,
		"GRAYSCALE":                3,
		"MASK_BLACK":               4,
	}
)

Enum value maps for ExplanationMetadata_InputMetadata_Visualization_OverlayType.

View Source
var (
	Feature_ValueType_name = map[int32]string{
		0:  "VALUE_TYPE_UNSPECIFIED",
		1:  "BOOL",
		2:  "BOOL_ARRAY",
		3:  "DOUBLE",
		4:  "DOUBLE_ARRAY",
		9:  "INT64",
		10: "INT64_ARRAY",
		11: "STRING",
		12: "STRING_ARRAY",
		13: "BYTES",
	}
	Feature_ValueType_value = map[string]int32{
		"VALUE_TYPE_UNSPECIFIED": 0,
		"BOOL":                   1,
		"BOOL_ARRAY":             2,
		"DOUBLE":                 3,
		"DOUBLE_ARRAY":           4,
		"INT64":                  9,
		"INT64_ARRAY":            10,
		"STRING":                 11,
		"STRING_ARRAY":           12,
		"BYTES":                  13,
	}
)

Enum value maps for Feature_ValueType.

View Source
var (
	Feature_MonitoringStatsAnomaly_Objective_name = map[int32]string{
		0: "OBJECTIVE_UNSPECIFIED",
		1: "IMPORT_FEATURE_ANALYSIS",
		2: "SNAPSHOT_ANALYSIS",
	}
	Feature_MonitoringStatsAnomaly_Objective_value = map[string]int32{
		"OBJECTIVE_UNSPECIFIED":   0,
		"IMPORT_FEATURE_ANALYSIS": 1,
		"SNAPSHOT_ANALYSIS":       2,
	}
)

Enum value maps for Feature_MonitoringStatsAnomaly_Objective.

View Source
var (
	FeatureOnlineStore_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "STABLE",
		2: "UPDATING",
	}
	FeatureOnlineStore_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"STABLE":            1,
		"UPDATING":          2,
	}
)

Enum value maps for FeatureOnlineStore_State.

View Source
var (
	FeatureViewDataFormat_name = map[int32]string{
		0: "FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED",
		1: "KEY_VALUE",
		2: "PROTO_STRUCT",
	}
	FeatureViewDataFormat_value = map[string]int32{
		"FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED": 0,
		"KEY_VALUE":                            1,
		"PROTO_STRUCT":                         2,
	}
)

Enum value maps for FeatureViewDataFormat.

View Source
var (
	FeatureView_IndexConfig_DistanceMeasureType_name = map[int32]string{
		0: "DISTANCE_MEASURE_TYPE_UNSPECIFIED",
		1: "SQUARED_L2_DISTANCE",
		2: "COSINE_DISTANCE",
		3: "DOT_PRODUCT_DISTANCE",
	}
	FeatureView_IndexConfig_DistanceMeasureType_value = map[string]int32{
		"DISTANCE_MEASURE_TYPE_UNSPECIFIED": 0,
		"SQUARED_L2_DISTANCE":               1,
		"COSINE_DISTANCE":                   2,
		"DOT_PRODUCT_DISTANCE":              3,
	}
)

Enum value maps for FeatureView_IndexConfig_DistanceMeasureType.

View Source
var (
	Featurestore_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "STABLE",
		2: "UPDATING",
	}
	Featurestore_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"STABLE":            1,
		"UPDATING":          2,
	}
)

Enum value maps for Featurestore_State.

View Source
var (
	FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "DEFAULT",
		2: "ENABLED",
		3: "DISABLED",
	}
	FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"DEFAULT":           1,
		"ENABLED":           2,
		"DISABLED":          3,
	}
)

Enum value maps for FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State.

View Source
var (
	FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline_name = map[int32]string{
		0: "BASELINE_UNSPECIFIED",
		1: "LATEST_STATS",
		2: "MOST_RECENT_SNAPSHOT_STATS",
		3: "PREVIOUS_IMPORT_FEATURES_STATS",
	}
	FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline_value = map[string]int32{
		"BASELINE_UNSPECIFIED":           0,
		"LATEST_STATS":                   1,
		"MOST_RECENT_SNAPSHOT_STATS":     2,
		"PREVIOUS_IMPORT_FEATURES_STATS": 3,
	}
)

Enum value maps for FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline.

View Source
var (
	Index_IndexUpdateMethod_name = map[int32]string{
		0: "INDEX_UPDATE_METHOD_UNSPECIFIED",
		1: "BATCH_UPDATE",
		2: "STREAM_UPDATE",
	}
	Index_IndexUpdateMethod_value = map[string]int32{
		"INDEX_UPDATE_METHOD_UNSPECIFIED": 0,
		"BATCH_UPDATE":                    1,
		"STREAM_UPDATE":                   2,
	}
)

Enum value maps for Index_IndexUpdateMethod.

View Source
var (
	IndexDatapoint_NumericRestriction_Operator_name = map[int32]string{
		0: "OPERATOR_UNSPECIFIED",
		1: "LESS",
		2: "LESS_EQUAL",
		3: "EQUAL",
		4: "GREATER_EQUAL",
		5: "GREATER",
		6: "NOT_EQUAL",
	}
	IndexDatapoint_NumericRestriction_Operator_value = map[string]int32{
		"OPERATOR_UNSPECIFIED": 0,
		"LESS":                 1,
		"LESS_EQUAL":           2,
		"EQUAL":                3,
		"GREATER_EQUAL":        4,
		"GREATER":              5,
		"NOT_EQUAL":            6,
	}
)

Enum value maps for IndexDatapoint_NumericRestriction_Operator.

View Source
var (
	NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType_name = map[int32]string{
		0:  "ERROR_TYPE_UNSPECIFIED",
		1:  "EMPTY_LINE",
		2:  "INVALID_JSON_SYNTAX",
		3:  "INVALID_CSV_SYNTAX",
		4:  "INVALID_AVRO_SYNTAX",
		5:  "INVALID_EMBEDDING_ID",
		6:  "EMBEDDING_SIZE_MISMATCH",
		7:  "NAMESPACE_MISSING",
		8:  "PARSING_ERROR",
		9:  "DUPLICATE_NAMESPACE",
		10: "OP_IN_DATAPOINT",
		11: "MULTIPLE_VALUES",
		12: "INVALID_NUMERIC_VALUE",
		13: "INVALID_ENCODING",
	}
	NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType_value = map[string]int32{
		"ERROR_TYPE_UNSPECIFIED":  0,
		"EMPTY_LINE":              1,
		"INVALID_JSON_SYNTAX":     2,
		"INVALID_CSV_SYNTAX":      3,
		"INVALID_AVRO_SYNTAX":     4,
		"INVALID_EMBEDDING_ID":    5,
		"EMBEDDING_SIZE_MISMATCH": 6,
		"NAMESPACE_MISSING":       7,
		"PARSING_ERROR":           8,
		"DUPLICATE_NAMESPACE":     9,
		"OP_IN_DATAPOINT":         10,
		"MULTIPLE_VALUES":         11,
		"INVALID_NUMERIC_VALUE":   12,
		"INVALID_ENCODING":        13,
	}
)

Enum value maps for NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType.

View Source
var (
	JobState_name = map[int32]string{
		0:  "JOB_STATE_UNSPECIFIED",
		1:  "JOB_STATE_QUEUED",
		2:  "JOB_STATE_PENDING",
		3:  "JOB_STATE_RUNNING",
		4:  "JOB_STATE_SUCCEEDED",
		5:  "JOB_STATE_FAILED",
		6:  "JOB_STATE_CANCELLING",
		7:  "JOB_STATE_CANCELLED",
		8:  "JOB_STATE_PAUSED",
		9:  "JOB_STATE_EXPIRED",
		10: "JOB_STATE_UPDATING",
		11: "JOB_STATE_PARTIALLY_SUCCEEDED",
	}
	JobState_value = map[string]int32{
		"JOB_STATE_UNSPECIFIED":         0,
		"JOB_STATE_QUEUED":              1,
		"JOB_STATE_PENDING":             2,
		"JOB_STATE_RUNNING":             3,
		"JOB_STATE_SUCCEEDED":           4,
		"JOB_STATE_FAILED":              5,
		"JOB_STATE_CANCELLING":          6,
		"JOB_STATE_CANCELLED":           7,
		"JOB_STATE_PAUSED":              8,
		"JOB_STATE_EXPIRED":             9,
		"JOB_STATE_UPDATING":            10,
		"JOB_STATE_PARTIALLY_SUCCEEDED": 11,
	}
)

Enum value maps for JobState.

View Source
var (
	MetadataSchema_MetadataSchemaType_name = map[int32]string{
		0: "METADATA_SCHEMA_TYPE_UNSPECIFIED",
		1: "ARTIFACT_TYPE",
		2: "EXECUTION_TYPE",
		3: "CONTEXT_TYPE",
	}
	MetadataSchema_MetadataSchemaType_value = map[string]int32{
		"METADATA_SCHEMA_TYPE_UNSPECIFIED": 0,
		"ARTIFACT_TYPE":                    1,
		"EXECUTION_TYPE":                   2,
		"CONTEXT_TYPE":                     3,
	}
)

Enum value maps for MetadataSchema_MetadataSchemaType.

View Source
var (
	Model_DeploymentResourcesType_name = map[int32]string{
		0: "DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED",
		1: "DEDICATED_RESOURCES",
		2: "AUTOMATIC_RESOURCES",
		3: "SHARED_RESOURCES",
	}
	Model_DeploymentResourcesType_value = map[string]int32{
		"DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED": 0,
		"DEDICATED_RESOURCES":                   1,
		"AUTOMATIC_RESOURCES":                   2,
		"SHARED_RESOURCES":                      3,
	}
)

Enum value maps for Model_DeploymentResourcesType.

View Source
var (
	Model_ExportFormat_ExportableContent_name = map[int32]string{
		0: "EXPORTABLE_CONTENT_UNSPECIFIED",
		1: "ARTIFACT",
		2: "IMAGE",
	}
	Model_ExportFormat_ExportableContent_value = map[string]int32{
		"EXPORTABLE_CONTENT_UNSPECIFIED": 0,
		"ARTIFACT":                       1,
		"IMAGE":                          2,
	}
)

Enum value maps for Model_ExportFormat_ExportableContent.

View Source
var (
	ModelSourceInfo_ModelSourceType_name = map[int32]string{
		0: "MODEL_SOURCE_TYPE_UNSPECIFIED",
		1: "AUTOML",
		2: "CUSTOM",
		3: "BQML",
		4: "MODEL_GARDEN",
		5: "GENIE",
		6: "CUSTOM_TEXT_EMBEDDING",
		7: "MARKETPLACE",
	}
	ModelSourceInfo_ModelSourceType_value = map[string]int32{
		"MODEL_SOURCE_TYPE_UNSPECIFIED": 0,
		"AUTOML":                        1,
		"CUSTOM":                        2,
		"BQML":                          3,
		"MODEL_GARDEN":                  4,
		"GENIE":                         5,
		"CUSTOM_TEXT_EMBEDDING":         6,
		"MARKETPLACE":                   7,
	}
)

Enum value maps for ModelSourceInfo_ModelSourceType.

View Source
var (
	ModelDeploymentMonitoringObjectiveType_name = map[int32]string{
		0: "MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED",
		1: "RAW_FEATURE_SKEW",
		2: "RAW_FEATURE_DRIFT",
		3: "FEATURE_ATTRIBUTION_SKEW",
		4: "FEATURE_ATTRIBUTION_DRIFT",
	}
	ModelDeploymentMonitoringObjectiveType_value = map[string]int32{
		"MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED": 0,
		"RAW_FEATURE_SKEW":          1,
		"RAW_FEATURE_DRIFT":         2,
		"FEATURE_ATTRIBUTION_SKEW":  3,
		"FEATURE_ATTRIBUTION_DRIFT": 4,
	}
)

Enum value maps for ModelDeploymentMonitoringObjectiveType.

View Source
var (
	ModelDeploymentMonitoringJob_MonitoringScheduleState_name = map[int32]string{
		0: "MONITORING_SCHEDULE_STATE_UNSPECIFIED",
		1: "PENDING",
		2: "OFFLINE",
		3: "RUNNING",
	}
	ModelDeploymentMonitoringJob_MonitoringScheduleState_value = map[string]int32{
		"MONITORING_SCHEDULE_STATE_UNSPECIFIED": 0,
		"PENDING":                               1,
		"OFFLINE":                               2,
		"RUNNING":                               3,
	}
)

Enum value maps for ModelDeploymentMonitoringJob_MonitoringScheduleState.

View Source
var (
	ModelDeploymentMonitoringBigQueryTable_LogSource_name = map[int32]string{
		0: "LOG_SOURCE_UNSPECIFIED",
		1: "TRAINING",
		2: "SERVING",
	}
	ModelDeploymentMonitoringBigQueryTable_LogSource_value = map[string]int32{
		"LOG_SOURCE_UNSPECIFIED": 0,
		"TRAINING":               1,
		"SERVING":                2,
	}
)

Enum value maps for ModelDeploymentMonitoringBigQueryTable_LogSource.

View Source
var (
	ModelDeploymentMonitoringBigQueryTable_LogType_name = map[int32]string{
		0: "LOG_TYPE_UNSPECIFIED",
		1: "PREDICT",
		2: "EXPLAIN",
	}
	ModelDeploymentMonitoringBigQueryTable_LogType_value = map[string]int32{
		"LOG_TYPE_UNSPECIFIED": 0,
		"PREDICT":              1,
		"EXPLAIN":              2,
	}
)

Enum value maps for ModelDeploymentMonitoringBigQueryTable_LogType.

View Source
var (
	PublisherModelView_name = map[int32]string{
		0: "PUBLISHER_MODEL_VIEW_UNSPECIFIED",
		1: "PUBLISHER_MODEL_VIEW_BASIC",
		2: "PUBLISHER_MODEL_VIEW_FULL",
		3: "PUBLISHER_MODEL_VERSION_VIEW_BASIC",
	}
	PublisherModelView_value = map[string]int32{
		"PUBLISHER_MODEL_VIEW_UNSPECIFIED":   0,
		"PUBLISHER_MODEL_VIEW_BASIC":         1,
		"PUBLISHER_MODEL_VIEW_FULL":          2,
		"PUBLISHER_MODEL_VERSION_VIEW_BASIC": 3,
	}
)

Enum value maps for PublisherModelView.

View Source
var (
	ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat_name = map[int32]string{
		0: "PREDICTION_FORMAT_UNSPECIFIED",
		2: "JSONL",
		3: "BIGQUERY",
	}
	ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat_value = map[string]int32{
		"PREDICTION_FORMAT_UNSPECIFIED": 0,
		"JSONL":                         2,
		"BIGQUERY":                      3,
	}
)

Enum value maps for ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat.

View Source
var (
	NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm_name = map[int32]string{
		0: "MULTI_TRIAL_ALGORITHM_UNSPECIFIED",
		1: "REINFORCEMENT_LEARNING",
		2: "GRID_SEARCH",
	}
	NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm_value = map[string]int32{
		"MULTI_TRIAL_ALGORITHM_UNSPECIFIED": 0,
		"REINFORCEMENT_LEARNING":            1,
		"GRID_SEARCH":                       2,
	}
)

Enum value maps for NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm.

View Source
var (
	NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType_name = map[int32]string{
		0: "GOAL_TYPE_UNSPECIFIED",
		1: "MAXIMIZE",
		2: "MINIMIZE",
	}
	NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType_value = map[string]int32{
		"GOAL_TYPE_UNSPECIFIED": 0,
		"MAXIMIZE":              1,
		"MINIMIZE":              2,
	}
)

Enum value maps for NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType.

View Source
var (
	NasTrial_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "REQUESTED",
		2: "ACTIVE",
		3: "STOPPING",
		4: "SUCCEEDED",
		5: "INFEASIBLE",
	}
	NasTrial_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"REQUESTED":         1,
		"ACTIVE":            2,
		"STOPPING":          3,
		"SUCCEEDED":         4,
		"INFEASIBLE":        5,
	}
)

Enum value maps for NasTrial_State.

View Source
var (
	NotebookRuntimeType_name = map[int32]string{
		0: "NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED",
		1: "USER_DEFINED",
		2: "ONE_CLICK",
	}
	NotebookRuntimeType_value = map[string]int32{
		"NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED": 0,
		"USER_DEFINED":                      1,
		"ONE_CLICK":                         2,
	}
)

Enum value maps for NotebookRuntimeType.

View Source
var (
	NotebookRuntime_HealthState_name = map[int32]string{
		0: "HEALTH_STATE_UNSPECIFIED",
		1: "HEALTHY",
		2: "UNHEALTHY",
	}
	NotebookRuntime_HealthState_value = map[string]int32{
		"HEALTH_STATE_UNSPECIFIED": 0,
		"HEALTHY":                  1,
		"UNHEALTHY":                2,
	}
)

Enum value maps for NotebookRuntime_HealthState.

View Source
var (
	NotebookRuntime_RuntimeState_name = map[int32]string{
		0:   "RUNTIME_STATE_UNSPECIFIED",
		1:   "RUNNING",
		2:   "BEING_STARTED",
		3:   "BEING_STOPPED",
		4:   "STOPPED",
		5:   "BEING_UPGRADED",
		100: "ERROR",
		101: "INVALID",
	}
	NotebookRuntime_RuntimeState_value = map[string]int32{
		"RUNTIME_STATE_UNSPECIFIED": 0,
		"RUNNING":                   1,
		"BEING_STARTED":             2,
		"BEING_STOPPED":             3,
		"STOPPED":                   4,
		"BEING_UPGRADED":            5,
		"ERROR":                     100,
		"INVALID":                   101,
	}
)

Enum value maps for NotebookRuntime_RuntimeState.

View Source
var (
	Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "STRING",
		2: "NUMBER",
		3: "INTEGER",
		4: "BOOLEAN",
		5: "ARRAY",
		6: "OBJECT",
	}
	Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"STRING":           1,
		"NUMBER":           2,
		"INTEGER":          3,
		"BOOLEAN":          4,
		"ARRAY":            5,
		"OBJECT":           6,
	}
)

Enum value maps for Type.

View Source
var (
	PersistentResource_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "PROVISIONING",
		3: "RUNNING",
		4: "STOPPING",
		5: "ERROR",
		6: "REBOOTING",
		7: "UPDATING",
	}
	PersistentResource_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"PROVISIONING":      1,
		"RUNNING":           3,
		"STOPPING":          4,
		"ERROR":             5,
		"REBOOTING":         6,
		"UPDATING":          7,
	}
)

Enum value maps for PersistentResource_State.

View Source
var (
	PipelineFailurePolicy_name = map[int32]string{
		0: "PIPELINE_FAILURE_POLICY_UNSPECIFIED",
		1: "PIPELINE_FAILURE_POLICY_FAIL_SLOW",
		2: "PIPELINE_FAILURE_POLICY_FAIL_FAST",
	}
	PipelineFailurePolicy_value = map[string]int32{
		"PIPELINE_FAILURE_POLICY_UNSPECIFIED": 0,
		"PIPELINE_FAILURE_POLICY_FAIL_SLOW":   1,
		"PIPELINE_FAILURE_POLICY_FAIL_FAST":   2,
	}
)

Enum value maps for PipelineFailurePolicy.

View Source
var (
	PipelineTaskDetail_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "PENDING",
		2: "RUNNING",
		3: "SUCCEEDED",
		4: "CANCEL_PENDING",
		5: "CANCELLING",
		6: "CANCELLED",
		7: "FAILED",
		8: "SKIPPED",
		9: "NOT_TRIGGERED",
	}
	PipelineTaskDetail_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"PENDING":           1,
		"RUNNING":           2,
		"SUCCEEDED":         3,
		"CANCEL_PENDING":    4,
		"CANCELLING":        5,
		"CANCELLED":         6,
		"FAILED":            7,
		"SKIPPED":           8,
		"NOT_TRIGGERED":     9,
	}
)

Enum value maps for PipelineTaskDetail_State.

View Source
var (
	PipelineState_name = map[int32]string{
		0: "PIPELINE_STATE_UNSPECIFIED",
		1: "PIPELINE_STATE_QUEUED",
		2: "PIPELINE_STATE_PENDING",
		3: "PIPELINE_STATE_RUNNING",
		4: "PIPELINE_STATE_SUCCEEDED",
		5: "PIPELINE_STATE_FAILED",
		6: "PIPELINE_STATE_CANCELLING",
		7: "PIPELINE_STATE_CANCELLED",
		8: "PIPELINE_STATE_PAUSED",
	}
	PipelineState_value = map[string]int32{
		"PIPELINE_STATE_UNSPECIFIED": 0,
		"PIPELINE_STATE_QUEUED":      1,
		"PIPELINE_STATE_PENDING":     2,
		"PIPELINE_STATE_RUNNING":     3,
		"PIPELINE_STATE_SUCCEEDED":   4,
		"PIPELINE_STATE_FAILED":      5,
		"PIPELINE_STATE_CANCELLING":  6,
		"PIPELINE_STATE_CANCELLED":   7,
		"PIPELINE_STATE_PAUSED":      8,
	}
)

Enum value maps for PipelineState.

View Source
var (
	GenerateContentResponse_PromptFeedback_BlockedReason_name = map[int32]string{
		0: "BLOCKED_REASON_UNSPECIFIED",
		1: "SAFETY",
		2: "OTHER",
		3: "BLOCKLIST",
		4: "PROHIBITED_CONTENT",
	}
	GenerateContentResponse_PromptFeedback_BlockedReason_value = map[string]int32{
		"BLOCKED_REASON_UNSPECIFIED": 0,
		"SAFETY":                     1,
		"OTHER":                      2,
		"BLOCKLIST":                  3,
		"PROHIBITED_CONTENT":         4,
	}
)

Enum value maps for GenerateContentResponse_PromptFeedback_BlockedReason.

View Source
var (
	PublisherModel_OpenSourceCategory_name = map[int32]string{
		0: "OPEN_SOURCE_CATEGORY_UNSPECIFIED",
		1: "PROPRIETARY",
		2: "GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT",
		3: "THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT",
		4: "GOOGLE_OWNED_OSS",
		5: "THIRD_PARTY_OWNED_OSS",
	}
	PublisherModel_OpenSourceCategory_value = map[string]int32{
		"OPEN_SOURCE_CATEGORY_UNSPECIFIED":             0,
		"PROPRIETARY":                                  1,
		"GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT":      2,
		"THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT": 3,
		"GOOGLE_OWNED_OSS":                             4,
		"THIRD_PARTY_OWNED_OSS":                        5,
	}
)

Enum value maps for PublisherModel_OpenSourceCategory.

View Source
var (
	PublisherModel_LaunchStage_name = map[int32]string{
		0: "LAUNCH_STAGE_UNSPECIFIED",
		1: "EXPERIMENTAL",
		2: "PRIVATE_PREVIEW",
		3: "PUBLIC_PREVIEW",
		4: "GA",
	}
	PublisherModel_LaunchStage_value = map[string]int32{
		"LAUNCH_STAGE_UNSPECIFIED": 0,
		"EXPERIMENTAL":             1,
		"PRIVATE_PREVIEW":          2,
		"PUBLIC_PREVIEW":           3,
		"GA":                       4,
	}
)

Enum value maps for PublisherModel_LaunchStage.

View Source
var (
	PublisherModel_VersionState_name = map[int32]string{
		0: "VERSION_STATE_UNSPECIFIED",
		1: "VERSION_STATE_STABLE",
		2: "VERSION_STATE_UNSTABLE",
	}
	PublisherModel_VersionState_value = map[string]int32{
		"VERSION_STATE_UNSPECIFIED": 0,
		"VERSION_STATE_STABLE":      1,
		"VERSION_STATE_UNSTABLE":    2,
	}
)

Enum value maps for PublisherModel_VersionState.

View Source
var (
	Schedule_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "ACTIVE",
		2: "PAUSED",
		3: "COMPLETED",
	}
	Schedule_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"ACTIVE":            1,
		"PAUSED":            2,
		"COMPLETED":         3,
	}
)

Enum value maps for Schedule_State.

View Source
var (
	Study_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "ACTIVE",
		2: "INACTIVE",
		3: "COMPLETED",
	}
	Study_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"ACTIVE":            1,
		"INACTIVE":          2,
		"COMPLETED":         3,
	}
)

Enum value maps for Study_State.

View Source
var (
	Trial_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "REQUESTED",
		2: "ACTIVE",
		3: "STOPPING",
		4: "SUCCEEDED",
		5: "INFEASIBLE",
	}
	Trial_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"REQUESTED":         1,
		"ACTIVE":            2,
		"STOPPING":          3,
		"SUCCEEDED":         4,
		"INFEASIBLE":        5,
	}
)

Enum value maps for Trial_State.

View Source
var (
	StudySpec_Algorithm_name = map[int32]string{
		0: "ALGORITHM_UNSPECIFIED",
		2: "GRID_SEARCH",
		3: "RANDOM_SEARCH",
	}
	StudySpec_Algorithm_value = map[string]int32{
		"ALGORITHM_UNSPECIFIED": 0,
		"GRID_SEARCH":           2,
		"RANDOM_SEARCH":         3,
	}
)

Enum value maps for StudySpec_Algorithm.

View Source
var (
	StudySpec_ObservationNoise_name = map[int32]string{
		0: "OBSERVATION_NOISE_UNSPECIFIED",
		1: "LOW",
		2: "HIGH",
	}
	StudySpec_ObservationNoise_value = map[string]int32{
		"OBSERVATION_NOISE_UNSPECIFIED": 0,
		"LOW":                           1,
		"HIGH":                          2,
	}
)

Enum value maps for StudySpec_ObservationNoise.

View Source
var (
	StudySpec_MeasurementSelectionType_name = map[int32]string{
		0: "MEASUREMENT_SELECTION_TYPE_UNSPECIFIED",
		1: "LAST_MEASUREMENT",
		2: "BEST_MEASUREMENT",
	}
	StudySpec_MeasurementSelectionType_value = map[string]int32{
		"MEASUREMENT_SELECTION_TYPE_UNSPECIFIED": 0,
		"LAST_MEASUREMENT":                       1,
		"BEST_MEASUREMENT":                       2,
	}
)

Enum value maps for StudySpec_MeasurementSelectionType.

View Source
var (
	StudySpec_MetricSpec_GoalType_name = map[int32]string{
		0: "GOAL_TYPE_UNSPECIFIED",
		1: "MAXIMIZE",
		2: "MINIMIZE",
	}
	StudySpec_MetricSpec_GoalType_value = map[string]int32{
		"GOAL_TYPE_UNSPECIFIED": 0,
		"MAXIMIZE":              1,
		"MINIMIZE":              2,
	}
)

Enum value maps for StudySpec_MetricSpec_GoalType.

View Source
var (
	StudySpec_ParameterSpec_ScaleType_name = map[int32]string{
		0: "SCALE_TYPE_UNSPECIFIED",
		1: "UNIT_LINEAR_SCALE",
		2: "UNIT_LOG_SCALE",
		3: "UNIT_REVERSE_LOG_SCALE",
	}
	StudySpec_ParameterSpec_ScaleType_value = map[string]int32{
		"SCALE_TYPE_UNSPECIFIED": 0,
		"UNIT_LINEAR_SCALE":      1,
		"UNIT_LOG_SCALE":         2,
		"UNIT_REVERSE_LOG_SCALE": 3,
	}
)

Enum value maps for StudySpec_ParameterSpec_ScaleType.

View Source
var (
	TensorboardTimeSeries_ValueType_name = map[int32]string{
		0: "VALUE_TYPE_UNSPECIFIED",
		1: "SCALAR",
		2: "TENSOR",
		3: "BLOB_SEQUENCE",
	}
	TensorboardTimeSeries_ValueType_value = map[string]int32{
		"VALUE_TYPE_UNSPECIFIED": 0,
		"SCALAR":                 1,
		"TENSOR":                 2,
		"BLOB_SEQUENCE":          3,
	}
)

Enum value maps for TensorboardTimeSeries_ValueType.

View Source
var (
	SupervisedHyperParameters_AdapterSize_name = map[int32]string{
		0: "ADAPTER_SIZE_UNSPECIFIED",
		1: "ADAPTER_SIZE_ONE",
		2: "ADAPTER_SIZE_FOUR",
		3: "ADAPTER_SIZE_EIGHT",
		4: "ADAPTER_SIZE_SIXTEEN",
	}
	SupervisedHyperParameters_AdapterSize_value = map[string]int32{
		"ADAPTER_SIZE_UNSPECIFIED": 0,
		"ADAPTER_SIZE_ONE":         1,
		"ADAPTER_SIZE_FOUR":        2,
		"ADAPTER_SIZE_EIGHT":       3,
		"ADAPTER_SIZE_SIXTEEN":     4,
	}
)

Enum value maps for SupervisedHyperParameters_AdapterSize.

View Source
var (
	Tensor_DataType_name = map[int32]string{
		0:  "DATA_TYPE_UNSPECIFIED",
		1:  "BOOL",
		2:  "STRING",
		3:  "FLOAT",
		4:  "DOUBLE",
		5:  "INT8",
		6:  "INT16",
		7:  "INT32",
		8:  "INT64",
		9:  "UINT8",
		10: "UINT16",
		11: "UINT32",
		12: "UINT64",
	}
	Tensor_DataType_value = map[string]int32{
		"DATA_TYPE_UNSPECIFIED": 0,
		"BOOL":                  1,
		"STRING":                2,
		"FLOAT":                 3,
		"DOUBLE":                4,
		"INT8":                  5,
		"INT16":                 6,
		"INT32":                 7,
		"INT64":                 8,
		"UINT8":                 9,
		"UINT16":                10,
		"UINT32":                11,
		"UINT64":                12,
	}
)

Enum value maps for Tensor_DataType.

View Source
var File_google_cloud_aiplatform_v1_accelerator_type_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_annotation_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_annotation_spec_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_artifact_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_batch_prediction_job_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_completion_stats_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_content_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_context_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_custom_job_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_data_item_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_data_labeling_job_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_dataset_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_dataset_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_dataset_version_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_deployed_index_ref_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_deployed_model_ref_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_deployment_resource_pool_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_deployment_resource_pool_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_encryption_spec_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_endpoint_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_endpoint_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_entity_type_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_env_var_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_evaluated_annotation_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_event_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_execution_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_explanation_metadata_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_explanation_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_feature_group_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_feature_monitoring_stats_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_feature_online_store_admin_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_feature_online_store_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_feature_online_store_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_feature_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_feature_registry_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_feature_selector_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_feature_view_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_feature_view_sync_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_featurestore_monitoring_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_featurestore_online_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_featurestore_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_featurestore_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_genai_tuning_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_hyperparameter_tuning_job_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_index_endpoint_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_index_endpoint_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_index_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_index_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_io_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_job_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_job_state_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_lineage_subgraph_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_llm_utility_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_machine_resources_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_manual_batch_tuning_parameters_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_match_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_metadata_schema_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_metadata_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_metadata_store_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_migratable_resource_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_migration_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_model_deployment_monitoring_job_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_model_evaluation_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_model_evaluation_slice_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_model_garden_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_model_monitoring_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_model_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_model_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_nas_job_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_network_spec_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_notebook_euc_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_notebook_idle_shutdown_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_notebook_runtime_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_notebook_runtime_template_ref_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_notebook_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_openapi_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_operation_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_persistent_resource_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_persistent_resource_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_pipeline_failure_policy_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_pipeline_job_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_pipeline_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_pipeline_state_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_prediction_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_publisher_model_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_saved_query_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_schedule_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_schedule_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_service_networking_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_specialist_pool_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_specialist_pool_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_study_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_tensorboard_data_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_tensorboard_experiment_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_tensorboard_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_tensorboard_run_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_tensorboard_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_tensorboard_time_series_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_tool_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_training_pipeline_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_tuning_job_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_types_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_unmanaged_container_model_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_user_action_reference_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_value_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1_vizier_service_proto protoreflect.FileDescriptor

Functions

func RegisterDatasetServiceServer

func RegisterDatasetServiceServer(s *grpc.Server, srv DatasetServiceServer)

func RegisterDeploymentResourcePoolServiceServer added in v1.57.0

func RegisterDeploymentResourcePoolServiceServer(s *grpc.Server, srv DeploymentResourcePoolServiceServer)

func RegisterEndpointServiceServer

func RegisterEndpointServiceServer(s *grpc.Server, srv EndpointServiceServer)

func RegisterFeatureOnlineStoreAdminServiceServer added in v1.54.0

func RegisterFeatureOnlineStoreAdminServiceServer(s *grpc.Server, srv FeatureOnlineStoreAdminServiceServer)

func RegisterFeatureOnlineStoreServiceServer added in v1.54.0

func RegisterFeatureOnlineStoreServiceServer(s *grpc.Server, srv FeatureOnlineStoreServiceServer)

func RegisterFeatureRegistryServiceServer added in v1.54.0

func RegisterFeatureRegistryServiceServer(s *grpc.Server, srv FeatureRegistryServiceServer)

func RegisterFeaturestoreOnlineServingServiceServer

func RegisterFeaturestoreOnlineServingServiceServer(s *grpc.Server, srv FeaturestoreOnlineServingServiceServer)

func RegisterFeaturestoreServiceServer

func RegisterFeaturestoreServiceServer(s *grpc.Server, srv FeaturestoreServiceServer)

func RegisterGenAiTuningServiceServer added in v1.67.0

func RegisterGenAiTuningServiceServer(s *grpc.Server, srv GenAiTuningServiceServer)

func RegisterIndexEndpointServiceServer

func RegisterIndexEndpointServiceServer(s *grpc.Server, srv IndexEndpointServiceServer)

func RegisterIndexServiceServer

func RegisterIndexServiceServer(s *grpc.Server, srv IndexServiceServer)

func RegisterJobServiceServer

func RegisterJobServiceServer(s *grpc.Server, srv JobServiceServer)

func RegisterLlmUtilityServiceServer added in v1.54.0

func RegisterLlmUtilityServiceServer(s *grpc.Server, srv LlmUtilityServiceServer)

func RegisterMatchServiceServer added in v1.43.0

func RegisterMatchServiceServer(s *grpc.Server, srv MatchServiceServer)

func RegisterMetadataServiceServer

func RegisterMetadataServiceServer(s *grpc.Server, srv MetadataServiceServer)

func RegisterMigrationServiceServer

func RegisterMigrationServiceServer(s *grpc.Server, srv MigrationServiceServer)

func RegisterModelGardenServiceServer added in v1.44.0

func RegisterModelGardenServiceServer(s *grpc.Server, srv ModelGardenServiceServer)

func RegisterModelServiceServer

func RegisterModelServiceServer(s *grpc.Server, srv ModelServiceServer)

func RegisterNotebookServiceServer added in v1.67.0

func RegisterNotebookServiceServer(s *grpc.Server, srv NotebookServiceServer)

func RegisterPersistentResourceServiceServer added in v1.67.0

func RegisterPersistentResourceServiceServer(s *grpc.Server, srv PersistentResourceServiceServer)

func RegisterPipelineServiceServer

func RegisterPipelineServiceServer(s *grpc.Server, srv PipelineServiceServer)

func RegisterPredictionServiceServer

func RegisterPredictionServiceServer(s *grpc.Server, srv PredictionServiceServer)

func RegisterScheduleServiceServer added in v1.47.0

func RegisterScheduleServiceServer(s *grpc.Server, srv ScheduleServiceServer)

func RegisterSpecialistPoolServiceServer

func RegisterSpecialistPoolServiceServer(s *grpc.Server, srv SpecialistPoolServiceServer)

func RegisterTensorboardServiceServer

func RegisterTensorboardServiceServer(s *grpc.Server, srv TensorboardServiceServer)

func RegisterVizierServiceServer

func RegisterVizierServiceServer(s *grpc.Server, srv VizierServiceServer)

Types

type AcceleratorType

type AcceleratorType int32

Represents a hardware accelerator type.

const (
	// Unspecified accelerator type, which means no accelerator.
	AcceleratorType_ACCELERATOR_TYPE_UNSPECIFIED AcceleratorType = 0
	// Nvidia Tesla K80 GPU.
	AcceleratorType_NVIDIA_TESLA_K80 AcceleratorType = 1
	// Nvidia Tesla P100 GPU.
	AcceleratorType_NVIDIA_TESLA_P100 AcceleratorType = 2
	// Nvidia Tesla V100 GPU.
	AcceleratorType_NVIDIA_TESLA_V100 AcceleratorType = 3
	// Nvidia Tesla P4 GPU.
	AcceleratorType_NVIDIA_TESLA_P4 AcceleratorType = 4
	// Nvidia Tesla T4 GPU.
	AcceleratorType_NVIDIA_TESLA_T4 AcceleratorType = 5
	// Nvidia Tesla A100 GPU.
	AcceleratorType_NVIDIA_TESLA_A100 AcceleratorType = 8
	// Nvidia A100 80GB GPU.
	AcceleratorType_NVIDIA_A100_80GB AcceleratorType = 9
	// Nvidia L4 GPU.
	AcceleratorType_NVIDIA_L4 AcceleratorType = 11
	// Nvidia H100 80Gb GPU.
	AcceleratorType_NVIDIA_H100_80GB AcceleratorType = 13
	// TPU v2.
	AcceleratorType_TPU_V2 AcceleratorType = 6
	// TPU v3.
	AcceleratorType_TPU_V3 AcceleratorType = 7
	// TPU v4.
	AcceleratorType_TPU_V4_POD AcceleratorType = 10
)

func (AcceleratorType) Descriptor

func (AcceleratorType) Enum

func (x AcceleratorType) Enum() *AcceleratorType

func (AcceleratorType) EnumDescriptor deprecated

func (AcceleratorType) EnumDescriptor() ([]byte, []int)

Deprecated: Use AcceleratorType.Descriptor instead.

func (AcceleratorType) Number

func (AcceleratorType) String

func (x AcceleratorType) String() string

func (AcceleratorType) Type

type ActiveLearningConfig

type ActiveLearningConfig struct {

	// Required. Max human labeling DataItems. The rest part will be labeled by
	// machine.
	//
	// Types that are assignable to HumanLabelingBudget:
	//
	//	*ActiveLearningConfig_MaxDataItemCount
	//	*ActiveLearningConfig_MaxDataItemPercentage
	HumanLabelingBudget isActiveLearningConfig_HumanLabelingBudget `protobuf_oneof:"human_labeling_budget"`
	// Active learning data sampling config. For every active learning labeling
	// iteration, it will select a batch of data based on the sampling strategy.
	SampleConfig *SampleConfig `protobuf:"bytes,3,opt,name=sample_config,json=sampleConfig,proto3" json:"sample_config,omitempty"`
	// CMLE training config. For every active learning labeling iteration, system
	// will train a machine learning model on CMLE. The trained model will be used
	// by data sampling algorithm to select DataItems.
	TrainingConfig *TrainingConfig `protobuf:"bytes,4,opt,name=training_config,json=trainingConfig,proto3" json:"training_config,omitempty"`
	// contains filtered or unexported fields
}

Parameters that configure the active learning pipeline. Active learning will

label the data incrementally by several iterations. For every iteration, it
will select a batch of data based on the sampling strategy.

func (*ActiveLearningConfig) Descriptor deprecated

func (*ActiveLearningConfig) Descriptor() ([]byte, []int)

Deprecated: Use ActiveLearningConfig.ProtoReflect.Descriptor instead.

func (*ActiveLearningConfig) GetHumanLabelingBudget

func (m *ActiveLearningConfig) GetHumanLabelingBudget() isActiveLearningConfig_HumanLabelingBudget

func (*ActiveLearningConfig) GetMaxDataItemCount

func (x *ActiveLearningConfig) GetMaxDataItemCount() int64

func (*ActiveLearningConfig) GetMaxDataItemPercentage

func (x *ActiveLearningConfig) GetMaxDataItemPercentage() int32

func (*ActiveLearningConfig) GetSampleConfig

func (x *ActiveLearningConfig) GetSampleConfig() *SampleConfig

func (*ActiveLearningConfig) GetTrainingConfig

func (x *ActiveLearningConfig) GetTrainingConfig() *TrainingConfig

func (*ActiveLearningConfig) ProtoMessage

func (*ActiveLearningConfig) ProtoMessage()

func (*ActiveLearningConfig) ProtoReflect

func (x *ActiveLearningConfig) ProtoReflect() protoreflect.Message

func (*ActiveLearningConfig) Reset

func (x *ActiveLearningConfig) Reset()

func (*ActiveLearningConfig) String

func (x *ActiveLearningConfig) String() string

type ActiveLearningConfig_MaxDataItemCount

type ActiveLearningConfig_MaxDataItemCount struct {
	// Max number of human labeled DataItems.
	MaxDataItemCount int64 `protobuf:"varint,1,opt,name=max_data_item_count,json=maxDataItemCount,proto3,oneof"`
}

type ActiveLearningConfig_MaxDataItemPercentage

type ActiveLearningConfig_MaxDataItemPercentage struct {
	// Max percent of total DataItems for human labeling.
	MaxDataItemPercentage int32 `protobuf:"varint,2,opt,name=max_data_item_percentage,json=maxDataItemPercentage,proto3,oneof"`
}

type AddContextArtifactsAndExecutionsRequest

type AddContextArtifactsAndExecutionsRequest struct {

	// Required. The resource name of the Context that the Artifacts and
	// Executions belong to. Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
	Context string `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// The resource names of the Artifacts to attribute to the Context.
	//
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
	Artifacts []string `protobuf:"bytes,2,rep,name=artifacts,proto3" json:"artifacts,omitempty"`
	// The resource names of the Executions to associate with the
	// Context.
	//
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
	Executions []string `protobuf:"bytes,3,rep,name=executions,proto3" json:"executions,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions].

func (*AddContextArtifactsAndExecutionsRequest) Descriptor deprecated

func (*AddContextArtifactsAndExecutionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddContextArtifactsAndExecutionsRequest.ProtoReflect.Descriptor instead.

func (*AddContextArtifactsAndExecutionsRequest) GetArtifacts

func (x *AddContextArtifactsAndExecutionsRequest) GetArtifacts() []string

func (*AddContextArtifactsAndExecutionsRequest) GetContext

func (*AddContextArtifactsAndExecutionsRequest) GetExecutions

func (x *AddContextArtifactsAndExecutionsRequest) GetExecutions() []string

func (*AddContextArtifactsAndExecutionsRequest) ProtoMessage

func (*AddContextArtifactsAndExecutionsRequest) ProtoReflect

func (*AddContextArtifactsAndExecutionsRequest) Reset

func (*AddContextArtifactsAndExecutionsRequest) String

type AddContextArtifactsAndExecutionsResponse

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

Response message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions].

func (*AddContextArtifactsAndExecutionsResponse) Descriptor deprecated

func (*AddContextArtifactsAndExecutionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use AddContextArtifactsAndExecutionsResponse.ProtoReflect.Descriptor instead.

func (*AddContextArtifactsAndExecutionsResponse) ProtoMessage

func (*AddContextArtifactsAndExecutionsResponse) ProtoReflect

func (*AddContextArtifactsAndExecutionsResponse) Reset

func (*AddContextArtifactsAndExecutionsResponse) String

type AddContextChildrenRequest

type AddContextChildrenRequest struct {

	// Required. The resource name of the parent Context.
	//
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
	Context string `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// The resource names of the child Contexts.
	ChildContexts []string `protobuf:"bytes,2,rep,name=child_contexts,json=childContexts,proto3" json:"child_contexts,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren].

func (*AddContextChildrenRequest) Descriptor deprecated

func (*AddContextChildrenRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddContextChildrenRequest.ProtoReflect.Descriptor instead.

func (*AddContextChildrenRequest) GetChildContexts

func (x *AddContextChildrenRequest) GetChildContexts() []string

func (*AddContextChildrenRequest) GetContext

func (x *AddContextChildrenRequest) GetContext() string

func (*AddContextChildrenRequest) ProtoMessage

func (*AddContextChildrenRequest) ProtoMessage()

func (*AddContextChildrenRequest) ProtoReflect

func (*AddContextChildrenRequest) Reset

func (x *AddContextChildrenRequest) Reset()

func (*AddContextChildrenRequest) String

func (x *AddContextChildrenRequest) String() string

type AddContextChildrenResponse

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

Response message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren].

func (*AddContextChildrenResponse) Descriptor deprecated

func (*AddContextChildrenResponse) Descriptor() ([]byte, []int)

Deprecated: Use AddContextChildrenResponse.ProtoReflect.Descriptor instead.

func (*AddContextChildrenResponse) ProtoMessage

func (*AddContextChildrenResponse) ProtoMessage()

func (*AddContextChildrenResponse) ProtoReflect

func (*AddContextChildrenResponse) Reset

func (x *AddContextChildrenResponse) Reset()

func (*AddContextChildrenResponse) String

func (x *AddContextChildrenResponse) String() string

type AddExecutionEventsRequest

type AddExecutionEventsRequest struct {

	// Required. The resource name of the Execution that the Events connect
	// Artifacts with.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
	Execution string `protobuf:"bytes,1,opt,name=execution,proto3" json:"execution,omitempty"`
	// The Events to create and add.
	Events []*Event `protobuf:"bytes,2,rep,name=events,proto3" json:"events,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents].

func (*AddExecutionEventsRequest) Descriptor deprecated

func (*AddExecutionEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddExecutionEventsRequest.ProtoReflect.Descriptor instead.

func (*AddExecutionEventsRequest) GetEvents

func (x *AddExecutionEventsRequest) GetEvents() []*Event

func (*AddExecutionEventsRequest) GetExecution

func (x *AddExecutionEventsRequest) GetExecution() string

func (*AddExecutionEventsRequest) ProtoMessage

func (*AddExecutionEventsRequest) ProtoMessage()

func (*AddExecutionEventsRequest) ProtoReflect

func (*AddExecutionEventsRequest) Reset

func (x *AddExecutionEventsRequest) Reset()

func (*AddExecutionEventsRequest) String

func (x *AddExecutionEventsRequest) String() string

type AddExecutionEventsResponse

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

Response message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents].

func (*AddExecutionEventsResponse) Descriptor deprecated

func (*AddExecutionEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use AddExecutionEventsResponse.ProtoReflect.Descriptor instead.

func (*AddExecutionEventsResponse) ProtoMessage

func (*AddExecutionEventsResponse) ProtoMessage()

func (*AddExecutionEventsResponse) ProtoReflect

func (*AddExecutionEventsResponse) Reset

func (x *AddExecutionEventsResponse) Reset()

func (*AddExecutionEventsResponse) String

func (x *AddExecutionEventsResponse) String() string

type AddTrialMeasurementRequest

type AddTrialMeasurementRequest struct {

	// Required. The name of the trial to add measurement.
	// Format:
	// `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
	TrialName string `protobuf:"bytes,1,opt,name=trial_name,json=trialName,proto3" json:"trial_name,omitempty"`
	// Required. The measurement to be added to a Trial.
	Measurement *Measurement `protobuf:"bytes,3,opt,name=measurement,proto3" json:"measurement,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.AddTrialMeasurement][google.cloud.aiplatform.v1.VizierService.AddTrialMeasurement].

func (*AddTrialMeasurementRequest) Descriptor deprecated

func (*AddTrialMeasurementRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddTrialMeasurementRequest.ProtoReflect.Descriptor instead.

func (*AddTrialMeasurementRequest) GetMeasurement

func (x *AddTrialMeasurementRequest) GetMeasurement() *Measurement

func (*AddTrialMeasurementRequest) GetTrialName

func (x *AddTrialMeasurementRequest) GetTrialName() string

func (*AddTrialMeasurementRequest) ProtoMessage

func (*AddTrialMeasurementRequest) ProtoMessage()

func (*AddTrialMeasurementRequest) ProtoReflect

func (*AddTrialMeasurementRequest) Reset

func (x *AddTrialMeasurementRequest) Reset()

func (*AddTrialMeasurementRequest) String

func (x *AddTrialMeasurementRequest) String() string

type Annotation

type Annotation struct {

	// Output only. Resource name of the Annotation.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Google Cloud Storage URI points to a YAML file describing
	// [payload][google.cloud.aiplatform.v1.Annotation.payload]. The schema is
	// defined as an [OpenAPI 3.0.2 Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	// The schema files that can be used here are found in
	// gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the
	// chosen schema must be consistent with the parent Dataset's
	// [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri].
	PayloadSchemaUri string `protobuf:"bytes,2,opt,name=payload_schema_uri,json=payloadSchemaUri,proto3" json:"payload_schema_uri,omitempty"`
	// Required. The schema of the payload can be found in
	// [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
	Payload *structpb.Value `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`
	// Output only. Timestamp when this Annotation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Annotation was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. Used to perform consistent read-modify-write updates. If not set,
	// a blind "overwrite" update happens.
	Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
	// Output only. The source of the Annotation.
	AnnotationSource *UserActionReference `protobuf:"bytes,5,opt,name=annotation_source,json=annotationSource,proto3" json:"annotation_source,omitempty"`
	// Optional. The labels with user-defined metadata to organize your
	// Annotations.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one Annotation(System
	// labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable. Following system labels exist for each Annotation:
	//
	//   - "aiplatform.googleapis.com/annotation_set_name":
	//     optional, name of the UI's annotation set this Annotation belongs to.
	//     If not set, the Annotation is not visible in the UI.
	//
	//   - "aiplatform.googleapis.com/payload_schema":
	//     output only, its value is the
	//     [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
	//     title.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.

func (*Annotation) Descriptor deprecated

func (*Annotation) Descriptor() ([]byte, []int)

Deprecated: Use Annotation.ProtoReflect.Descriptor instead.

func (*Annotation) GetAnnotationSource

func (x *Annotation) GetAnnotationSource() *UserActionReference

func (*Annotation) GetCreateTime

func (x *Annotation) GetCreateTime() *timestamppb.Timestamp

func (*Annotation) GetEtag

func (x *Annotation) GetEtag() string

func (*Annotation) GetLabels

func (x *Annotation) GetLabels() map[string]string

func (*Annotation) GetName

func (x *Annotation) GetName() string

func (*Annotation) GetPayload

func (x *Annotation) GetPayload() *structpb.Value

func (*Annotation) GetPayloadSchemaUri

func (x *Annotation) GetPayloadSchemaUri() string

func (*Annotation) GetUpdateTime

func (x *Annotation) GetUpdateTime() *timestamppb.Timestamp

func (*Annotation) ProtoMessage

func (*Annotation) ProtoMessage()

func (*Annotation) ProtoReflect

func (x *Annotation) ProtoReflect() protoreflect.Message

func (*Annotation) Reset

func (x *Annotation) Reset()

func (*Annotation) String

func (x *Annotation) String() string

type AnnotationSpec

type AnnotationSpec struct {

	// Output only. Resource name of the AnnotationSpec.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The user-defined name of the AnnotationSpec.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. Timestamp when this AnnotationSpec was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when AnnotationSpec was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. Used to perform consistent read-modify-write updates. If not set,
	// a blind "overwrite" update happens.
	Etag string `protobuf:"bytes,5,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

Identifies a concept with which DataItems may be annotated with.

func (*AnnotationSpec) Descriptor deprecated

func (*AnnotationSpec) Descriptor() ([]byte, []int)

Deprecated: Use AnnotationSpec.ProtoReflect.Descriptor instead.

func (*AnnotationSpec) GetCreateTime

func (x *AnnotationSpec) GetCreateTime() *timestamppb.Timestamp

func (*AnnotationSpec) GetDisplayName

func (x *AnnotationSpec) GetDisplayName() string

func (*AnnotationSpec) GetEtag

func (x *AnnotationSpec) GetEtag() string

func (*AnnotationSpec) GetName

func (x *AnnotationSpec) GetName() string

func (*AnnotationSpec) GetUpdateTime

func (x *AnnotationSpec) GetUpdateTime() *timestamppb.Timestamp

func (*AnnotationSpec) ProtoMessage

func (*AnnotationSpec) ProtoMessage()

func (*AnnotationSpec) ProtoReflect

func (x *AnnotationSpec) ProtoReflect() protoreflect.Message

func (*AnnotationSpec) Reset

func (x *AnnotationSpec) Reset()

func (*AnnotationSpec) String

func (x *AnnotationSpec) String() string

type Artifact

type Artifact struct {

	// Output only. The resource name of the Artifact.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// User provided display name of the Artifact.
	// May be up to 128 Unicode characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The uniform resource identifier of the artifact file.
	// May be empty if there is no actual artifact file.
	Uri string `protobuf:"bytes,6,opt,name=uri,proto3" json:"uri,omitempty"`
	// An eTag used to perform consistent read-modify-write updates. If not set, a
	// blind "overwrite" update happens.
	Etag string `protobuf:"bytes,9,opt,name=etag,proto3" json:"etag,omitempty"`
	// The labels with user-defined metadata to organize your Artifacts.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one Artifact (System
	// labels are excluded).
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Output only. Timestamp when this Artifact was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Artifact was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The state of this Artifact. This is a property of the Artifact, and does
	// not imply or capture any ongoing process. This property is managed by
	// clients (such as Vertex AI Pipelines), and the system does not prescribe
	// or check the validity of state transitions.
	State Artifact_State `protobuf:"varint,13,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.Artifact_State" json:"state,omitempty"`
	// The title of the schema describing the metadata.
	//
	// Schema title and version is expected to be registered in earlier Create
	// Schema calls. And both are used together as unique identifiers to identify
	// schemas within the local metadata store.
	SchemaTitle string `protobuf:"bytes,14,opt,name=schema_title,json=schemaTitle,proto3" json:"schema_title,omitempty"`
	// The version of the schema in schema_name to use.
	//
	// Schema title and version is expected to be registered in earlier Create
	// Schema calls. And both are used together as unique identifiers to identify
	// schemas within the local metadata store.
	SchemaVersion string `protobuf:"bytes,15,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`
	// Properties of the Artifact.
	// Top level metadata keys' heading and trailing spaces will be trimmed.
	// The size of this field should not exceed 200KB.
	Metadata *structpb.Struct `protobuf:"bytes,16,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Description of the Artifact
	Description string `protobuf:"bytes,17,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Instance of a general artifact.

func (*Artifact) Descriptor deprecated

func (*Artifact) Descriptor() ([]byte, []int)

Deprecated: Use Artifact.ProtoReflect.Descriptor instead.

func (*Artifact) GetCreateTime

func (x *Artifact) GetCreateTime() *timestamppb.Timestamp

func (*Artifact) GetDescription

func (x *Artifact) GetDescription() string

func (*Artifact) GetDisplayName

func (x *Artifact) GetDisplayName() string

func (*Artifact) GetEtag

func (x *Artifact) GetEtag() string

func (*Artifact) GetLabels

func (x *Artifact) GetLabels() map[string]string

func (*Artifact) GetMetadata

func (x *Artifact) GetMetadata() *structpb.Struct

func (*Artifact) GetName

func (x *Artifact) GetName() string

func (*Artifact) GetSchemaTitle

func (x *Artifact) GetSchemaTitle() string

func (*Artifact) GetSchemaVersion

func (x *Artifact) GetSchemaVersion() string

func (*Artifact) GetState

func (x *Artifact) GetState() Artifact_State

func (*Artifact) GetUpdateTime

func (x *Artifact) GetUpdateTime() *timestamppb.Timestamp

func (*Artifact) GetUri

func (x *Artifact) GetUri() string

func (*Artifact) ProtoMessage

func (*Artifact) ProtoMessage()

func (*Artifact) ProtoReflect

func (x *Artifact) ProtoReflect() protoreflect.Message

func (*Artifact) Reset

func (x *Artifact) Reset()

func (*Artifact) String

func (x *Artifact) String() string

type Artifact_State

type Artifact_State int32

Describes the state of the Artifact.

const (
	// Unspecified state for the Artifact.
	Artifact_STATE_UNSPECIFIED Artifact_State = 0
	// A state used by systems like Vertex AI Pipelines to indicate that the
	// underlying data item represented by this Artifact is being created.
	Artifact_PENDING Artifact_State = 1
	// A state indicating that the Artifact should exist, unless something
	// external to the system deletes it.
	Artifact_LIVE Artifact_State = 2
)

func (Artifact_State) Descriptor

func (Artifact_State) Enum

func (x Artifact_State) Enum() *Artifact_State

func (Artifact_State) EnumDescriptor deprecated

func (Artifact_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Artifact_State.Descriptor instead.

func (Artifact_State) Number

func (Artifact_State) String

func (x Artifact_State) String() string

func (Artifact_State) Type

type AssignNotebookRuntimeOperationMetadata added in v1.67.0

type AssignNotebookRuntimeOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// A human-readable message that shows the intermediate progress details of
	// NotebookRuntime.
	ProgressMessage string `protobuf:"bytes,2,opt,name=progress_message,json=progressMessage,proto3" json:"progress_message,omitempty"`
	// contains filtered or unexported fields
}

Metadata information for [NotebookService.AssignNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.AssignNotebookRuntime].

func (*AssignNotebookRuntimeOperationMetadata) Descriptor deprecated added in v1.67.0

func (*AssignNotebookRuntimeOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use AssignNotebookRuntimeOperationMetadata.ProtoReflect.Descriptor instead.

func (*AssignNotebookRuntimeOperationMetadata) GetGenericMetadata added in v1.67.0

func (*AssignNotebookRuntimeOperationMetadata) GetProgressMessage added in v1.67.0

func (x *AssignNotebookRuntimeOperationMetadata) GetProgressMessage() string

func (*AssignNotebookRuntimeOperationMetadata) ProtoMessage added in v1.67.0

func (*AssignNotebookRuntimeOperationMetadata) ProtoReflect added in v1.67.0

func (*AssignNotebookRuntimeOperationMetadata) Reset added in v1.67.0

func (*AssignNotebookRuntimeOperationMetadata) String added in v1.67.0

type AssignNotebookRuntimeRequest added in v1.67.0

type AssignNotebookRuntimeRequest struct {

	// Required. The resource name of the Location to get the NotebookRuntime
	// assignment. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The resource name of the NotebookRuntimeTemplate based on which a
	// NotebookRuntime will be assigned (reuse or create a new one).
	NotebookRuntimeTemplate string `` /* 132-byte string literal not displayed */
	// Required. Provide runtime specific information (e.g. runtime owner,
	// notebook id) used for NotebookRuntime assignment.
	NotebookRuntime *NotebookRuntime `protobuf:"bytes,3,opt,name=notebook_runtime,json=notebookRuntime,proto3" json:"notebook_runtime,omitempty"`
	// Optional. User specified ID for the notebook runtime.
	NotebookRuntimeId string `protobuf:"bytes,4,opt,name=notebook_runtime_id,json=notebookRuntimeId,proto3" json:"notebook_runtime_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [NotebookService.AssignNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.AssignNotebookRuntime].

func (*AssignNotebookRuntimeRequest) Descriptor deprecated added in v1.67.0

func (*AssignNotebookRuntimeRequest) Descriptor() ([]byte, []int)

Deprecated: Use AssignNotebookRuntimeRequest.ProtoReflect.Descriptor instead.

func (*AssignNotebookRuntimeRequest) GetNotebookRuntime added in v1.67.0

func (x *AssignNotebookRuntimeRequest) GetNotebookRuntime() *NotebookRuntime

func (*AssignNotebookRuntimeRequest) GetNotebookRuntimeId added in v1.67.0

func (x *AssignNotebookRuntimeRequest) GetNotebookRuntimeId() string

func (*AssignNotebookRuntimeRequest) GetNotebookRuntimeTemplate added in v1.67.0

func (x *AssignNotebookRuntimeRequest) GetNotebookRuntimeTemplate() string

func (*AssignNotebookRuntimeRequest) GetParent added in v1.67.0

func (x *AssignNotebookRuntimeRequest) GetParent() string

func (*AssignNotebookRuntimeRequest) ProtoMessage added in v1.67.0

func (*AssignNotebookRuntimeRequest) ProtoMessage()

func (*AssignNotebookRuntimeRequest) ProtoReflect added in v1.67.0

func (*AssignNotebookRuntimeRequest) Reset added in v1.67.0

func (x *AssignNotebookRuntimeRequest) Reset()

func (*AssignNotebookRuntimeRequest) String added in v1.67.0

type Attribution

type Attribution struct {

	// Output only. Model predicted output if the input instance is constructed
	// from the baselines of all the features defined in
	// [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
	// The field name of the output is determined by the key in
	// [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
	//
	// If the Model's predicted output has multiple dimensions (rank > 1), this is
	// the value in the output located by
	// [output_index][google.cloud.aiplatform.v1.Attribution.output_index].
	//
	// If there are multiple baselines, their output values are averaged.
	BaselineOutputValue float64 `protobuf:"fixed64,1,opt,name=baseline_output_value,json=baselineOutputValue,proto3" json:"baseline_output_value,omitempty"`
	// Output only. Model predicted output on the corresponding [explanation
	// instance][ExplainRequest.instances]. The field name of the output is
	// determined by the key in
	// [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
	//
	// If the Model predicted output has multiple dimensions, this is the value in
	// the output located by
	// [output_index][google.cloud.aiplatform.v1.Attribution.output_index].
	InstanceOutputValue float64 `protobuf:"fixed64,2,opt,name=instance_output_value,json=instanceOutputValue,proto3" json:"instance_output_value,omitempty"`
	// Output only. Attributions of each explained feature. Features are extracted
	// from the [prediction
	// instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
	// to [explanation metadata for
	// inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
	//
	// The value is a struct, whose keys are the name of the feature. The values
	// are how much the feature in the
	// [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed
	// to the predicted result.
	//
	// The format of the value is determined by the feature's input format:
	//
	//   - If the feature is a scalar value, the attribution value is a
	//     [floating number][google.protobuf.Value.number_value].
	//
	//   - If the feature is an array of scalar values, the attribution value is
	//     an [array][google.protobuf.Value.list_value].
	//
	//   - If the feature is a struct, the attribution value is a
	//     [struct][google.protobuf.Value.struct_value]. The keys in the
	//     attribution value struct are the same as the keys in the feature
	//     struct. The formats of the values in the attribution struct are
	//     determined by the formats of the values in the feature struct.
	//
	// The
	// [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri]
	// field, pointed to by the
	// [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the
	// [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
	// object, points to the schema file that describes the features and their
	// attribution values (if it is populated).
	FeatureAttributions *structpb.Value `protobuf:"bytes,3,opt,name=feature_attributions,json=featureAttributions,proto3" json:"feature_attributions,omitempty"`
	// Output only. The index that locates the explained prediction output.
	//
	// If the prediction output is a scalar value, output_index is not populated.
	// If the prediction output has multiple dimensions, the length of the
	// output_index list is the same as the number of dimensions of the output.
	// The i-th element in output_index is the element index of the i-th dimension
	// of the output vector. Indices start from 0.
	OutputIndex []int32 `protobuf:"varint,4,rep,packed,name=output_index,json=outputIndex,proto3" json:"output_index,omitempty"`
	// Output only. The display name of the output identified by
	// [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For
	// example, the predicted class name by a multi-classification Model.
	//
	// This field is only populated iff the Model predicts display names as a
	// separate field along with the explained output. The predicted display name
	// must has the same shape of the explained output, and can be located using
	// output_index.
	OutputDisplayName string `protobuf:"bytes,5,opt,name=output_display_name,json=outputDisplayName,proto3" json:"output_display_name,omitempty"`
	// Output only. Error of
	// [feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
	// caused by approximation used in the explanation method. Lower value means
	// more precise attributions.
	//
	// * For Sampled Shapley
	// [attribution][google.cloud.aiplatform.v1.ExplanationParameters.sampled_shapley_attribution],
	// increasing
	// [path_count][google.cloud.aiplatform.v1.SampledShapleyAttribution.path_count]
	// might reduce the error.
	// * For Integrated Gradients
	// [attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution],
	// increasing
	// [step_count][google.cloud.aiplatform.v1.IntegratedGradientsAttribution.step_count]
	// might reduce the error.
	// * For [XRAI
	// attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
	// increasing
	// [step_count][google.cloud.aiplatform.v1.XraiAttribution.step_count] might
	// reduce the error.
	//
	// See [this introduction](/vertex-ai/docs/explainable-ai/overview)
	// for more information.
	ApproximationError float64 `protobuf:"fixed64,6,opt,name=approximation_error,json=approximationError,proto3" json:"approximation_error,omitempty"`
	// Output only. Name of the explain output. Specified as the key in
	// [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
	OutputName string `protobuf:"bytes,7,opt,name=output_name,json=outputName,proto3" json:"output_name,omitempty"`
	// contains filtered or unexported fields
}

Attribution that explains a particular prediction output.

func (*Attribution) Descriptor deprecated

func (*Attribution) Descriptor() ([]byte, []int)

Deprecated: Use Attribution.ProtoReflect.Descriptor instead.

func (*Attribution) GetApproximationError

func (x *Attribution) GetApproximationError() float64

func (*Attribution) GetBaselineOutputValue

func (x *Attribution) GetBaselineOutputValue() float64

func (*Attribution) GetFeatureAttributions

func (x *Attribution) GetFeatureAttributions() *structpb.Value

func (*Attribution) GetInstanceOutputValue

func (x *Attribution) GetInstanceOutputValue() float64

func (*Attribution) GetOutputDisplayName

func (x *Attribution) GetOutputDisplayName() string

func (*Attribution) GetOutputIndex

func (x *Attribution) GetOutputIndex() []int32

func (*Attribution) GetOutputName

func (x *Attribution) GetOutputName() string

func (*Attribution) ProtoMessage

func (*Attribution) ProtoMessage()

func (*Attribution) ProtoReflect

func (x *Attribution) ProtoReflect() protoreflect.Message

func (*Attribution) Reset

func (x *Attribution) Reset()

func (*Attribution) String

func (x *Attribution) String() string

type AutomaticResources

type AutomaticResources struct {

	// Immutable. The minimum number of replicas this DeployedModel will be always
	// deployed on. If traffic against it increases, it may dynamically be
	// deployed onto more replicas up to
	// [max_replica_count][google.cloud.aiplatform.v1.AutomaticResources.max_replica_count],
	// and as traffic decreases, some of these extra replicas may be freed. If the
	// requested value is too large, the deployment will error.
	MinReplicaCount int32 `protobuf:"varint,1,opt,name=min_replica_count,json=minReplicaCount,proto3" json:"min_replica_count,omitempty"`
	// Immutable. The maximum number of replicas this DeployedModel may be
	// deployed on when the traffic against it increases. If the requested value
	// is too large, the deployment will error, but if deployment succeeds then
	// the ability to scale the model to that many replicas is guaranteed (barring
	// service outages). If traffic against the DeployedModel increases beyond
	// what its replicas at maximum may handle, a portion of the traffic will be
	// dropped. If this value is not provided, a no upper bound for scaling under
	// heavy traffic will be assume, though Vertex AI may be unable to scale
	// beyond certain replica number.
	MaxReplicaCount int32 `protobuf:"varint,2,opt,name=max_replica_count,json=maxReplicaCount,proto3" json:"max_replica_count,omitempty"`
	// contains filtered or unexported fields
}

A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines.

func (*AutomaticResources) Descriptor deprecated

func (*AutomaticResources) Descriptor() ([]byte, []int)

Deprecated: Use AutomaticResources.ProtoReflect.Descriptor instead.

func (*AutomaticResources) GetMaxReplicaCount

func (x *AutomaticResources) GetMaxReplicaCount() int32

func (*AutomaticResources) GetMinReplicaCount

func (x *AutomaticResources) GetMinReplicaCount() int32

func (*AutomaticResources) ProtoMessage

func (*AutomaticResources) ProtoMessage()

func (*AutomaticResources) ProtoReflect

func (x *AutomaticResources) ProtoReflect() protoreflect.Message

func (*AutomaticResources) Reset

func (x *AutomaticResources) Reset()

func (*AutomaticResources) String

func (x *AutomaticResources) String() string

type AutoscalingMetricSpec

type AutoscalingMetricSpec struct {

	// Required. The resource metric name.
	// Supported metrics:
	//
	// * For Online Prediction:
	// * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle`
	// * `aiplatform.googleapis.com/prediction/online/cpu/utilization`
	MetricName string `protobuf:"bytes,1,opt,name=metric_name,json=metricName,proto3" json:"metric_name,omitempty"`
	// The target resource utilization in percentage (1% - 100%) for the given
	// metric; once the real usage deviates from the target by a certain
	// percentage, the machine replicas change. The default value is 60
	// (representing 60%) if not provided.
	Target int32 `protobuf:"varint,2,opt,name=target,proto3" json:"target,omitempty"`
	// contains filtered or unexported fields
}

The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.

func (*AutoscalingMetricSpec) Descriptor deprecated

func (*AutoscalingMetricSpec) Descriptor() ([]byte, []int)

Deprecated: Use AutoscalingMetricSpec.ProtoReflect.Descriptor instead.

func (*AutoscalingMetricSpec) GetMetricName

func (x *AutoscalingMetricSpec) GetMetricName() string

func (*AutoscalingMetricSpec) GetTarget

func (x *AutoscalingMetricSpec) GetTarget() int32

func (*AutoscalingMetricSpec) ProtoMessage

func (*AutoscalingMetricSpec) ProtoMessage()

func (*AutoscalingMetricSpec) ProtoReflect

func (x *AutoscalingMetricSpec) ProtoReflect() protoreflect.Message

func (*AutoscalingMetricSpec) Reset

func (x *AutoscalingMetricSpec) Reset()

func (*AutoscalingMetricSpec) String

func (x *AutoscalingMetricSpec) String() string

type AvroSource

type AvroSource struct {

	// Required. Google Cloud Storage location.
	GcsSource *GcsSource `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3" json:"gcs_source,omitempty"`
	// contains filtered or unexported fields
}

The storage details for Avro input content.

func (*AvroSource) Descriptor deprecated

func (*AvroSource) Descriptor() ([]byte, []int)

Deprecated: Use AvroSource.ProtoReflect.Descriptor instead.

func (*AvroSource) GetGcsSource

func (x *AvroSource) GetGcsSource() *GcsSource

func (*AvroSource) ProtoMessage

func (*AvroSource) ProtoMessage()

func (*AvroSource) ProtoReflect

func (x *AvroSource) ProtoReflect() protoreflect.Message

func (*AvroSource) Reset

func (x *AvroSource) Reset()

func (*AvroSource) String

func (x *AvroSource) String() string

type BatchCancelPipelineJobsOperationMetadata added in v1.63.0

type BatchCancelPipelineJobsOperationMetadata struct {

	// The common part of the operation metadata.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [PipelineService.BatchCancelPipelineJobs][google.cloud.aiplatform.v1.PipelineService.BatchCancelPipelineJobs].

func (*BatchCancelPipelineJobsOperationMetadata) Descriptor deprecated added in v1.63.0

func (*BatchCancelPipelineJobsOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use BatchCancelPipelineJobsOperationMetadata.ProtoReflect.Descriptor instead.

func (*BatchCancelPipelineJobsOperationMetadata) GetGenericMetadata added in v1.63.0

func (*BatchCancelPipelineJobsOperationMetadata) ProtoMessage added in v1.63.0

func (*BatchCancelPipelineJobsOperationMetadata) ProtoReflect added in v1.63.0

func (*BatchCancelPipelineJobsOperationMetadata) Reset added in v1.63.0

func (*BatchCancelPipelineJobsOperationMetadata) String added in v1.63.0

type BatchCancelPipelineJobsRequest added in v1.63.0

type BatchCancelPipelineJobsRequest struct {

	// Required. The name of the PipelineJobs' parent resource.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The names of the PipelineJobs to cancel.
	// A maximum of 32 PipelineJobs can be cancelled in a batch.
	// Format:
	// `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}`
	Names []string `protobuf:"bytes,2,rep,name=names,proto3" json:"names,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PipelineService.BatchCancelPipelineJobs][google.cloud.aiplatform.v1.PipelineService.BatchCancelPipelineJobs].

func (*BatchCancelPipelineJobsRequest) Descriptor deprecated added in v1.63.0

func (*BatchCancelPipelineJobsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchCancelPipelineJobsRequest.ProtoReflect.Descriptor instead.

func (*BatchCancelPipelineJobsRequest) GetNames added in v1.63.0

func (x *BatchCancelPipelineJobsRequest) GetNames() []string

func (*BatchCancelPipelineJobsRequest) GetParent added in v1.63.0

func (x *BatchCancelPipelineJobsRequest) GetParent() string

func (*BatchCancelPipelineJobsRequest) ProtoMessage added in v1.63.0

func (*BatchCancelPipelineJobsRequest) ProtoMessage()

func (*BatchCancelPipelineJobsRequest) ProtoReflect added in v1.63.0

func (*BatchCancelPipelineJobsRequest) Reset added in v1.63.0

func (x *BatchCancelPipelineJobsRequest) Reset()

func (*BatchCancelPipelineJobsRequest) String added in v1.63.0

type BatchCancelPipelineJobsResponse added in v1.63.0

type BatchCancelPipelineJobsResponse struct {

	// PipelineJobs cancelled.
	PipelineJobs []*PipelineJob `protobuf:"bytes,1,rep,name=pipeline_jobs,json=pipelineJobs,proto3" json:"pipeline_jobs,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PipelineService.BatchCancelPipelineJobs][google.cloud.aiplatform.v1.PipelineService.BatchCancelPipelineJobs].

func (*BatchCancelPipelineJobsResponse) Descriptor deprecated added in v1.63.0

func (*BatchCancelPipelineJobsResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchCancelPipelineJobsResponse.ProtoReflect.Descriptor instead.

func (*BatchCancelPipelineJobsResponse) GetPipelineJobs added in v1.63.0

func (x *BatchCancelPipelineJobsResponse) GetPipelineJobs() []*PipelineJob

func (*BatchCancelPipelineJobsResponse) ProtoMessage added in v1.63.0

func (*BatchCancelPipelineJobsResponse) ProtoMessage()

func (*BatchCancelPipelineJobsResponse) ProtoReflect added in v1.63.0

func (*BatchCancelPipelineJobsResponse) Reset added in v1.63.0

func (*BatchCancelPipelineJobsResponse) String added in v1.63.0

type BatchCreateFeaturesOperationMetadata

type BatchCreateFeaturesOperationMetadata struct {

	// Operation metadata for Feature.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform batch create Features.

func (*BatchCreateFeaturesOperationMetadata) Descriptor deprecated

func (*BatchCreateFeaturesOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateFeaturesOperationMetadata.ProtoReflect.Descriptor instead.

func (*BatchCreateFeaturesOperationMetadata) GetGenericMetadata

func (*BatchCreateFeaturesOperationMetadata) ProtoMessage

func (*BatchCreateFeaturesOperationMetadata) ProtoMessage()

func (*BatchCreateFeaturesOperationMetadata) ProtoReflect

func (*BatchCreateFeaturesOperationMetadata) Reset

func (*BatchCreateFeaturesOperationMetadata) String

type BatchCreateFeaturesRequest

type BatchCreateFeaturesRequest struct {

	// Required. The resource name of the EntityType to create the batch of
	// Features under. Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The request message specifying the Features to create. All
	// Features must be created under the same parent EntityType. The `parent`
	// field in each child request message can be omitted. If `parent` is set in a
	// child request, then the value must match the `parent` value in this request
	// message.
	Requests []*CreateFeatureRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures].

func (*BatchCreateFeaturesRequest) Descriptor deprecated

func (*BatchCreateFeaturesRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateFeaturesRequest.ProtoReflect.Descriptor instead.

func (*BatchCreateFeaturesRequest) GetParent

func (x *BatchCreateFeaturesRequest) GetParent() string

func (*BatchCreateFeaturesRequest) GetRequests

func (*BatchCreateFeaturesRequest) ProtoMessage

func (*BatchCreateFeaturesRequest) ProtoMessage()

func (*BatchCreateFeaturesRequest) ProtoReflect

func (*BatchCreateFeaturesRequest) Reset

func (x *BatchCreateFeaturesRequest) Reset()

func (*BatchCreateFeaturesRequest) String

func (x *BatchCreateFeaturesRequest) String() string

type BatchCreateFeaturesResponse

type BatchCreateFeaturesResponse struct {

	// The Features created.
	Features []*Feature `protobuf:"bytes,1,rep,name=features,proto3" json:"features,omitempty"`
	// contains filtered or unexported fields
}

Response message for [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures].

func (*BatchCreateFeaturesResponse) Descriptor deprecated

func (*BatchCreateFeaturesResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateFeaturesResponse.ProtoReflect.Descriptor instead.

func (*BatchCreateFeaturesResponse) GetFeatures

func (x *BatchCreateFeaturesResponse) GetFeatures() []*Feature

func (*BatchCreateFeaturesResponse) ProtoMessage

func (*BatchCreateFeaturesResponse) ProtoMessage()

func (*BatchCreateFeaturesResponse) ProtoReflect

func (*BatchCreateFeaturesResponse) Reset

func (x *BatchCreateFeaturesResponse) Reset()

func (*BatchCreateFeaturesResponse) String

func (x *BatchCreateFeaturesResponse) String() string

type BatchCreateTensorboardRunsRequest

type BatchCreateTensorboardRunsRequest struct {

	// Required. The resource name of the TensorboardExperiment to create the
	// TensorboardRuns in. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
	// The parent field in the CreateTensorboardRunRequest messages must match
	// this field.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The request message specifying the TensorboardRuns to create.
	// A maximum of 1000 TensorboardRuns can be created in a batch.
	Requests []*CreateTensorboardRunRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns].

func (*BatchCreateTensorboardRunsRequest) Descriptor deprecated

func (*BatchCreateTensorboardRunsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateTensorboardRunsRequest.ProtoReflect.Descriptor instead.

func (*BatchCreateTensorboardRunsRequest) GetParent

func (*BatchCreateTensorboardRunsRequest) GetRequests

func (*BatchCreateTensorboardRunsRequest) ProtoMessage

func (*BatchCreateTensorboardRunsRequest) ProtoMessage()

func (*BatchCreateTensorboardRunsRequest) ProtoReflect

func (*BatchCreateTensorboardRunsRequest) Reset

func (*BatchCreateTensorboardRunsRequest) String

type BatchCreateTensorboardRunsResponse

type BatchCreateTensorboardRunsResponse struct {

	// The created TensorboardRuns.
	TensorboardRuns []*TensorboardRun `protobuf:"bytes,1,rep,name=tensorboard_runs,json=tensorboardRuns,proto3" json:"tensorboard_runs,omitempty"`
	// contains filtered or unexported fields
}

Response message for [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns].

func (*BatchCreateTensorboardRunsResponse) Descriptor deprecated

func (*BatchCreateTensorboardRunsResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateTensorboardRunsResponse.ProtoReflect.Descriptor instead.

func (*BatchCreateTensorboardRunsResponse) GetTensorboardRuns

func (x *BatchCreateTensorboardRunsResponse) GetTensorboardRuns() []*TensorboardRun

func (*BatchCreateTensorboardRunsResponse) ProtoMessage

func (*BatchCreateTensorboardRunsResponse) ProtoMessage()

func (*BatchCreateTensorboardRunsResponse) ProtoReflect

func (*BatchCreateTensorboardRunsResponse) Reset

func (*BatchCreateTensorboardRunsResponse) String

type BatchCreateTensorboardTimeSeriesRequest

type BatchCreateTensorboardTimeSeriesRequest struct {

	// Required. The resource name of the TensorboardExperiment to create the
	// TensorboardTimeSeries in.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
	// The TensorboardRuns referenced by the parent fields in the
	// CreateTensorboardTimeSeriesRequest messages must be sub resources of this
	// TensorboardExperiment.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The request message specifying the TensorboardTimeSeries to
	// create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.
	Requests []*CreateTensorboardTimeSeriesRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries].

func (*BatchCreateTensorboardTimeSeriesRequest) Descriptor deprecated

func (*BatchCreateTensorboardTimeSeriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateTensorboardTimeSeriesRequest.ProtoReflect.Descriptor instead.

func (*BatchCreateTensorboardTimeSeriesRequest) GetParent

func (*BatchCreateTensorboardTimeSeriesRequest) GetRequests

func (*BatchCreateTensorboardTimeSeriesRequest) ProtoMessage

func (*BatchCreateTensorboardTimeSeriesRequest) ProtoReflect

func (*BatchCreateTensorboardTimeSeriesRequest) Reset

func (*BatchCreateTensorboardTimeSeriesRequest) String

type BatchCreateTensorboardTimeSeriesResponse

type BatchCreateTensorboardTimeSeriesResponse struct {

	// The created TensorboardTimeSeries.
	TensorboardTimeSeries []*TensorboardTimeSeries `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message for [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries].

func (*BatchCreateTensorboardTimeSeriesResponse) Descriptor deprecated

func (*BatchCreateTensorboardTimeSeriesResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateTensorboardTimeSeriesResponse.ProtoReflect.Descriptor instead.

func (*BatchCreateTensorboardTimeSeriesResponse) GetTensorboardTimeSeries

func (x *BatchCreateTensorboardTimeSeriesResponse) GetTensorboardTimeSeries() []*TensorboardTimeSeries

func (*BatchCreateTensorboardTimeSeriesResponse) ProtoMessage

func (*BatchCreateTensorboardTimeSeriesResponse) ProtoReflect

func (*BatchCreateTensorboardTimeSeriesResponse) Reset

func (*BatchCreateTensorboardTimeSeriesResponse) String

type BatchDedicatedResources

type BatchDedicatedResources struct {

	// Required. Immutable. The specification of a single machine.
	MachineSpec *MachineSpec `protobuf:"bytes,1,opt,name=machine_spec,json=machineSpec,proto3" json:"machine_spec,omitempty"`
	// Immutable. The number of machine replicas used at the start of the batch
	// operation. If not set, Vertex AI decides starting number, not greater than
	// [max_replica_count][google.cloud.aiplatform.v1.BatchDedicatedResources.max_replica_count]
	StartingReplicaCount int32 `protobuf:"varint,2,opt,name=starting_replica_count,json=startingReplicaCount,proto3" json:"starting_replica_count,omitempty"`
	// Immutable. The maximum number of machine replicas the batch operation may
	// be scaled to. The default value is 10.
	MaxReplicaCount int32 `protobuf:"varint,3,opt,name=max_replica_count,json=maxReplicaCount,proto3" json:"max_replica_count,omitempty"`
	// contains filtered or unexported fields
}

A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration.

func (*BatchDedicatedResources) Descriptor deprecated

func (*BatchDedicatedResources) Descriptor() ([]byte, []int)

Deprecated: Use BatchDedicatedResources.ProtoReflect.Descriptor instead.

func (*BatchDedicatedResources) GetMachineSpec

func (x *BatchDedicatedResources) GetMachineSpec() *MachineSpec

func (*BatchDedicatedResources) GetMaxReplicaCount

func (x *BatchDedicatedResources) GetMaxReplicaCount() int32

func (*BatchDedicatedResources) GetStartingReplicaCount

func (x *BatchDedicatedResources) GetStartingReplicaCount() int32

func (*BatchDedicatedResources) ProtoMessage

func (*BatchDedicatedResources) ProtoMessage()

func (*BatchDedicatedResources) ProtoReflect

func (x *BatchDedicatedResources) ProtoReflect() protoreflect.Message

func (*BatchDedicatedResources) Reset

func (x *BatchDedicatedResources) Reset()

func (*BatchDedicatedResources) String

func (x *BatchDedicatedResources) String() string

type BatchDeletePipelineJobsRequest added in v1.63.0

type BatchDeletePipelineJobsRequest struct {

	// Required. The name of the PipelineJobs' parent resource.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The names of the PipelineJobs to delete.
	// A maximum of 32 PipelineJobs can be deleted in a batch.
	// Format:
	// `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}`
	Names []string `protobuf:"bytes,2,rep,name=names,proto3" json:"names,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PipelineService.BatchDeletePipelineJobs][google.cloud.aiplatform.v1.PipelineService.BatchDeletePipelineJobs].

func (*BatchDeletePipelineJobsRequest) Descriptor deprecated added in v1.63.0

func (*BatchDeletePipelineJobsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchDeletePipelineJobsRequest.ProtoReflect.Descriptor instead.

func (*BatchDeletePipelineJobsRequest) GetNames added in v1.63.0

func (x *BatchDeletePipelineJobsRequest) GetNames() []string

func (*BatchDeletePipelineJobsRequest) GetParent added in v1.63.0

func (x *BatchDeletePipelineJobsRequest) GetParent() string

func (*BatchDeletePipelineJobsRequest) ProtoMessage added in v1.63.0

func (*BatchDeletePipelineJobsRequest) ProtoMessage()

func (*BatchDeletePipelineJobsRequest) ProtoReflect added in v1.63.0

func (*BatchDeletePipelineJobsRequest) Reset added in v1.63.0

func (x *BatchDeletePipelineJobsRequest) Reset()

func (*BatchDeletePipelineJobsRequest) String added in v1.63.0

type BatchDeletePipelineJobsResponse added in v1.63.0

type BatchDeletePipelineJobsResponse struct {

	// PipelineJobs deleted.
	PipelineJobs []*PipelineJob `protobuf:"bytes,1,rep,name=pipeline_jobs,json=pipelineJobs,proto3" json:"pipeline_jobs,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PipelineService.BatchDeletePipelineJobs][google.cloud.aiplatform.v1.PipelineService.BatchDeletePipelineJobs].

func (*BatchDeletePipelineJobsResponse) Descriptor deprecated added in v1.63.0

func (*BatchDeletePipelineJobsResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchDeletePipelineJobsResponse.ProtoReflect.Descriptor instead.

func (*BatchDeletePipelineJobsResponse) GetPipelineJobs added in v1.63.0

func (x *BatchDeletePipelineJobsResponse) GetPipelineJobs() []*PipelineJob

func (*BatchDeletePipelineJobsResponse) ProtoMessage added in v1.63.0

func (*BatchDeletePipelineJobsResponse) ProtoMessage()

func (*BatchDeletePipelineJobsResponse) ProtoReflect added in v1.63.0

func (*BatchDeletePipelineJobsResponse) Reset added in v1.63.0

func (*BatchDeletePipelineJobsResponse) String added in v1.63.0

type BatchImportEvaluatedAnnotationsRequest added in v1.36.0

type BatchImportEvaluatedAnnotationsRequest struct {

	// Required. The name of the parent ModelEvaluationSlice resource.
	// Format:
	// `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Evaluated annotations resource to be imported.
	EvaluatedAnnotations []*EvaluatedAnnotation `protobuf:"bytes,2,rep,name=evaluated_annotations,json=evaluatedAnnotations,proto3" json:"evaluated_annotations,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.BatchImportEvaluatedAnnotations][google.cloud.aiplatform.v1.ModelService.BatchImportEvaluatedAnnotations]

func (*BatchImportEvaluatedAnnotationsRequest) Descriptor deprecated added in v1.36.0

func (*BatchImportEvaluatedAnnotationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchImportEvaluatedAnnotationsRequest.ProtoReflect.Descriptor instead.

func (*BatchImportEvaluatedAnnotationsRequest) GetEvaluatedAnnotations added in v1.36.0

func (x *BatchImportEvaluatedAnnotationsRequest) GetEvaluatedAnnotations() []*EvaluatedAnnotation

func (*BatchImportEvaluatedAnnotationsRequest) GetParent added in v1.36.0

func (*BatchImportEvaluatedAnnotationsRequest) ProtoMessage added in v1.36.0

func (*BatchImportEvaluatedAnnotationsRequest) ProtoReflect added in v1.36.0

func (*BatchImportEvaluatedAnnotationsRequest) Reset added in v1.36.0

func (*BatchImportEvaluatedAnnotationsRequest) String added in v1.36.0

type BatchImportEvaluatedAnnotationsResponse added in v1.36.0

type BatchImportEvaluatedAnnotationsResponse struct {

	// Output only. Number of EvaluatedAnnotations imported.
	ImportedEvaluatedAnnotationsCount int32 `` /* 165-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message for [ModelService.BatchImportEvaluatedAnnotations][google.cloud.aiplatform.v1.ModelService.BatchImportEvaluatedAnnotations]

func (*BatchImportEvaluatedAnnotationsResponse) Descriptor deprecated added in v1.36.0

func (*BatchImportEvaluatedAnnotationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchImportEvaluatedAnnotationsResponse.ProtoReflect.Descriptor instead.

func (*BatchImportEvaluatedAnnotationsResponse) GetImportedEvaluatedAnnotationsCount added in v1.36.0

func (x *BatchImportEvaluatedAnnotationsResponse) GetImportedEvaluatedAnnotationsCount() int32

func (*BatchImportEvaluatedAnnotationsResponse) ProtoMessage added in v1.36.0

func (*BatchImportEvaluatedAnnotationsResponse) ProtoReflect added in v1.36.0

func (*BatchImportEvaluatedAnnotationsResponse) Reset added in v1.36.0

func (*BatchImportEvaluatedAnnotationsResponse) String added in v1.36.0

type BatchImportModelEvaluationSlicesRequest

type BatchImportModelEvaluationSlicesRequest struct {

	// Required. The name of the parent ModelEvaluation resource.
	// Format:
	// `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Model evaluation slice resource to be imported.
	ModelEvaluationSlices []*ModelEvaluationSlice `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices]

func (*BatchImportModelEvaluationSlicesRequest) Descriptor deprecated

func (*BatchImportModelEvaluationSlicesRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchImportModelEvaluationSlicesRequest.ProtoReflect.Descriptor instead.

func (*BatchImportModelEvaluationSlicesRequest) GetModelEvaluationSlices

func (x *BatchImportModelEvaluationSlicesRequest) GetModelEvaluationSlices() []*ModelEvaluationSlice

func (*BatchImportModelEvaluationSlicesRequest) GetParent

func (*BatchImportModelEvaluationSlicesRequest) ProtoMessage

func (*BatchImportModelEvaluationSlicesRequest) ProtoReflect

func (*BatchImportModelEvaluationSlicesRequest) Reset

func (*BatchImportModelEvaluationSlicesRequest) String

type BatchImportModelEvaluationSlicesResponse

type BatchImportModelEvaluationSlicesResponse struct {

	// Output only. List of imported
	// [ModelEvaluationSlice.name][google.cloud.aiplatform.v1.ModelEvaluationSlice.name].
	ImportedModelEvaluationSlices []string `` /* 152-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message for [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices]

func (*BatchImportModelEvaluationSlicesResponse) Descriptor deprecated

func (*BatchImportModelEvaluationSlicesResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchImportModelEvaluationSlicesResponse.ProtoReflect.Descriptor instead.

func (*BatchImportModelEvaluationSlicesResponse) GetImportedModelEvaluationSlices

func (x *BatchImportModelEvaluationSlicesResponse) GetImportedModelEvaluationSlices() []string

func (*BatchImportModelEvaluationSlicesResponse) ProtoMessage

func (*BatchImportModelEvaluationSlicesResponse) ProtoReflect

func (*BatchImportModelEvaluationSlicesResponse) Reset

func (*BatchImportModelEvaluationSlicesResponse) String

type BatchMigrateResourcesOperationMetadata

type BatchMigrateResourcesOperationMetadata struct {

	// The common part of the operation metadata.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// Partial results that reflect the latest migration operation progress.
	PartialResults []*BatchMigrateResourcesOperationMetadata_PartialResult `protobuf:"bytes,2,rep,name=partial_results,json=partialResults,proto3" json:"partial_results,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].

func (*BatchMigrateResourcesOperationMetadata) Descriptor deprecated

func (*BatchMigrateResourcesOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use BatchMigrateResourcesOperationMetadata.ProtoReflect.Descriptor instead.

func (*BatchMigrateResourcesOperationMetadata) GetGenericMetadata

func (*BatchMigrateResourcesOperationMetadata) GetPartialResults

func (*BatchMigrateResourcesOperationMetadata) ProtoMessage

func (*BatchMigrateResourcesOperationMetadata) ProtoReflect

func (*BatchMigrateResourcesOperationMetadata) Reset

func (*BatchMigrateResourcesOperationMetadata) String

type BatchMigrateResourcesOperationMetadata_PartialResult

type BatchMigrateResourcesOperationMetadata_PartialResult struct {

	// If the resource's migration is ongoing, none of the result will be set.
	// If the resource's migration is finished, either error or one of the
	// migrated resource name will be filled.
	//
	// Types that are assignable to Result:
	//
	//	*BatchMigrateResourcesOperationMetadata_PartialResult_Error
	//	*BatchMigrateResourcesOperationMetadata_PartialResult_Model
	//	*BatchMigrateResourcesOperationMetadata_PartialResult_Dataset
	Result isBatchMigrateResourcesOperationMetadata_PartialResult_Result `protobuf_oneof:"result"`
	// It's the same as the value in
	// [MigrateResourceRequest.migrate_resource_requests][].
	Request *MigrateResourceRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
	// contains filtered or unexported fields
}

Represents a partial result in batch migration operation for one MigrateResourceRequest[google.cloud.aiplatform.v1.MigrateResourceRequest].

func (*BatchMigrateResourcesOperationMetadata_PartialResult) Descriptor deprecated

Deprecated: Use BatchMigrateResourcesOperationMetadata_PartialResult.ProtoReflect.Descriptor instead.

func (*BatchMigrateResourcesOperationMetadata_PartialResult) GetDataset

func (*BatchMigrateResourcesOperationMetadata_PartialResult) GetError

func (*BatchMigrateResourcesOperationMetadata_PartialResult) GetModel

func (*BatchMigrateResourcesOperationMetadata_PartialResult) GetRequest

func (*BatchMigrateResourcesOperationMetadata_PartialResult) GetResult

func (m *BatchMigrateResourcesOperationMetadata_PartialResult) GetResult() isBatchMigrateResourcesOperationMetadata_PartialResult_Result

func (*BatchMigrateResourcesOperationMetadata_PartialResult) ProtoMessage

func (*BatchMigrateResourcesOperationMetadata_PartialResult) ProtoReflect

func (*BatchMigrateResourcesOperationMetadata_PartialResult) Reset

func (*BatchMigrateResourcesOperationMetadata_PartialResult) String

type BatchMigrateResourcesOperationMetadata_PartialResult_Dataset

type BatchMigrateResourcesOperationMetadata_PartialResult_Dataset struct {
	// Migrated dataset resource name.
	Dataset string `protobuf:"bytes,4,opt,name=dataset,proto3,oneof"`
}

type BatchMigrateResourcesOperationMetadata_PartialResult_Error

type BatchMigrateResourcesOperationMetadata_PartialResult_Error struct {
	// The error result of the migration request in case of failure.
	Error *status.Status `protobuf:"bytes,2,opt,name=error,proto3,oneof"`
}

type BatchMigrateResourcesOperationMetadata_PartialResult_Model

type BatchMigrateResourcesOperationMetadata_PartialResult_Model struct {
	// Migrated model resource name.
	Model string `protobuf:"bytes,3,opt,name=model,proto3,oneof"`
}

type BatchMigrateResourcesRequest

type BatchMigrateResourcesRequest struct {

	// Required. The location of the migrated resource will live in.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The request messages specifying the resources to migrate.
	// They must be in the same location as the destination.
	// Up to 50 resources can be migrated in one batch.
	MigrateResourceRequests []*MigrateResourceRequest `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].

func (*BatchMigrateResourcesRequest) Descriptor deprecated

func (*BatchMigrateResourcesRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchMigrateResourcesRequest.ProtoReflect.Descriptor instead.

func (*BatchMigrateResourcesRequest) GetMigrateResourceRequests

func (x *BatchMigrateResourcesRequest) GetMigrateResourceRequests() []*MigrateResourceRequest

func (*BatchMigrateResourcesRequest) GetParent

func (x *BatchMigrateResourcesRequest) GetParent() string

func (*BatchMigrateResourcesRequest) ProtoMessage

func (*BatchMigrateResourcesRequest) ProtoMessage()

func (*BatchMigrateResourcesRequest) ProtoReflect

func (*BatchMigrateResourcesRequest) Reset

func (x *BatchMigrateResourcesRequest) Reset()

func (*BatchMigrateResourcesRequest) String

type BatchMigrateResourcesResponse

type BatchMigrateResourcesResponse struct {

	// Successfully migrated resources.
	MigrateResourceResponses []*MigrateResourceResponse `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].

func (*BatchMigrateResourcesResponse) Descriptor deprecated

func (*BatchMigrateResourcesResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchMigrateResourcesResponse.ProtoReflect.Descriptor instead.

func (*BatchMigrateResourcesResponse) GetMigrateResourceResponses

func (x *BatchMigrateResourcesResponse) GetMigrateResourceResponses() []*MigrateResourceResponse

func (*BatchMigrateResourcesResponse) ProtoMessage

func (*BatchMigrateResourcesResponse) ProtoMessage()

func (*BatchMigrateResourcesResponse) ProtoReflect

func (*BatchMigrateResourcesResponse) Reset

func (x *BatchMigrateResourcesResponse) Reset()

func (*BatchMigrateResourcesResponse) String

type BatchPredictionJob

type BatchPredictionJob struct {

	// Output only. Resource name of the BatchPredictionJob.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The user-defined name of this BatchPredictionJob.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The name of the Model resource that produces the predictions via this job,
	// must share the same ancestor Location.
	// Starting this job has no impact on any existing deployments of the Model
	// and their resources.
	// Exactly one of model and unmanaged_container_model must be set.
	//
	// The model resource name may contain version id or version alias to specify
	// the version.
	//
	//	Example: `projects/{project}/locations/{location}/models/{model}@2`
	//	            or
	//	          `projects/{project}/locations/{location}/models/{model}@golden`
	//
	// if no version is specified, the default version will be deployed.
	//
	// The model resource could also be a publisher model.
	//
	//	Example: `publishers/{publisher}/models/{model}`
	//	            or
	//	         `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`
	Model string `protobuf:"bytes,3,opt,name=model,proto3" json:"model,omitempty"`
	// Output only. The version ID of the Model that produces the predictions via
	// this job.
	ModelVersionId string `protobuf:"bytes,30,opt,name=model_version_id,json=modelVersionId,proto3" json:"model_version_id,omitempty"`
	// Contains model information necessary to perform batch prediction without
	// requiring uploading to model registry.
	// Exactly one of model and unmanaged_container_model must be set.
	UnmanagedContainerModel *UnmanagedContainerModel `` /* 133-byte string literal not displayed */
	// Required. Input configuration of the instances on which predictions are
	// performed. The schema of any single instance may be specified via the
	// [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
	// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
	InputConfig *BatchPredictionJob_InputConfig `protobuf:"bytes,4,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
	// Configuration for how to convert batch prediction input instances to the
	// prediction instances that are sent to the Model.
	InstanceConfig *BatchPredictionJob_InstanceConfig `protobuf:"bytes,27,opt,name=instance_config,json=instanceConfig,proto3" json:"instance_config,omitempty"`
	// The parameters that govern the predictions. The schema of the parameters
	// may be specified via the
	// [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
	// [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
	ModelParameters *structpb.Value `protobuf:"bytes,5,opt,name=model_parameters,json=modelParameters,proto3" json:"model_parameters,omitempty"`
	// Required. The Configuration specifying where output predictions should
	// be written.
	// The schema of any single prediction may be specified as a concatenation
	// of [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
	// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
	// and
	// [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
	OutputConfig *BatchPredictionJob_OutputConfig `protobuf:"bytes,6,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
	// The config of resources used by the Model during the batch prediction. If
	// the Model
	// [supports][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types]
	// DEDICATED_RESOURCES this config may be provided (and the job will use these
	// resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config
	// must be provided.
	DedicatedResources *BatchDedicatedResources `protobuf:"bytes,7,opt,name=dedicated_resources,json=dedicatedResources,proto3" json:"dedicated_resources,omitempty"`
	// The service account that the DeployedModel's container runs as. If not
	// specified, a system generated one will be used, which
	// has minimal permissions and the custom container, if used, may not have
	// enough permission to access other Google Cloud resources.
	//
	// Users deploying the Model must have the `iam.serviceAccounts.actAs`
	// permission on this service account.
	ServiceAccount string `protobuf:"bytes,29,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// Immutable. Parameters configuring the batch behavior. Currently only
	// applicable when
	// [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.dedicated_resources]
	// are used (in other cases Vertex AI does the tuning itself).
	ManualBatchTuningParameters *ManualBatchTuningParameters `` /* 146-byte string literal not displayed */
	// Generate explanation with the batch prediction results.
	//
	// When set to `true`, the batch prediction output changes based on the
	// `predictions_format` field of the
	// [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]
	// object:
	//
	//   - `bigquery`: output includes a column named `explanation`. The value
	//     is a struct that conforms to the
	//     [Explanation][google.cloud.aiplatform.v1.Explanation] object.
	//   - `jsonl`: The JSON objects on each line include an additional entry
	//     keyed `explanation`. The value of the entry is a JSON object that
	//     conforms to the [Explanation][google.cloud.aiplatform.v1.Explanation]
	//     object.
	//   - `csv`: Generating explanations for CSV format is not supported.
	//
	// If this field is set to true, either the
	// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
	// or
	// [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
	// must be populated.
	GenerateExplanation bool `protobuf:"varint,23,opt,name=generate_explanation,json=generateExplanation,proto3" json:"generate_explanation,omitempty"`
	// Explanation configuration for this BatchPredictionJob. Can be
	// specified only if
	// [generate_explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
	// is set to `true`.
	//
	// This value overrides the value of
	// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec].
	// All fields of
	// [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
	// are optional in the request. If a field of the
	// [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
	// object is not populated, the corresponding field of the
	// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
	// object is inherited.
	ExplanationSpec *ExplanationSpec `protobuf:"bytes,25,opt,name=explanation_spec,json=explanationSpec,proto3" json:"explanation_spec,omitempty"`
	// Output only. Information further describing the output of this job.
	OutputInfo *BatchPredictionJob_OutputInfo `protobuf:"bytes,9,opt,name=output_info,json=outputInfo,proto3" json:"output_info,omitempty"`
	// Output only. The detailed state of the job.
	State JobState `protobuf:"varint,10,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.JobState" json:"state,omitempty"`
	// Output only. Only populated when the job's state is JOB_STATE_FAILED or
	// JOB_STATE_CANCELLED.
	Error *status.Status `protobuf:"bytes,11,opt,name=error,proto3" json:"error,omitempty"`
	// Output only. Partial failures encountered.
	// For example, single files that can't be read.
	// This field never exceeds 20 entries.
	// Status details fields contain standard Google Cloud error details.
	PartialFailures []*status.Status `protobuf:"bytes,12,rep,name=partial_failures,json=partialFailures,proto3" json:"partial_failures,omitempty"`
	// Output only. Information about resources that had been consumed by this
	// job. Provided in real time at best effort basis, as well as a final value
	// once the job completes.
	//
	// Note: This field currently may be not populated for batch predictions that
	// use AutoML Models.
	ResourcesConsumed *ResourcesConsumed `protobuf:"bytes,13,opt,name=resources_consumed,json=resourcesConsumed,proto3" json:"resources_consumed,omitempty"`
	// Output only. Statistics on completed and failed prediction instances.
	CompletionStats *CompletionStats `protobuf:"bytes,14,opt,name=completion_stats,json=completionStats,proto3" json:"completion_stats,omitempty"`
	// Output only. Time when the BatchPredictionJob was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,15,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Time when the BatchPredictionJob for the first time entered
	// the `JOB_STATE_RUNNING` state.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,16,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. Time when the BatchPredictionJob entered any of the following
	// states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,17,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Time when the BatchPredictionJob was most recently updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,18,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The labels with user-defined metadata to organize BatchPredictionJobs.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Customer-managed encryption key options for a BatchPredictionJob. If this
	// is set, then all resources created by the BatchPredictionJob will be
	// encrypted with the provided encryption key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,24,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// For custom-trained Models and AutoML Tabular Models, the container of the
	// DeployedModel instances will send `stderr` and `stdout` streams to
	// Cloud Logging by default. Please note that the logs incur cost,
	// which are subject to [Cloud Logging
	// pricing](https://cloud.google.com/logging/pricing).
	//
	// User can disable container logging by setting this flag to true.
	DisableContainerLogging bool `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

A job that uses a Model[google.cloud.aiplatform.v1.BatchPredictionJob.model] to produce predictions on multiple [input instances][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If predictions for significant portion of the instances fail, the job may finish without attempting predictions for all remaining instances.

func (*BatchPredictionJob) Descriptor deprecated

func (*BatchPredictionJob) Descriptor() ([]byte, []int)

Deprecated: Use BatchPredictionJob.ProtoReflect.Descriptor instead.

func (*BatchPredictionJob) GetCompletionStats

func (x *BatchPredictionJob) GetCompletionStats() *CompletionStats

func (*BatchPredictionJob) GetCreateTime

func (x *BatchPredictionJob) GetCreateTime() *timestamppb.Timestamp

func (*BatchPredictionJob) GetDedicatedResources

func (x *BatchPredictionJob) GetDedicatedResources() *BatchDedicatedResources

func (*BatchPredictionJob) GetDisableContainerLogging added in v1.36.0

func (x *BatchPredictionJob) GetDisableContainerLogging() bool

func (*BatchPredictionJob) GetDisplayName

func (x *BatchPredictionJob) GetDisplayName() string

func (*BatchPredictionJob) GetEncryptionSpec

func (x *BatchPredictionJob) GetEncryptionSpec() *EncryptionSpec

func (*BatchPredictionJob) GetEndTime

func (x *BatchPredictionJob) GetEndTime() *timestamppb.Timestamp

func (*BatchPredictionJob) GetError

func (x *BatchPredictionJob) GetError() *status.Status

func (*BatchPredictionJob) GetExplanationSpec

func (x *BatchPredictionJob) GetExplanationSpec() *ExplanationSpec

func (*BatchPredictionJob) GetGenerateExplanation

func (x *BatchPredictionJob) GetGenerateExplanation() bool

func (*BatchPredictionJob) GetInputConfig

func (*BatchPredictionJob) GetInstanceConfig added in v1.30.0

func (x *BatchPredictionJob) GetInstanceConfig() *BatchPredictionJob_InstanceConfig

func (*BatchPredictionJob) GetLabels

func (x *BatchPredictionJob) GetLabels() map[string]string

func (*BatchPredictionJob) GetManualBatchTuningParameters

func (x *BatchPredictionJob) GetManualBatchTuningParameters() *ManualBatchTuningParameters

func (*BatchPredictionJob) GetModel

func (x *BatchPredictionJob) GetModel() string

func (*BatchPredictionJob) GetModelParameters

func (x *BatchPredictionJob) GetModelParameters() *structpb.Value

func (*BatchPredictionJob) GetModelVersionId

func (x *BatchPredictionJob) GetModelVersionId() string

func (*BatchPredictionJob) GetName

func (x *BatchPredictionJob) GetName() string

func (*BatchPredictionJob) GetOutputConfig

func (*BatchPredictionJob) GetOutputInfo

func (*BatchPredictionJob) GetPartialFailures

func (x *BatchPredictionJob) GetPartialFailures() []*status.Status

func (*BatchPredictionJob) GetResourcesConsumed

func (x *BatchPredictionJob) GetResourcesConsumed() *ResourcesConsumed

func (*BatchPredictionJob) GetServiceAccount

func (x *BatchPredictionJob) GetServiceAccount() string

func (*BatchPredictionJob) GetStartTime

func (x *BatchPredictionJob) GetStartTime() *timestamppb.Timestamp

func (*BatchPredictionJob) GetState

func (x *BatchPredictionJob) GetState() JobState

func (*BatchPredictionJob) GetUnmanagedContainerModel

func (x *BatchPredictionJob) GetUnmanagedContainerModel() *UnmanagedContainerModel

func (*BatchPredictionJob) GetUpdateTime

func (x *BatchPredictionJob) GetUpdateTime() *timestamppb.Timestamp

func (*BatchPredictionJob) ProtoMessage

func (*BatchPredictionJob) ProtoMessage()

func (*BatchPredictionJob) ProtoReflect

func (x *BatchPredictionJob) ProtoReflect() protoreflect.Message

func (*BatchPredictionJob) Reset

func (x *BatchPredictionJob) Reset()

func (*BatchPredictionJob) String

func (x *BatchPredictionJob) String() string

type BatchPredictionJob_InputConfig

type BatchPredictionJob_InputConfig struct {

	// Required. The source of the input.
	//
	// Types that are assignable to Source:
	//
	//	*BatchPredictionJob_InputConfig_GcsSource
	//	*BatchPredictionJob_InputConfig_BigquerySource
	Source isBatchPredictionJob_InputConfig_Source `protobuf_oneof:"source"`
	// Required. The format in which instances are given, must be one of the
	// [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
	// [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats].
	InstancesFormat string `protobuf:"bytes,1,opt,name=instances_format,json=instancesFormat,proto3" json:"instances_format,omitempty"`
	// contains filtered or unexported fields
}

Configures the input to BatchPredictionJob[google.cloud.aiplatform.v1.BatchPredictionJob]. See [Model.supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] for Model's supported input formats, and how instances should be expressed via any of them.

func (*BatchPredictionJob_InputConfig) Descriptor deprecated

func (*BatchPredictionJob_InputConfig) Descriptor() ([]byte, []int)

Deprecated: Use BatchPredictionJob_InputConfig.ProtoReflect.Descriptor instead.

func (*BatchPredictionJob_InputConfig) GetBigquerySource

func (x *BatchPredictionJob_InputConfig) GetBigquerySource() *BigQuerySource

func (*BatchPredictionJob_InputConfig) GetGcsSource

func (x *BatchPredictionJob_InputConfig) GetGcsSource() *GcsSource

func (*BatchPredictionJob_InputConfig) GetInstancesFormat

func (x *BatchPredictionJob_InputConfig) GetInstancesFormat() string

func (*BatchPredictionJob_InputConfig) GetSource

func (m *BatchPredictionJob_InputConfig) GetSource() isBatchPredictionJob_InputConfig_Source

func (*BatchPredictionJob_InputConfig) ProtoMessage

func (*BatchPredictionJob_InputConfig) ProtoMessage()

func (*BatchPredictionJob_InputConfig) ProtoReflect

func (*BatchPredictionJob_InputConfig) Reset

func (x *BatchPredictionJob_InputConfig) Reset()

func (*BatchPredictionJob_InputConfig) String

type BatchPredictionJob_InputConfig_BigquerySource

type BatchPredictionJob_InputConfig_BigquerySource struct {
	// The BigQuery location of the input table.
	// The schema of the table should be in the format described by the given
	// context OpenAPI Schema, if one is provided. The table may contain
	// additional columns that are not described by the schema, and they will
	// be ignored.
	BigquerySource *BigQuerySource `protobuf:"bytes,3,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}

type BatchPredictionJob_InputConfig_GcsSource

type BatchPredictionJob_InputConfig_GcsSource struct {
	// The Cloud Storage location for the input instances.
	GcsSource *GcsSource `protobuf:"bytes,2,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type BatchPredictionJob_InstanceConfig added in v1.30.0

type BatchPredictionJob_InstanceConfig struct {

	// The format of the instance that the Model accepts. Vertex AI will
	// convert compatible
	// [batch prediction input instance
	// formats][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.instances_format]
	// to the specified format.
	//
	// Supported values are:
	//
	// * `object`: Each input is converted to JSON object format.
	//   - For `bigquery`, each row is converted to an object.
	//   - For `jsonl`, each line of the JSONL input must be an object.
	//   - Does not apply to `csv`, `file-list`, `tf-record`, or
	//     `tf-record-gzip`.
	//
	// * `array`: Each input is converted to JSON array format.
	//   - For `bigquery`, each row is converted to an array. The order
	//     of columns is determined by the BigQuery column order, unless
	//     [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
	//     is populated.
	//     [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
	//     must be populated for specifying field orders.
	//   - For `jsonl`, if each line of the JSONL input is an object,
	//     [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
	//     must be populated for specifying field orders.
	//   - Does not apply to `csv`, `file-list`, `tf-record`, or
	//     `tf-record-gzip`.
	//
	// If not specified, Vertex AI converts the batch prediction input as
	// follows:
	//
	//   - For `bigquery` and `csv`, the behavior is the same as `array`. The
	//     order of columns is the same as defined in the file or table, unless
	//     [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
	//     is populated.
	//   - For `jsonl`, the prediction instance format is determined by
	//     each line of the input.
	//   - For `tf-record`/`tf-record-gzip`, each record will be converted to
	//     an object in the format of `{"b64": <value>}`, where `<value>` is
	//     the Base64-encoded string of the content of the record.
	//   - For `file-list`, each file in the list will be converted to an
	//     object in the format of `{"b64": <value>}`, where `<value>` is
	//     the Base64-encoded string of the content of the file.
	InstanceType string `protobuf:"bytes,1,opt,name=instance_type,json=instanceType,proto3" json:"instance_type,omitempty"`
	// The name of the field that is considered as a key.
	//
	// The values identified by the key field is not included in the transformed
	// instances that is sent to the Model. This is similar to
	// specifying this name of the field in
	// [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields].
	// In addition, the batch prediction output will not include the instances.
	// Instead the output will only include the value of the key field, in a
	// field named `key` in the output:
	//
	//   - For `jsonl` output format, the output will have a `key` field
	//     instead of the `instance` field.
	//   - For `csv`/`bigquery` output format, the output will have have a `key`
	//     column instead of the instance feature columns.
	//
	// The input must be JSONL with objects at each line, CSV, BigQuery
	// or TfRecord.
	KeyField string `protobuf:"bytes,2,opt,name=key_field,json=keyField,proto3" json:"key_field,omitempty"`
	// Fields that will be included in the prediction instance that is
	// sent to the Model.
	//
	// If
	// [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type]
	// is `array`, the order of field names in included_fields also determines
	// the order of the values in the array.
	//
	// When included_fields is populated,
	// [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields]
	// must be empty.
	//
	// The input must be JSONL with objects at each line, BigQuery
	// or TfRecord.
	IncludedFields []string `protobuf:"bytes,3,rep,name=included_fields,json=includedFields,proto3" json:"included_fields,omitempty"`
	// Fields that will be excluded in the prediction instance that is
	// sent to the Model.
	//
	// Excluded will be attached to the batch prediction output if
	// [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field]
	// is not specified.
	//
	// When excluded_fields is populated,
	// [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
	// must be empty.
	//
	// The input must be JSONL with objects at each line, BigQuery
	// or TfRecord.
	ExcludedFields []string `protobuf:"bytes,4,rep,name=excluded_fields,json=excludedFields,proto3" json:"excluded_fields,omitempty"`
	// contains filtered or unexported fields
}

Configuration defining how to transform batch prediction input instances to the instances that the Model accepts.

func (*BatchPredictionJob_InstanceConfig) Descriptor deprecated added in v1.30.0

func (*BatchPredictionJob_InstanceConfig) Descriptor() ([]byte, []int)

Deprecated: Use BatchPredictionJob_InstanceConfig.ProtoReflect.Descriptor instead.

func (*BatchPredictionJob_InstanceConfig) GetExcludedFields added in v1.30.0

func (x *BatchPredictionJob_InstanceConfig) GetExcludedFields() []string

func (*BatchPredictionJob_InstanceConfig) GetIncludedFields added in v1.30.0

func (x *BatchPredictionJob_InstanceConfig) GetIncludedFields() []string

func (*BatchPredictionJob_InstanceConfig) GetInstanceType added in v1.30.0

func (x *BatchPredictionJob_InstanceConfig) GetInstanceType() string

func (*BatchPredictionJob_InstanceConfig) GetKeyField added in v1.30.0

func (x *BatchPredictionJob_InstanceConfig) GetKeyField() string

func (*BatchPredictionJob_InstanceConfig) ProtoMessage added in v1.30.0

func (*BatchPredictionJob_InstanceConfig) ProtoMessage()

func (*BatchPredictionJob_InstanceConfig) ProtoReflect added in v1.30.0

func (*BatchPredictionJob_InstanceConfig) Reset added in v1.30.0

func (*BatchPredictionJob_InstanceConfig) String added in v1.30.0

type BatchPredictionJob_OutputConfig

type BatchPredictionJob_OutputConfig struct {

	// Required. The destination of the output.
	//
	// Types that are assignable to Destination:
	//
	//	*BatchPredictionJob_OutputConfig_GcsDestination
	//	*BatchPredictionJob_OutputConfig_BigqueryDestination
	Destination isBatchPredictionJob_OutputConfig_Destination `protobuf_oneof:"destination"`
	// Required. The format in which Vertex AI gives the predictions, must be
	// one of the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
	// [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
	PredictionsFormat string `protobuf:"bytes,1,opt,name=predictions_format,json=predictionsFormat,proto3" json:"predictions_format,omitempty"`
	// contains filtered or unexported fields
}

Configures the output of BatchPredictionJob[google.cloud.aiplatform.v1.BatchPredictionJob]. See [Model.supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats] for supported output formats, and how predictions are expressed via any of them.

func (*BatchPredictionJob_OutputConfig) Descriptor deprecated

func (*BatchPredictionJob_OutputConfig) Descriptor() ([]byte, []int)

Deprecated: Use BatchPredictionJob_OutputConfig.ProtoReflect.Descriptor instead.

func (*BatchPredictionJob_OutputConfig) GetBigqueryDestination

func (x *BatchPredictionJob_OutputConfig) GetBigqueryDestination() *BigQueryDestination

func (*BatchPredictionJob_OutputConfig) GetDestination

func (m *BatchPredictionJob_OutputConfig) GetDestination() isBatchPredictionJob_OutputConfig_Destination

func (*BatchPredictionJob_OutputConfig) GetGcsDestination

func (x *BatchPredictionJob_OutputConfig) GetGcsDestination() *GcsDestination

func (*BatchPredictionJob_OutputConfig) GetPredictionsFormat

func (x *BatchPredictionJob_OutputConfig) GetPredictionsFormat() string

func (*BatchPredictionJob_OutputConfig) ProtoMessage

func (*BatchPredictionJob_OutputConfig) ProtoMessage()

func (*BatchPredictionJob_OutputConfig) ProtoReflect

func (*BatchPredictionJob_OutputConfig) Reset

func (*BatchPredictionJob_OutputConfig) String

type BatchPredictionJob_OutputConfig_BigqueryDestination

type BatchPredictionJob_OutputConfig_BigqueryDestination struct {
	// The BigQuery project or dataset location where the output is to be
	// written to. If project is provided, a new dataset is created with name
	// `prediction_<model-display-name>_<job-create-time>`
	// where <model-display-name> is made
	// BigQuery-dataset-name compatible (for example, most special characters
	// become underscores), and timestamp is in
	// YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the dataset
	// two tables will be created, `predictions`, and `errors`.
	// If the Model has both
	// [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
	// and
	// [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
	// schemata defined then the tables have columns as follows: The
	// `predictions` table contains instances for which the prediction
	// succeeded, it has columns as per a concatenation of the Model's
	// instance and prediction schemata. The `errors` table contains rows for
	// which the prediction has failed, it has instance columns, as per the
	// instance schema, followed by a single "errors" column, which as values
	// has [google.rpc.Status][google.rpc.Status]
	// represented as a STRUCT, and containing only `code` and `message`.
	BigqueryDestination *BigQueryDestination `protobuf:"bytes,3,opt,name=bigquery_destination,json=bigqueryDestination,proto3,oneof"`
}

type BatchPredictionJob_OutputConfig_GcsDestination

type BatchPredictionJob_OutputConfig_GcsDestination struct {
	// The Cloud Storage location of the directory where the output is
	// to be written to. In the given directory a new directory is created.
	// Its name is `prediction-<model-display-name>-<job-create-time>`,
	// where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format.
	// Inside of it files `predictions_0001.<extension>`,
	// `predictions_0002.<extension>`, ..., `predictions_N.<extension>`
	// are created where `<extension>` depends on chosen
	// [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format],
	// and N may equal 0001 and depends on the total number of successfully
	// predicted instances. If the Model has both
	// [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
	// and
	// [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
	// schemata defined then each such file contains predictions as per the
	// [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format].
	// If prediction for any instance failed (partially or completely), then
	// an additional `errors_0001.<extension>`, `errors_0002.<extension>`,...,
	// `errors_N.<extension>` files are created (N depends on total number
	// of failed predictions). These files contain the failed instances,
	// as per their schema, followed by an additional `error` field which as
	// value has [google.rpc.Status][google.rpc.Status]
	// containing only `code` and `message` fields.
	GcsDestination *GcsDestination `protobuf:"bytes,2,opt,name=gcs_destination,json=gcsDestination,proto3,oneof"`
}

type BatchPredictionJob_OutputInfo

type BatchPredictionJob_OutputInfo struct {

	// The output location into which prediction output is written.
	//
	// Types that are assignable to OutputLocation:
	//
	//	*BatchPredictionJob_OutputInfo_GcsOutputDirectory
	//	*BatchPredictionJob_OutputInfo_BigqueryOutputDataset
	OutputLocation isBatchPredictionJob_OutputInfo_OutputLocation `protobuf_oneof:"output_location"`
	// Output only. The name of the BigQuery table created, in
	// `predictions_<timestamp>`
	// format, into which the prediction output is written.
	// Can be used by UI to generate the BigQuery output path, for example.
	BigqueryOutputTable string `protobuf:"bytes,4,opt,name=bigquery_output_table,json=bigqueryOutputTable,proto3" json:"bigquery_output_table,omitempty"`
	// contains filtered or unexported fields
}

Further describes this job's output. Supplements [output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].

func (*BatchPredictionJob_OutputInfo) Descriptor deprecated

func (*BatchPredictionJob_OutputInfo) Descriptor() ([]byte, []int)

Deprecated: Use BatchPredictionJob_OutputInfo.ProtoReflect.Descriptor instead.

func (*BatchPredictionJob_OutputInfo) GetBigqueryOutputDataset

func (x *BatchPredictionJob_OutputInfo) GetBigqueryOutputDataset() string

func (*BatchPredictionJob_OutputInfo) GetBigqueryOutputTable

func (x *BatchPredictionJob_OutputInfo) GetBigqueryOutputTable() string

func (*BatchPredictionJob_OutputInfo) GetGcsOutputDirectory

func (x *BatchPredictionJob_OutputInfo) GetGcsOutputDirectory() string

func (*BatchPredictionJob_OutputInfo) GetOutputLocation

func (m *BatchPredictionJob_OutputInfo) GetOutputLocation() isBatchPredictionJob_OutputInfo_OutputLocation

func (*BatchPredictionJob_OutputInfo) ProtoMessage

func (*BatchPredictionJob_OutputInfo) ProtoMessage()

func (*BatchPredictionJob_OutputInfo) ProtoReflect

func (*BatchPredictionJob_OutputInfo) Reset

func (x *BatchPredictionJob_OutputInfo) Reset()

func (*BatchPredictionJob_OutputInfo) String

type BatchPredictionJob_OutputInfo_BigqueryOutputDataset

type BatchPredictionJob_OutputInfo_BigqueryOutputDataset struct {
	// Output only. The path of the BigQuery dataset created, in
	// `bq://projectId.bqDatasetId`
	// format, into which the prediction output is written.
	BigqueryOutputDataset string `protobuf:"bytes,2,opt,name=bigquery_output_dataset,json=bigqueryOutputDataset,proto3,oneof"`
}

type BatchPredictionJob_OutputInfo_GcsOutputDirectory

type BatchPredictionJob_OutputInfo_GcsOutputDirectory struct {
	// Output only. The full path of the Cloud Storage directory created, into
	// which the prediction output is written.
	GcsOutputDirectory string `protobuf:"bytes,1,opt,name=gcs_output_directory,json=gcsOutputDirectory,proto3,oneof"`
}

type BatchReadFeatureValuesOperationMetadata

type BatchReadFeatureValuesOperationMetadata struct {

	// Operation metadata for Featurestore batch read Features values.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that batch reads Feature values.

func (*BatchReadFeatureValuesOperationMetadata) Descriptor deprecated

func (*BatchReadFeatureValuesOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use BatchReadFeatureValuesOperationMetadata.ProtoReflect.Descriptor instead.

func (*BatchReadFeatureValuesOperationMetadata) GetGenericMetadata

func (*BatchReadFeatureValuesOperationMetadata) ProtoMessage

func (*BatchReadFeatureValuesOperationMetadata) ProtoReflect

func (*BatchReadFeatureValuesOperationMetadata) Reset

func (*BatchReadFeatureValuesOperationMetadata) String

type BatchReadFeatureValuesRequest

type BatchReadFeatureValuesRequest struct {

	// Types that are assignable to ReadOption:
	//
	//	*BatchReadFeatureValuesRequest_CsvReadInstances
	//	*BatchReadFeatureValuesRequest_BigqueryReadInstances
	ReadOption isBatchReadFeatureValuesRequest_ReadOption `protobuf_oneof:"read_option"`
	// Required. The resource name of the Featurestore from which to query Feature
	// values. Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}`
	Featurestore string `protobuf:"bytes,1,opt,name=featurestore,proto3" json:"featurestore,omitempty"`
	// Required. Specifies output location and format.
	Destination *FeatureValueDestination `protobuf:"bytes,4,opt,name=destination,proto3" json:"destination,omitempty"`
	// When not empty, the specified fields in the *_read_instances source will be
	// joined as-is in the output, in addition to those fields from the
	// Featurestore Entity.
	//
	// For BigQuery source, the type of the pass-through values will be
	// automatically inferred. For CSV source, the pass-through values will be
	// passed as opaque bytes.
	PassThroughFields []*BatchReadFeatureValuesRequest_PassThroughField `protobuf:"bytes,8,rep,name=pass_through_fields,json=passThroughFields,proto3" json:"pass_through_fields,omitempty"`
	// Required. Specifies EntityType grouping Features to read values of and
	// settings.
	EntityTypeSpecs []*BatchReadFeatureValuesRequest_EntityTypeSpec `protobuf:"bytes,7,rep,name=entity_type_specs,json=entityTypeSpecs,proto3" json:"entity_type_specs,omitempty"`
	// Optional. Excludes Feature values with feature generation timestamp before
	// this timestamp. If not set, retrieve oldest values kept in Feature Store.
	// Timestamp, if present, must not have higher than millisecond precision.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues].

func (*BatchReadFeatureValuesRequest) Descriptor deprecated

func (*BatchReadFeatureValuesRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchReadFeatureValuesRequest.ProtoReflect.Descriptor instead.

func (*BatchReadFeatureValuesRequest) GetBigqueryReadInstances

func (x *BatchReadFeatureValuesRequest) GetBigqueryReadInstances() *BigQuerySource

func (*BatchReadFeatureValuesRequest) GetCsvReadInstances

func (x *BatchReadFeatureValuesRequest) GetCsvReadInstances() *CsvSource

func (*BatchReadFeatureValuesRequest) GetDestination

func (*BatchReadFeatureValuesRequest) GetEntityTypeSpecs

func (*BatchReadFeatureValuesRequest) GetFeaturestore

func (x *BatchReadFeatureValuesRequest) GetFeaturestore() string

func (*BatchReadFeatureValuesRequest) GetPassThroughFields

func (*BatchReadFeatureValuesRequest) GetReadOption

func (m *BatchReadFeatureValuesRequest) GetReadOption() isBatchReadFeatureValuesRequest_ReadOption

func (*BatchReadFeatureValuesRequest) GetStartTime

func (*BatchReadFeatureValuesRequest) ProtoMessage

func (*BatchReadFeatureValuesRequest) ProtoMessage()

func (*BatchReadFeatureValuesRequest) ProtoReflect

func (*BatchReadFeatureValuesRequest) Reset

func (x *BatchReadFeatureValuesRequest) Reset()

func (*BatchReadFeatureValuesRequest) String

type BatchReadFeatureValuesRequest_BigqueryReadInstances

type BatchReadFeatureValuesRequest_BigqueryReadInstances struct {
	// Similar to csv_read_instances, but from BigQuery source.
	BigqueryReadInstances *BigQuerySource `protobuf:"bytes,5,opt,name=bigquery_read_instances,json=bigqueryReadInstances,proto3,oneof"`
}

type BatchReadFeatureValuesRequest_CsvReadInstances

type BatchReadFeatureValuesRequest_CsvReadInstances struct {
	// Each read instance consists of exactly one read timestamp and one or more
	// entity IDs identifying entities of the corresponding EntityTypes whose
	// Features are requested.
	//
	// Each output instance contains Feature values of requested entities
	// concatenated together as of the read time.
	//
	// An example read instance may be `foo_entity_id, bar_entity_id,
	// 2020-01-01T10:00:00.123Z`.
	//
	// An example output instance may be `foo_entity_id, bar_entity_id,
	// 2020-01-01T10:00:00.123Z, foo_entity_feature1_value,
	// bar_entity_feature2_value`.
	//
	// Timestamp in each read instance must be millisecond-aligned.
	//
	// `csv_read_instances` are read instances stored in a plain-text CSV file.
	// The header should be:
	//
	//	[ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp
	//
	// The columns can be in any order.
	//
	// Values in the timestamp column must use the RFC 3339 format, e.g.
	// `2012-07-30T10:43:17.123Z`.
	CsvReadInstances *CsvSource `protobuf:"bytes,3,opt,name=csv_read_instances,json=csvReadInstances,proto3,oneof"`
}

type BatchReadFeatureValuesRequest_EntityTypeSpec

type BatchReadFeatureValuesRequest_EntityTypeSpec struct {

	// Required. ID of the EntityType to select Features. The EntityType id is
	// the
	// [entity_type_id][google.cloud.aiplatform.v1.CreateEntityTypeRequest.entity_type_id]
	// specified during EntityType creation.
	EntityTypeId string `protobuf:"bytes,1,opt,name=entity_type_id,json=entityTypeId,proto3" json:"entity_type_id,omitempty"`
	// Required. Selectors choosing which Feature values to read from the
	// EntityType.
	FeatureSelector *FeatureSelector `protobuf:"bytes,2,opt,name=feature_selector,json=featureSelector,proto3" json:"feature_selector,omitempty"`
	// Per-Feature settings for the batch read.
	Settings []*DestinationFeatureSetting `protobuf:"bytes,3,rep,name=settings,proto3" json:"settings,omitempty"`
	// contains filtered or unexported fields
}

Selects Features of an EntityType to read values of and specifies read settings.

func (*BatchReadFeatureValuesRequest_EntityTypeSpec) Descriptor deprecated

Deprecated: Use BatchReadFeatureValuesRequest_EntityTypeSpec.ProtoReflect.Descriptor instead.

func (*BatchReadFeatureValuesRequest_EntityTypeSpec) GetEntityTypeId

func (*BatchReadFeatureValuesRequest_EntityTypeSpec) GetFeatureSelector

func (*BatchReadFeatureValuesRequest_EntityTypeSpec) GetSettings

func (*BatchReadFeatureValuesRequest_EntityTypeSpec) ProtoMessage

func (*BatchReadFeatureValuesRequest_EntityTypeSpec) ProtoReflect

func (*BatchReadFeatureValuesRequest_EntityTypeSpec) Reset

func (*BatchReadFeatureValuesRequest_EntityTypeSpec) String

type BatchReadFeatureValuesRequest_PassThroughField

type BatchReadFeatureValuesRequest_PassThroughField struct {

	// Required. The name of the field in the CSV header or the name of the
	// column in BigQuery table. The naming restriction is the same as
	// [Feature.name][google.cloud.aiplatform.v1.Feature.name].
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// contains filtered or unexported fields
}

Describe pass-through fields in read_instance source.

func (*BatchReadFeatureValuesRequest_PassThroughField) Descriptor deprecated

Deprecated: Use BatchReadFeatureValuesRequest_PassThroughField.ProtoReflect.Descriptor instead.

func (*BatchReadFeatureValuesRequest_PassThroughField) GetFieldName

func (*BatchReadFeatureValuesRequest_PassThroughField) ProtoMessage

func (*BatchReadFeatureValuesRequest_PassThroughField) ProtoReflect

func (*BatchReadFeatureValuesRequest_PassThroughField) Reset

func (*BatchReadFeatureValuesRequest_PassThroughField) String

type BatchReadFeatureValuesResponse

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

Response message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues].

func (*BatchReadFeatureValuesResponse) Descriptor deprecated

func (*BatchReadFeatureValuesResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchReadFeatureValuesResponse.ProtoReflect.Descriptor instead.

func (*BatchReadFeatureValuesResponse) ProtoMessage

func (*BatchReadFeatureValuesResponse) ProtoMessage()

func (*BatchReadFeatureValuesResponse) ProtoReflect

func (*BatchReadFeatureValuesResponse) Reset

func (x *BatchReadFeatureValuesResponse) Reset()

func (*BatchReadFeatureValuesResponse) String

type BatchReadTensorboardTimeSeriesDataRequest

type BatchReadTensorboardTimeSeriesDataRequest struct {

	// Required. The resource name of the Tensorboard containing
	// TensorboardTimeSeries to read data from. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`.
	// The TensorboardTimeSeries referenced by
	// [time_series][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series]
	// must be sub resources of this Tensorboard.
	Tensorboard string `protobuf:"bytes,1,opt,name=tensorboard,proto3" json:"tensorboard,omitempty"`
	// Required. The resource names of the TensorboardTimeSeries to read data
	// from. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
	TimeSeries []string `protobuf:"bytes,2,rep,name=time_series,json=timeSeries,proto3" json:"time_series,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.BatchReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData].

func (*BatchReadTensorboardTimeSeriesDataRequest) Descriptor deprecated

func (*BatchReadTensorboardTimeSeriesDataRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchReadTensorboardTimeSeriesDataRequest.ProtoReflect.Descriptor instead.

func (*BatchReadTensorboardTimeSeriesDataRequest) GetTensorboard

func (*BatchReadTensorboardTimeSeriesDataRequest) GetTimeSeries

func (*BatchReadTensorboardTimeSeriesDataRequest) ProtoMessage

func (*BatchReadTensorboardTimeSeriesDataRequest) ProtoReflect

func (*BatchReadTensorboardTimeSeriesDataRequest) Reset

func (*BatchReadTensorboardTimeSeriesDataRequest) String

type BatchReadTensorboardTimeSeriesDataResponse

type BatchReadTensorboardTimeSeriesDataResponse struct {

	// The returned time series data.
	TimeSeriesData []*TimeSeriesData `protobuf:"bytes,1,rep,name=time_series_data,json=timeSeriesData,proto3" json:"time_series_data,omitempty"`
	// contains filtered or unexported fields
}

Response message for [TensorboardService.BatchReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData].

func (*BatchReadTensorboardTimeSeriesDataResponse) Descriptor deprecated

Deprecated: Use BatchReadTensorboardTimeSeriesDataResponse.ProtoReflect.Descriptor instead.

func (*BatchReadTensorboardTimeSeriesDataResponse) GetTimeSeriesData

func (*BatchReadTensorboardTimeSeriesDataResponse) ProtoMessage

func (*BatchReadTensorboardTimeSeriesDataResponse) ProtoReflect

func (*BatchReadTensorboardTimeSeriesDataResponse) Reset

func (*BatchReadTensorboardTimeSeriesDataResponse) String

type BigQueryDestination

type BigQueryDestination struct {

	// Required. BigQuery URI to a project or table, up to 2000 characters long.
	//
	// When only the project is specified, the Dataset and Table is created.
	// When the full table reference is specified, the Dataset must exist and
	// table must not exist.
	//
	// Accepted forms:
	//
	// *  BigQuery path. For example:
	// `bq://projectId` or `bq://projectId.bqDatasetId` or
	// `bq://projectId.bqDatasetId.bqTableId`.
	OutputUri string `protobuf:"bytes,1,opt,name=output_uri,json=outputUri,proto3" json:"output_uri,omitempty"`
	// contains filtered or unexported fields
}

The BigQuery location for the output content.

func (*BigQueryDestination) Descriptor deprecated

func (*BigQueryDestination) Descriptor() ([]byte, []int)

Deprecated: Use BigQueryDestination.ProtoReflect.Descriptor instead.

func (*BigQueryDestination) GetOutputUri

func (x *BigQueryDestination) GetOutputUri() string

func (*BigQueryDestination) ProtoMessage

func (*BigQueryDestination) ProtoMessage()

func (*BigQueryDestination) ProtoReflect

func (x *BigQueryDestination) ProtoReflect() protoreflect.Message

func (*BigQueryDestination) Reset

func (x *BigQueryDestination) Reset()

func (*BigQueryDestination) String

func (x *BigQueryDestination) String() string

type BigQuerySource

type BigQuerySource struct {

	// Required. BigQuery URI to a table, up to 2000 characters long.
	// Accepted forms:
	//
	// *  BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
	InputUri string `protobuf:"bytes,1,opt,name=input_uri,json=inputUri,proto3" json:"input_uri,omitempty"`
	// contains filtered or unexported fields
}

The BigQuery location for the input content.

func (*BigQuerySource) Descriptor deprecated

func (*BigQuerySource) Descriptor() ([]byte, []int)

Deprecated: Use BigQuerySource.ProtoReflect.Descriptor instead.

func (*BigQuerySource) GetInputUri

func (x *BigQuerySource) GetInputUri() string

func (*BigQuerySource) ProtoMessage

func (*BigQuerySource) ProtoMessage()

func (*BigQuerySource) ProtoReflect

func (x *BigQuerySource) ProtoReflect() protoreflect.Message

func (*BigQuerySource) Reset

func (x *BigQuerySource) Reset()

func (*BigQuerySource) String

func (x *BigQuerySource) String() string

type Blob added in v1.57.0

type Blob struct {

	// Required. The IANA standard MIME type of the source data.
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Required. Raw bytes.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Content blob.

It's preferred to send as [text][google.cloud.aiplatform.v1.Part.text] directly rather than raw bytes.

func (*Blob) Descriptor deprecated added in v1.57.0

func (*Blob) Descriptor() ([]byte, []int)

Deprecated: Use Blob.ProtoReflect.Descriptor instead.

func (*Blob) GetData added in v1.57.0

func (x *Blob) GetData() []byte

func (*Blob) GetMimeType added in v1.57.0

func (x *Blob) GetMimeType() string

func (*Blob) ProtoMessage added in v1.57.0

func (*Blob) ProtoMessage()

func (*Blob) ProtoReflect added in v1.57.0

func (x *Blob) ProtoReflect() protoreflect.Message

func (*Blob) Reset added in v1.57.0

func (x *Blob) Reset()

func (*Blob) String added in v1.57.0

func (x *Blob) String() string

type BlurBaselineConfig

type BlurBaselineConfig struct {

	// The standard deviation of the blur kernel for the blurred baseline. The
	// same blurring parameter is used for both the height and the width
	// dimension. If not set, the method defaults to the zero (i.e. black for
	// images) baseline.
	MaxBlurSigma float32 `protobuf:"fixed32,1,opt,name=max_blur_sigma,json=maxBlurSigma,proto3" json:"max_blur_sigma,omitempty"`
	// contains filtered or unexported fields
}

Config for blur baseline.

When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383

func (*BlurBaselineConfig) Descriptor deprecated

func (*BlurBaselineConfig) Descriptor() ([]byte, []int)

Deprecated: Use BlurBaselineConfig.ProtoReflect.Descriptor instead.

func (*BlurBaselineConfig) GetMaxBlurSigma

func (x *BlurBaselineConfig) GetMaxBlurSigma() float32

func (*BlurBaselineConfig) ProtoMessage

func (*BlurBaselineConfig) ProtoMessage()

func (*BlurBaselineConfig) ProtoReflect

func (x *BlurBaselineConfig) ProtoReflect() protoreflect.Message

func (*BlurBaselineConfig) Reset

func (x *BlurBaselineConfig) Reset()

func (*BlurBaselineConfig) String

func (x *BlurBaselineConfig) String() string

type BoolArray

type BoolArray struct {

	// A list of bool values.
	Values []bool `protobuf:"varint,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

A list of boolean values.

func (*BoolArray) Descriptor deprecated

func (*BoolArray) Descriptor() ([]byte, []int)

Deprecated: Use BoolArray.ProtoReflect.Descriptor instead.

func (*BoolArray) GetValues

func (x *BoolArray) GetValues() []bool

func (*BoolArray) ProtoMessage

func (*BoolArray) ProtoMessage()

func (*BoolArray) ProtoReflect

func (x *BoolArray) ProtoReflect() protoreflect.Message

func (*BoolArray) Reset

func (x *BoolArray) Reset()

func (*BoolArray) String

func (x *BoolArray) String() string

type CancelBatchPredictionJobRequest

type CancelBatchPredictionJobRequest struct {

	// Required. The name of the BatchPredictionJob to cancel.
	// Format:
	// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.CancelBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJob].

func (*CancelBatchPredictionJobRequest) Descriptor deprecated

func (*CancelBatchPredictionJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelBatchPredictionJobRequest.ProtoReflect.Descriptor instead.

func (*CancelBatchPredictionJobRequest) GetName

func (*CancelBatchPredictionJobRequest) ProtoMessage

func (*CancelBatchPredictionJobRequest) ProtoMessage()

func (*CancelBatchPredictionJobRequest) ProtoReflect

func (*CancelBatchPredictionJobRequest) Reset

func (*CancelBatchPredictionJobRequest) String

type CancelCustomJobRequest

type CancelCustomJobRequest struct {

	// Required. The name of the CustomJob to cancel.
	// Format:
	// `projects/{project}/locations/{location}/customJobs/{custom_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.CancelCustomJob][google.cloud.aiplatform.v1.JobService.CancelCustomJob].

func (*CancelCustomJobRequest) Descriptor deprecated

func (*CancelCustomJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelCustomJobRequest.ProtoReflect.Descriptor instead.

func (*CancelCustomJobRequest) GetName

func (x *CancelCustomJobRequest) GetName() string

func (*CancelCustomJobRequest) ProtoMessage

func (*CancelCustomJobRequest) ProtoMessage()

func (*CancelCustomJobRequest) ProtoReflect

func (x *CancelCustomJobRequest) ProtoReflect() protoreflect.Message

func (*CancelCustomJobRequest) Reset

func (x *CancelCustomJobRequest) Reset()

func (*CancelCustomJobRequest) String

func (x *CancelCustomJobRequest) String() string

type CancelDataLabelingJobRequest

type CancelDataLabelingJobRequest struct {

	// Required. The name of the DataLabelingJob.
	// Format:
	// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob].

func (*CancelDataLabelingJobRequest) Descriptor deprecated

func (*CancelDataLabelingJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelDataLabelingJobRequest.ProtoReflect.Descriptor instead.

func (*CancelDataLabelingJobRequest) GetName

func (x *CancelDataLabelingJobRequest) GetName() string

func (*CancelDataLabelingJobRequest) ProtoMessage

func (*CancelDataLabelingJobRequest) ProtoMessage()

func (*CancelDataLabelingJobRequest) ProtoReflect

func (*CancelDataLabelingJobRequest) Reset

func (x *CancelDataLabelingJobRequest) Reset()

func (*CancelDataLabelingJobRequest) String

type CancelHyperparameterTuningJobRequest

type CancelHyperparameterTuningJobRequest struct {

	// Required. The name of the HyperparameterTuningJob to cancel.
	// Format:
	// `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.CancelHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJob].

func (*CancelHyperparameterTuningJobRequest) Descriptor deprecated

func (*CancelHyperparameterTuningJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelHyperparameterTuningJobRequest.ProtoReflect.Descriptor instead.

func (*CancelHyperparameterTuningJobRequest) GetName

func (*CancelHyperparameterTuningJobRequest) ProtoMessage

func (*CancelHyperparameterTuningJobRequest) ProtoMessage()

func (*CancelHyperparameterTuningJobRequest) ProtoReflect

func (*CancelHyperparameterTuningJobRequest) Reset

func (*CancelHyperparameterTuningJobRequest) String

type CancelNasJobRequest added in v1.34.0

type CancelNasJobRequest struct {

	// Required. The name of the NasJob to cancel.
	// Format:
	// `projects/{project}/locations/{location}/nasJobs/{nas_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.CancelNasJob][google.cloud.aiplatform.v1.JobService.CancelNasJob].

func (*CancelNasJobRequest) Descriptor deprecated added in v1.34.0

func (*CancelNasJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelNasJobRequest.ProtoReflect.Descriptor instead.

func (*CancelNasJobRequest) GetName added in v1.34.0

func (x *CancelNasJobRequest) GetName() string

func (*CancelNasJobRequest) ProtoMessage added in v1.34.0

func (*CancelNasJobRequest) ProtoMessage()

func (*CancelNasJobRequest) ProtoReflect added in v1.34.0

func (x *CancelNasJobRequest) ProtoReflect() protoreflect.Message

func (*CancelNasJobRequest) Reset added in v1.34.0

func (x *CancelNasJobRequest) Reset()

func (*CancelNasJobRequest) String added in v1.34.0

func (x *CancelNasJobRequest) String() string

type CancelPipelineJobRequest

type CancelPipelineJobRequest struct {

	// Required. The name of the PipelineJob to cancel.
	// Format:
	// `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PipelineService.CancelPipelineJob][google.cloud.aiplatform.v1.PipelineService.CancelPipelineJob].

func (*CancelPipelineJobRequest) Descriptor deprecated

func (*CancelPipelineJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelPipelineJobRequest.ProtoReflect.Descriptor instead.

func (*CancelPipelineJobRequest) GetName

func (x *CancelPipelineJobRequest) GetName() string

func (*CancelPipelineJobRequest) ProtoMessage

func (*CancelPipelineJobRequest) ProtoMessage()

func (*CancelPipelineJobRequest) ProtoReflect

func (x *CancelPipelineJobRequest) ProtoReflect() protoreflect.Message

func (*CancelPipelineJobRequest) Reset

func (x *CancelPipelineJobRequest) Reset()

func (*CancelPipelineJobRequest) String

func (x *CancelPipelineJobRequest) String() string

type CancelTrainingPipelineRequest

type CancelTrainingPipelineRequest struct {

	// Required. The name of the TrainingPipeline to cancel.
	// Format:
	// `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PipelineService.CancelTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CancelTrainingPipeline].

func (*CancelTrainingPipelineRequest) Descriptor deprecated

func (*CancelTrainingPipelineRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelTrainingPipelineRequest.ProtoReflect.Descriptor instead.

func (*CancelTrainingPipelineRequest) GetName

func (*CancelTrainingPipelineRequest) ProtoMessage

func (*CancelTrainingPipelineRequest) ProtoMessage()

func (*CancelTrainingPipelineRequest) ProtoReflect

func (*CancelTrainingPipelineRequest) Reset

func (x *CancelTrainingPipelineRequest) Reset()

func (*CancelTrainingPipelineRequest) String

type CancelTuningJobRequest added in v1.67.0

type CancelTuningJobRequest struct {

	// Required. The name of the TuningJob to cancel. Format:
	// `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [GenAiTuningService.CancelTuningJob][google.cloud.aiplatform.v1.GenAiTuningService.CancelTuningJob].

func (*CancelTuningJobRequest) Descriptor deprecated added in v1.67.0

func (*CancelTuningJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelTuningJobRequest.ProtoReflect.Descriptor instead.

func (*CancelTuningJobRequest) GetName added in v1.67.0

func (x *CancelTuningJobRequest) GetName() string

func (*CancelTuningJobRequest) ProtoMessage added in v1.67.0

func (*CancelTuningJobRequest) ProtoMessage()

func (*CancelTuningJobRequest) ProtoReflect added in v1.67.0

func (x *CancelTuningJobRequest) ProtoReflect() protoreflect.Message

func (*CancelTuningJobRequest) Reset added in v1.67.0

func (x *CancelTuningJobRequest) Reset()

func (*CancelTuningJobRequest) String added in v1.67.0

func (x *CancelTuningJobRequest) String() string

type Candidate added in v1.57.0

type Candidate struct {

	// Output only. Index of the candidate.
	Index int32 `protobuf:"varint,1,opt,name=index,proto3" json:"index,omitempty"`
	// Output only. Content parts of the candidate.
	Content *Content `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// Output only. The reason why the model stopped generating tokens.
	// If empty, the model has not stopped generating the tokens.
	FinishReason Candidate_FinishReason `` /* 153-byte string literal not displayed */
	// Output only. List of ratings for the safety of a response candidate.
	//
	// There is at most one rating per category.
	SafetyRatings []*SafetyRating `protobuf:"bytes,4,rep,name=safety_ratings,json=safetyRatings,proto3" json:"safety_ratings,omitempty"`
	// Output only. Describes the reason the mode stopped generating tokens in
	// more detail. This is only filled when `finish_reason` is set.
	FinishMessage *string `protobuf:"bytes,5,opt,name=finish_message,json=finishMessage,proto3,oneof" json:"finish_message,omitempty"`
	// Output only. Source attribution of the generated content.
	CitationMetadata *CitationMetadata `protobuf:"bytes,6,opt,name=citation_metadata,json=citationMetadata,proto3" json:"citation_metadata,omitempty"`
	// Output only. Metadata specifies sources used to ground generated content.
	GroundingMetadata *GroundingMetadata `protobuf:"bytes,7,opt,name=grounding_metadata,json=groundingMetadata,proto3" json:"grounding_metadata,omitempty"`
	// contains filtered or unexported fields
}

A response candidate generated from the model.

func (*Candidate) Descriptor deprecated added in v1.57.0

func (*Candidate) Descriptor() ([]byte, []int)

Deprecated: Use Candidate.ProtoReflect.Descriptor instead.

func (*Candidate) GetCitationMetadata added in v1.57.0

func (x *Candidate) GetCitationMetadata() *CitationMetadata

func (*Candidate) GetContent added in v1.57.0

func (x *Candidate) GetContent() *Content

func (*Candidate) GetFinishMessage added in v1.57.0

func (x *Candidate) GetFinishMessage() string

func (*Candidate) GetFinishReason added in v1.57.0

func (x *Candidate) GetFinishReason() Candidate_FinishReason

func (*Candidate) GetGroundingMetadata added in v1.63.0

func (x *Candidate) GetGroundingMetadata() *GroundingMetadata

func (*Candidate) GetIndex added in v1.57.0

func (x *Candidate) GetIndex() int32

func (*Candidate) GetSafetyRatings added in v1.57.0

func (x *Candidate) GetSafetyRatings() []*SafetyRating

func (*Candidate) ProtoMessage added in v1.57.0

func (*Candidate) ProtoMessage()

func (*Candidate) ProtoReflect added in v1.57.0

func (x *Candidate) ProtoReflect() protoreflect.Message

func (*Candidate) Reset added in v1.57.0

func (x *Candidate) Reset()

func (*Candidate) String added in v1.57.0

func (x *Candidate) String() string

type Candidate_FinishReason added in v1.57.0

type Candidate_FinishReason int32

The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.

const (
	// The finish reason is unspecified.
	Candidate_FINISH_REASON_UNSPECIFIED Candidate_FinishReason = 0
	// Natural stop point of the model or provided stop sequence.
	Candidate_STOP Candidate_FinishReason = 1
	// The maximum number of tokens as specified in the request was reached.
	Candidate_MAX_TOKENS Candidate_FinishReason = 2
	// The token generation was stopped as the response was flagged for safety
	// reasons. NOTE: When streaming the Candidate.content will be empty if
	// content filters blocked the output.
	Candidate_SAFETY Candidate_FinishReason = 3
	// The token generation was stopped as the response was flagged for
	// unauthorized citations.
	Candidate_RECITATION Candidate_FinishReason = 4
	// All other reasons that stopped the token generation
	Candidate_OTHER Candidate_FinishReason = 5
	// The token generation was stopped as the response was flagged for the
	// terms which are included from the terminology blocklist.
	Candidate_BLOCKLIST Candidate_FinishReason = 6
	// The token generation was stopped as the response was flagged for
	// the prohibited contents.
	Candidate_PROHIBITED_CONTENT Candidate_FinishReason = 7
	// The token generation was stopped as the response was flagged for
	// Sensitive Personally Identifiable Information (SPII) contents.
	Candidate_SPII Candidate_FinishReason = 8
)

func (Candidate_FinishReason) Descriptor added in v1.57.0

func (Candidate_FinishReason) Enum added in v1.57.0

func (Candidate_FinishReason) EnumDescriptor deprecated added in v1.57.0

func (Candidate_FinishReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use Candidate_FinishReason.Descriptor instead.

func (Candidate_FinishReason) Number added in v1.57.0

func (Candidate_FinishReason) String added in v1.57.0

func (x Candidate_FinishReason) String() string

func (Candidate_FinishReason) Type added in v1.57.0

type CheckTrialEarlyStoppingStateMetatdata

type CheckTrialEarlyStoppingStateMetatdata struct {

	// Operation metadata for suggesting Trials.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// The name of the Study that the Trial belongs to.
	Study string `protobuf:"bytes,2,opt,name=study,proto3" json:"study,omitempty"`
	// The Trial name.
	Trial string `protobuf:"bytes,3,opt,name=trial,proto3" json:"trial,omitempty"`
	// contains filtered or unexported fields
}

This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.

func (*CheckTrialEarlyStoppingStateMetatdata) Descriptor deprecated

func (*CheckTrialEarlyStoppingStateMetatdata) Descriptor() ([]byte, []int)

Deprecated: Use CheckTrialEarlyStoppingStateMetatdata.ProtoReflect.Descriptor instead.

func (*CheckTrialEarlyStoppingStateMetatdata) GetGenericMetadata

func (*CheckTrialEarlyStoppingStateMetatdata) GetStudy

func (*CheckTrialEarlyStoppingStateMetatdata) GetTrial

func (*CheckTrialEarlyStoppingStateMetatdata) ProtoMessage

func (*CheckTrialEarlyStoppingStateMetatdata) ProtoMessage()

func (*CheckTrialEarlyStoppingStateMetatdata) ProtoReflect

func (*CheckTrialEarlyStoppingStateMetatdata) Reset

func (*CheckTrialEarlyStoppingStateMetatdata) String

type CheckTrialEarlyStoppingStateRequest

type CheckTrialEarlyStoppingStateRequest struct {

	// Required. The Trial's name.
	// Format:
	// `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
	TrialName string `protobuf:"bytes,1,opt,name=trial_name,json=trialName,proto3" json:"trial_name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState].

func (*CheckTrialEarlyStoppingStateRequest) Descriptor deprecated

func (*CheckTrialEarlyStoppingStateRequest) Descriptor() ([]byte, []int)

Deprecated: Use CheckTrialEarlyStoppingStateRequest.ProtoReflect.Descriptor instead.

func (*CheckTrialEarlyStoppingStateRequest) GetTrialName

func (x *CheckTrialEarlyStoppingStateRequest) GetTrialName() string

func (*CheckTrialEarlyStoppingStateRequest) ProtoMessage

func (*CheckTrialEarlyStoppingStateRequest) ProtoMessage()

func (*CheckTrialEarlyStoppingStateRequest) ProtoReflect

func (*CheckTrialEarlyStoppingStateRequest) Reset

func (*CheckTrialEarlyStoppingStateRequest) String

type CheckTrialEarlyStoppingStateResponse

type CheckTrialEarlyStoppingStateResponse struct {

	// True if the Trial should stop.
	ShouldStop bool `protobuf:"varint,1,opt,name=should_stop,json=shouldStop,proto3" json:"should_stop,omitempty"`
	// contains filtered or unexported fields
}

Response message for [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState].

func (*CheckTrialEarlyStoppingStateResponse) Descriptor deprecated

func (*CheckTrialEarlyStoppingStateResponse) Descriptor() ([]byte, []int)

Deprecated: Use CheckTrialEarlyStoppingStateResponse.ProtoReflect.Descriptor instead.

func (*CheckTrialEarlyStoppingStateResponse) GetShouldStop

func (x *CheckTrialEarlyStoppingStateResponse) GetShouldStop() bool

func (*CheckTrialEarlyStoppingStateResponse) ProtoMessage

func (*CheckTrialEarlyStoppingStateResponse) ProtoMessage()

func (*CheckTrialEarlyStoppingStateResponse) ProtoReflect

func (*CheckTrialEarlyStoppingStateResponse) Reset

func (*CheckTrialEarlyStoppingStateResponse) String

type Citation added in v1.57.0

type Citation struct {

	// Output only. Start index into the content.
	StartIndex int32 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
	// Output only. End index into the content.
	EndIndex int32 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
	// Output only. Url reference of the attribution.
	Uri string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
	// Output only. Title of the attribution.
	Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`
	// Output only. License of the attribution.
	License string `protobuf:"bytes,5,opt,name=license,proto3" json:"license,omitempty"`
	// Output only. Publication date of the attribution.
	PublicationDate *date.Date `protobuf:"bytes,6,opt,name=publication_date,json=publicationDate,proto3" json:"publication_date,omitempty"`
	// contains filtered or unexported fields
}

Source attributions for content.

func (*Citation) Descriptor deprecated added in v1.57.0

func (*Citation) Descriptor() ([]byte, []int)

Deprecated: Use Citation.ProtoReflect.Descriptor instead.

func (*Citation) GetEndIndex added in v1.57.0

func (x *Citation) GetEndIndex() int32

func (*Citation) GetLicense added in v1.57.0

func (x *Citation) GetLicense() string

func (*Citation) GetPublicationDate added in v1.57.0

func (x *Citation) GetPublicationDate() *date.Date

func (*Citation) GetStartIndex added in v1.57.0

func (x *Citation) GetStartIndex() int32

func (*Citation) GetTitle added in v1.57.0

func (x *Citation) GetTitle() string

func (*Citation) GetUri added in v1.57.0

func (x *Citation) GetUri() string

func (*Citation) ProtoMessage added in v1.57.0

func (*Citation) ProtoMessage()

func (*Citation) ProtoReflect added in v1.57.0

func (x *Citation) ProtoReflect() protoreflect.Message

func (*Citation) Reset added in v1.57.0

func (x *Citation) Reset()

func (*Citation) String added in v1.57.0

func (x *Citation) String() string

type CitationMetadata added in v1.57.0

type CitationMetadata struct {

	// Output only. List of citations.
	Citations []*Citation `protobuf:"bytes,1,rep,name=citations,proto3" json:"citations,omitempty"`
	// contains filtered or unexported fields
}

A collection of source attributions for a piece of content.

func (*CitationMetadata) Descriptor deprecated added in v1.57.0

func (*CitationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CitationMetadata.ProtoReflect.Descriptor instead.

func (*CitationMetadata) GetCitations added in v1.57.0

func (x *CitationMetadata) GetCitations() []*Citation

func (*CitationMetadata) ProtoMessage added in v1.57.0

func (*CitationMetadata) ProtoMessage()

func (*CitationMetadata) ProtoReflect added in v1.57.0

func (x *CitationMetadata) ProtoReflect() protoreflect.Message

func (*CitationMetadata) Reset added in v1.57.0

func (x *CitationMetadata) Reset()

func (*CitationMetadata) String added in v1.57.0

func (x *CitationMetadata) String() string

type CompleteTrialRequest

type CompleteTrialRequest struct {

	// Required. The Trial's name.
	// Format:
	// `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. If provided, it will be used as the completed Trial's
	// final_measurement; Otherwise, the service will auto-select a
	// previously reported measurement as the final-measurement
	FinalMeasurement *Measurement `protobuf:"bytes,2,opt,name=final_measurement,json=finalMeasurement,proto3" json:"final_measurement,omitempty"`
	// Optional. True if the Trial cannot be run with the given Parameter, and
	// final_measurement will be ignored.
	TrialInfeasible bool `protobuf:"varint,3,opt,name=trial_infeasible,json=trialInfeasible,proto3" json:"trial_infeasible,omitempty"`
	// Optional. A human readable reason why the trial was infeasible. This should
	// only be provided if `trial_infeasible` is true.
	InfeasibleReason string `protobuf:"bytes,4,opt,name=infeasible_reason,json=infeasibleReason,proto3" json:"infeasible_reason,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.CompleteTrial][google.cloud.aiplatform.v1.VizierService.CompleteTrial].

func (*CompleteTrialRequest) Descriptor deprecated

func (*CompleteTrialRequest) Descriptor() ([]byte, []int)

Deprecated: Use CompleteTrialRequest.ProtoReflect.Descriptor instead.

func (*CompleteTrialRequest) GetFinalMeasurement

func (x *CompleteTrialRequest) GetFinalMeasurement() *Measurement

func (*CompleteTrialRequest) GetInfeasibleReason

func (x *CompleteTrialRequest) GetInfeasibleReason() string

func (*CompleteTrialRequest) GetName

func (x *CompleteTrialRequest) GetName() string

func (*CompleteTrialRequest) GetTrialInfeasible

func (x *CompleteTrialRequest) GetTrialInfeasible() bool

func (*CompleteTrialRequest) ProtoMessage

func (*CompleteTrialRequest) ProtoMessage()

func (*CompleteTrialRequest) ProtoReflect

func (x *CompleteTrialRequest) ProtoReflect() protoreflect.Message

func (*CompleteTrialRequest) Reset

func (x *CompleteTrialRequest) Reset()

func (*CompleteTrialRequest) String

func (x *CompleteTrialRequest) String() string

type CompletionStats

type CompletionStats struct {

	// Output only. The number of entities that had been processed successfully.
	SuccessfulCount int64 `protobuf:"varint,1,opt,name=successful_count,json=successfulCount,proto3" json:"successful_count,omitempty"`
	// Output only. The number of entities for which any error was encountered.
	FailedCount int64 `protobuf:"varint,2,opt,name=failed_count,json=failedCount,proto3" json:"failed_count,omitempty"`
	// Output only. In cases when enough errors are encountered a job, pipeline,
	// or operation may be failed as a whole. Below is the number of entities for
	// which the processing had not been finished (either in successful or failed
	// state). Set to -1 if the number is unknown (for example, the operation
	// failed before the total entity number could be collected).
	IncompleteCount int64 `protobuf:"varint,3,opt,name=incomplete_count,json=incompleteCount,proto3" json:"incomplete_count,omitempty"`
	// Output only. The number of the successful forecast points that are
	// generated by the forecasting model. This is ONLY used by the forecasting
	// batch prediction.
	SuccessfulForecastPointCount int64 `` /* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch.

func (*CompletionStats) Descriptor deprecated

func (*CompletionStats) Descriptor() ([]byte, []int)

Deprecated: Use CompletionStats.ProtoReflect.Descriptor instead.

func (*CompletionStats) GetFailedCount

func (x *CompletionStats) GetFailedCount() int64

func (*CompletionStats) GetIncompleteCount

func (x *CompletionStats) GetIncompleteCount() int64

func (*CompletionStats) GetSuccessfulCount

func (x *CompletionStats) GetSuccessfulCount() int64

func (*CompletionStats) GetSuccessfulForecastPointCount

func (x *CompletionStats) GetSuccessfulForecastPointCount() int64

func (*CompletionStats) ProtoMessage

func (*CompletionStats) ProtoMessage()

func (*CompletionStats) ProtoReflect

func (x *CompletionStats) ProtoReflect() protoreflect.Message

func (*CompletionStats) Reset

func (x *CompletionStats) Reset()

func (*CompletionStats) String

func (x *CompletionStats) String() string

type ComputeTokensRequest added in v1.54.0

type ComputeTokensRequest struct {

	// Required. The name of the Endpoint requested to get lists of tokens and
	// token ids.
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Required. The instances that are the input to token computing API call.
	// Schema is identical to the prediction schema of the text model, even for
	// the non-text models, like chat models, or Codey models.
	Instances []*structpb.Value `protobuf:"bytes,2,rep,name=instances,proto3" json:"instances,omitempty"`
	// contains filtered or unexported fields
}

Request message for ComputeTokens RPC call.

func (*ComputeTokensRequest) Descriptor deprecated added in v1.54.0

func (*ComputeTokensRequest) Descriptor() ([]byte, []int)

Deprecated: Use ComputeTokensRequest.ProtoReflect.Descriptor instead.

func (*ComputeTokensRequest) GetEndpoint added in v1.54.0

func (x *ComputeTokensRequest) GetEndpoint() string

func (*ComputeTokensRequest) GetInstances added in v1.54.0

func (x *ComputeTokensRequest) GetInstances() []*structpb.Value

func (*ComputeTokensRequest) ProtoMessage added in v1.54.0

func (*ComputeTokensRequest) ProtoMessage()

func (*ComputeTokensRequest) ProtoReflect added in v1.54.0

func (x *ComputeTokensRequest) ProtoReflect() protoreflect.Message

func (*ComputeTokensRequest) Reset added in v1.54.0

func (x *ComputeTokensRequest) Reset()

func (*ComputeTokensRequest) String added in v1.54.0

func (x *ComputeTokensRequest) String() string

type ComputeTokensResponse added in v1.54.0

type ComputeTokensResponse struct {

	// Lists of tokens info from the input. A ComputeTokensRequest could have
	// multiple instances with a prompt in each instance. We also need to return
	// lists of tokens info for the request with multiple instances.
	TokensInfo []*TokensInfo `protobuf:"bytes,1,rep,name=tokens_info,json=tokensInfo,proto3" json:"tokens_info,omitempty"`
	// contains filtered or unexported fields
}

Response message for ComputeTokens RPC call.

func (*ComputeTokensResponse) Descriptor deprecated added in v1.54.0

func (*ComputeTokensResponse) Descriptor() ([]byte, []int)

Deprecated: Use ComputeTokensResponse.ProtoReflect.Descriptor instead.

func (*ComputeTokensResponse) GetTokensInfo added in v1.54.0

func (x *ComputeTokensResponse) GetTokensInfo() []*TokensInfo

func (*ComputeTokensResponse) ProtoMessage added in v1.54.0

func (*ComputeTokensResponse) ProtoMessage()

func (*ComputeTokensResponse) ProtoReflect added in v1.54.0

func (x *ComputeTokensResponse) ProtoReflect() protoreflect.Message

func (*ComputeTokensResponse) Reset added in v1.54.0

func (x *ComputeTokensResponse) Reset()

func (*ComputeTokensResponse) String added in v1.54.0

func (x *ComputeTokensResponse) String() string

type ContainerRegistryDestination

type ContainerRegistryDestination struct {

	// Required. Container Registry URI of a container image.
	// Only Google Container Registry and Artifact Registry are supported now.
	// Accepted forms:
	//
	//   - Google Container Registry path. For example:
	//     `gcr.io/projectId/imageName:tag`.
	//
	//   - Artifact Registry path. For example:
	//     `us-central1-docker.pkg.dev/projectId/repoName/imageName:tag`.
	//
	// If a tag is not specified, "latest" will be used as the default tag.
	OutputUri string `protobuf:"bytes,1,opt,name=output_uri,json=outputUri,proto3" json:"output_uri,omitempty"`
	// contains filtered or unexported fields
}

The Container Registry location for the container image.

func (*ContainerRegistryDestination) Descriptor deprecated

func (*ContainerRegistryDestination) Descriptor() ([]byte, []int)

Deprecated: Use ContainerRegistryDestination.ProtoReflect.Descriptor instead.

func (*ContainerRegistryDestination) GetOutputUri

func (x *ContainerRegistryDestination) GetOutputUri() string

func (*ContainerRegistryDestination) ProtoMessage

func (*ContainerRegistryDestination) ProtoMessage()

func (*ContainerRegistryDestination) ProtoReflect

func (*ContainerRegistryDestination) Reset

func (x *ContainerRegistryDestination) Reset()

func (*ContainerRegistryDestination) String

type ContainerSpec

type ContainerSpec struct {

	// Required. The URI of a container image in the Container Registry that is to
	// be run on each worker replica.
	ImageUri string `protobuf:"bytes,1,opt,name=image_uri,json=imageUri,proto3" json:"image_uri,omitempty"`
	// The command to be invoked when the container is started.
	// It overrides the entrypoint instruction in Dockerfile when provided.
	Command []string `protobuf:"bytes,2,rep,name=command,proto3" json:"command,omitempty"`
	// The arguments to be passed when starting the container.
	Args []string `protobuf:"bytes,3,rep,name=args,proto3" json:"args,omitempty"`
	// Environment variables to be passed to the container.
	// Maximum limit is 100.
	Env []*EnvVar `protobuf:"bytes,4,rep,name=env,proto3" json:"env,omitempty"`
	// contains filtered or unexported fields
}

The spec of a Container.

func (*ContainerSpec) Descriptor deprecated

func (*ContainerSpec) Descriptor() ([]byte, []int)

Deprecated: Use ContainerSpec.ProtoReflect.Descriptor instead.

func (*ContainerSpec) GetArgs

func (x *ContainerSpec) GetArgs() []string

func (*ContainerSpec) GetCommand

func (x *ContainerSpec) GetCommand() []string

func (*ContainerSpec) GetEnv

func (x *ContainerSpec) GetEnv() []*EnvVar

func (*ContainerSpec) GetImageUri

func (x *ContainerSpec) GetImageUri() string

func (*ContainerSpec) ProtoMessage

func (*ContainerSpec) ProtoMessage()

func (*ContainerSpec) ProtoReflect

func (x *ContainerSpec) ProtoReflect() protoreflect.Message

func (*ContainerSpec) Reset

func (x *ContainerSpec) Reset()

func (*ContainerSpec) String

func (x *ContainerSpec) String() string

type Content added in v1.57.0

type Content struct {

	// Optional. The producer of the content. Must be either 'user' or 'model'.
	//
	// Useful to set for multi-turn conversations, otherwise can be left blank
	// or unset.
	Role string `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`
	// Required. Ordered `Parts` that constitute a single message. Parts may have
	// different IANA MIME types.
	Parts []*Part `protobuf:"bytes,2,rep,name=parts,proto3" json:"parts,omitempty"`
	// contains filtered or unexported fields
}

The base structured datatype containing multi-part content of a message.

A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.

func (*Content) Descriptor deprecated added in v1.57.0

func (*Content) Descriptor() ([]byte, []int)

Deprecated: Use Content.ProtoReflect.Descriptor instead.

func (*Content) GetParts added in v1.57.0

func (x *Content) GetParts() []*Part

func (*Content) GetRole added in v1.57.0

func (x *Content) GetRole() string

func (*Content) ProtoMessage added in v1.57.0

func (*Content) ProtoMessage()

func (*Content) ProtoReflect added in v1.57.0

func (x *Content) ProtoReflect() protoreflect.Message

func (*Content) Reset added in v1.57.0

func (x *Content) Reset()

func (*Content) String added in v1.57.0

func (x *Content) String() string

type Context

type Context struct {

	// Immutable. The resource name of the Context.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// User provided display name of the Context.
	// May be up to 128 Unicode characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// An eTag used to perform consistent read-modify-write updates. If not set, a
	// blind "overwrite" update happens.
	Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
	// The labels with user-defined metadata to organize your Contexts.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one Context (System
	// labels are excluded).
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Output only. Timestamp when this Context was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Context was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. A list of resource names of Contexts that are parents of this
	// Context. A Context may have at most 10 parent_contexts.
	ParentContexts []string `protobuf:"bytes,12,rep,name=parent_contexts,json=parentContexts,proto3" json:"parent_contexts,omitempty"`
	// The title of the schema describing the metadata.
	//
	// Schema title and version is expected to be registered in earlier Create
	// Schema calls. And both are used together as unique identifiers to identify
	// schemas within the local metadata store.
	SchemaTitle string `protobuf:"bytes,13,opt,name=schema_title,json=schemaTitle,proto3" json:"schema_title,omitempty"`
	// The version of the schema in schema_name to use.
	//
	// Schema title and version is expected to be registered in earlier Create
	// Schema calls. And both are used together as unique identifiers to identify
	// schemas within the local metadata store.
	SchemaVersion string `protobuf:"bytes,14,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`
	// Properties of the Context.
	// Top level metadata keys' heading and trailing spaces will be trimmed.
	// The size of this field should not exceed 200KB.
	Metadata *structpb.Struct `protobuf:"bytes,15,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Description of the Context
	Description string `protobuf:"bytes,16,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Instance of a general context.

func (*Context) Descriptor deprecated

func (*Context) Descriptor() ([]byte, []int)

Deprecated: Use Context.ProtoReflect.Descriptor instead.

func (*Context) GetCreateTime

func (x *Context) GetCreateTime() *timestamppb.Timestamp

func (*Context) GetDescription

func (x *Context) GetDescription() string

func (*Context) GetDisplayName

func (x *Context) GetDisplayName() string

func (*Context) GetEtag

func (x *Context) GetEtag() string

func (*Context) GetLabels

func (x *Context) GetLabels() map[string]string

func (*Context) GetMetadata

func (x *Context) GetMetadata() *structpb.Struct

func (*Context) GetName

func (x *Context) GetName() string

func (*Context) GetParentContexts

func (x *Context) GetParentContexts() []string

func (*Context) GetSchemaTitle

func (x *Context) GetSchemaTitle() string

func (*Context) GetSchemaVersion

func (x *Context) GetSchemaVersion() string

func (*Context) GetUpdateTime

func (x *Context) GetUpdateTime() *timestamppb.Timestamp

func (*Context) ProtoMessage

func (*Context) ProtoMessage()

func (*Context) ProtoReflect

func (x *Context) ProtoReflect() protoreflect.Message

func (*Context) Reset

func (x *Context) Reset()

func (*Context) String

func (x *Context) String() string

type CopyModelOperationMetadata added in v1.34.0

type CopyModelOperationMetadata struct {

	// The common part of the operation metadata.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of [ModelService.CopyModel][google.cloud.aiplatform.v1.ModelService.CopyModel] operation.

func (*CopyModelOperationMetadata) Descriptor deprecated added in v1.34.0

func (*CopyModelOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CopyModelOperationMetadata.ProtoReflect.Descriptor instead.

func (*CopyModelOperationMetadata) GetGenericMetadata added in v1.34.0

func (x *CopyModelOperationMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*CopyModelOperationMetadata) ProtoMessage added in v1.34.0

func (*CopyModelOperationMetadata) ProtoMessage()

func (*CopyModelOperationMetadata) ProtoReflect added in v1.34.0

func (*CopyModelOperationMetadata) Reset added in v1.34.0

func (x *CopyModelOperationMetadata) Reset()

func (*CopyModelOperationMetadata) String added in v1.34.0

func (x *CopyModelOperationMetadata) String() string

type CopyModelRequest added in v1.34.0

type CopyModelRequest struct {

	// If both fields are unset, a new Model will be created with a generated ID.
	//
	// Types that are assignable to DestinationModel:
	//
	//	*CopyModelRequest_ModelId
	//	*CopyModelRequest_ParentModel
	DestinationModel isCopyModelRequest_DestinationModel `protobuf_oneof:"destination_model"`
	// Required. The resource name of the Location into which to copy the Model.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The resource name of the Model to copy. That Model must be in the
	// same Project. Format:
	// `projects/{project}/locations/{location}/models/{model}`
	SourceModel string `protobuf:"bytes,2,opt,name=source_model,json=sourceModel,proto3" json:"source_model,omitempty"`
	// Customer-managed encryption key options. If this is set,
	// then the Model copy will be encrypted with the provided encryption key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,3,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.CopyModel][google.cloud.aiplatform.v1.ModelService.CopyModel].

func (*CopyModelRequest) Descriptor deprecated added in v1.34.0

func (*CopyModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use CopyModelRequest.ProtoReflect.Descriptor instead.

func (*CopyModelRequest) GetDestinationModel added in v1.34.0

func (m *CopyModelRequest) GetDestinationModel() isCopyModelRequest_DestinationModel

func (*CopyModelRequest) GetEncryptionSpec added in v1.34.0

func (x *CopyModelRequest) GetEncryptionSpec() *EncryptionSpec

func (*CopyModelRequest) GetModelId added in v1.34.0

func (x *CopyModelRequest) GetModelId() string

func (*CopyModelRequest) GetParent added in v1.34.0

func (x *CopyModelRequest) GetParent() string

func (*CopyModelRequest) GetParentModel added in v1.34.0

func (x *CopyModelRequest) GetParentModel() string

func (*CopyModelRequest) GetSourceModel added in v1.34.0

func (x *CopyModelRequest) GetSourceModel() string

func (*CopyModelRequest) ProtoMessage added in v1.34.0

func (*CopyModelRequest) ProtoMessage()

func (*CopyModelRequest) ProtoReflect added in v1.34.0

func (x *CopyModelRequest) ProtoReflect() protoreflect.Message

func (*CopyModelRequest) Reset added in v1.34.0

func (x *CopyModelRequest) Reset()

func (*CopyModelRequest) String added in v1.34.0

func (x *CopyModelRequest) String() string

type CopyModelRequest_ModelId added in v1.34.0

type CopyModelRequest_ModelId struct {
	// Optional. Copy source_model into a new Model with this ID. The ID will
	// become the final component of the model resource name.
	//
	// This value may be up to 63 characters, and valid characters are
	// `[a-z0-9_-]`. The first character cannot be a number or hyphen.
	ModelId string `protobuf:"bytes,4,opt,name=model_id,json=modelId,proto3,oneof"`
}

type CopyModelRequest_ParentModel added in v1.34.0

type CopyModelRequest_ParentModel struct {
	// Optional. Specify this field to copy source_model into this existing
	// Model as a new version. Format:
	// `projects/{project}/locations/{location}/models/{model}`
	ParentModel string `protobuf:"bytes,5,opt,name=parent_model,json=parentModel,proto3,oneof"`
}

type CopyModelResponse added in v1.34.0

type CopyModelResponse struct {

	// The name of the copied Model resource.
	// Format: `projects/{project}/locations/{location}/models/{model}`
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Output only. The version ID of the model that is copied.
	ModelVersionId string `protobuf:"bytes,2,opt,name=model_version_id,json=modelVersionId,proto3" json:"model_version_id,omitempty"`
	// contains filtered or unexported fields
}

Response message of [ModelService.CopyModel][google.cloud.aiplatform.v1.ModelService.CopyModel] operation.

func (*CopyModelResponse) Descriptor deprecated added in v1.34.0

func (*CopyModelResponse) Descriptor() ([]byte, []int)

Deprecated: Use CopyModelResponse.ProtoReflect.Descriptor instead.

func (*CopyModelResponse) GetModel added in v1.34.0

func (x *CopyModelResponse) GetModel() string

func (*CopyModelResponse) GetModelVersionId added in v1.34.0

func (x *CopyModelResponse) GetModelVersionId() string

func (*CopyModelResponse) ProtoMessage added in v1.34.0

func (*CopyModelResponse) ProtoMessage()

func (*CopyModelResponse) ProtoReflect added in v1.34.0

func (x *CopyModelResponse) ProtoReflect() protoreflect.Message

func (*CopyModelResponse) Reset added in v1.34.0

func (x *CopyModelResponse) Reset()

func (*CopyModelResponse) String added in v1.34.0

func (x *CopyModelResponse) String() string

type CountTokensRequest added in v1.54.0

type CountTokensRequest struct {

	// Required. The name of the Endpoint requested to perform token counting.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Required. The name of the publisher model requested to serve the
	// prediction. Format:
	// `projects/{project}/locations/{location}/publishers/*/models/*`
	Model string `protobuf:"bytes,3,opt,name=model,proto3" json:"model,omitempty"`
	// Required. The instances that are the input to token counting call.
	// Schema is identical to the prediction schema of the underlying model.
	Instances []*structpb.Value `protobuf:"bytes,2,rep,name=instances,proto3" json:"instances,omitempty"`
	// Required. Input content.
	Contents []*Content `protobuf:"bytes,4,rep,name=contents,proto3" json:"contents,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.CountTokens][].

func (*CountTokensRequest) Descriptor deprecated added in v1.54.0

func (*CountTokensRequest) Descriptor() ([]byte, []int)

Deprecated: Use CountTokensRequest.ProtoReflect.Descriptor instead.

func (*CountTokensRequest) GetContents added in v1.57.0

func (x *CountTokensRequest) GetContents() []*Content

func (*CountTokensRequest) GetEndpoint added in v1.54.0

func (x *CountTokensRequest) GetEndpoint() string

func (*CountTokensRequest) GetInstances added in v1.54.0

func (x *CountTokensRequest) GetInstances() []*structpb.Value

func (*CountTokensRequest) GetModel added in v1.57.0

func (x *CountTokensRequest) GetModel() string

func (*CountTokensRequest) ProtoMessage added in v1.54.0

func (*CountTokensRequest) ProtoMessage()

func (*CountTokensRequest) ProtoReflect added in v1.54.0

func (x *CountTokensRequest) ProtoReflect() protoreflect.Message

func (*CountTokensRequest) Reset added in v1.54.0

func (x *CountTokensRequest) Reset()

func (*CountTokensRequest) String added in v1.54.0

func (x *CountTokensRequest) String() string

type CountTokensResponse added in v1.54.0

type CountTokensResponse struct {

	// The total number of tokens counted across all instances from the request.
	TotalTokens int32 `protobuf:"varint,1,opt,name=total_tokens,json=totalTokens,proto3" json:"total_tokens,omitempty"`
	// The total number of billable characters counted across all instances from
	// the request.
	TotalBillableCharacters int32 `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message for [PredictionService.CountTokens][].

func (*CountTokensResponse) Descriptor deprecated added in v1.54.0

func (*CountTokensResponse) Descriptor() ([]byte, []int)

Deprecated: Use CountTokensResponse.ProtoReflect.Descriptor instead.

func (*CountTokensResponse) GetTotalBillableCharacters added in v1.54.0

func (x *CountTokensResponse) GetTotalBillableCharacters() int32

func (*CountTokensResponse) GetTotalTokens added in v1.54.0

func (x *CountTokensResponse) GetTotalTokens() int32

func (*CountTokensResponse) ProtoMessage added in v1.54.0

func (*CountTokensResponse) ProtoMessage()

func (*CountTokensResponse) ProtoReflect added in v1.54.0

func (x *CountTokensResponse) ProtoReflect() protoreflect.Message

func (*CountTokensResponse) Reset added in v1.54.0

func (x *CountTokensResponse) Reset()

func (*CountTokensResponse) String added in v1.54.0

func (x *CountTokensResponse) String() string

type CreateArtifactRequest

type CreateArtifactRequest struct {

	// Required. The resource name of the MetadataStore where the Artifact should
	// be created.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Artifact to create.
	Artifact *Artifact `protobuf:"bytes,2,opt,name=artifact,proto3" json:"artifact,omitempty"`
	// The {artifact} portion of the resource name with the format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
	// If not provided, the Artifact's ID will be a UUID generated by the service.
	// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
	// Must be unique across all Artifacts in the parent MetadataStore. (Otherwise
	// the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the
	// caller can't view the preexisting Artifact.)
	ArtifactId string `protobuf:"bytes,3,opt,name=artifact_id,json=artifactId,proto3" json:"artifact_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.CreateArtifact][google.cloud.aiplatform.v1.MetadataService.CreateArtifact].

func (*CreateArtifactRequest) Descriptor deprecated

func (*CreateArtifactRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateArtifactRequest.ProtoReflect.Descriptor instead.

func (*CreateArtifactRequest) GetArtifact

func (x *CreateArtifactRequest) GetArtifact() *Artifact

func (*CreateArtifactRequest) GetArtifactId

func (x *CreateArtifactRequest) GetArtifactId() string

func (*CreateArtifactRequest) GetParent

func (x *CreateArtifactRequest) GetParent() string

func (*CreateArtifactRequest) ProtoMessage

func (*CreateArtifactRequest) ProtoMessage()

func (*CreateArtifactRequest) ProtoReflect

func (x *CreateArtifactRequest) ProtoReflect() protoreflect.Message

func (*CreateArtifactRequest) Reset

func (x *CreateArtifactRequest) Reset()

func (*CreateArtifactRequest) String

func (x *CreateArtifactRequest) String() string

type CreateBatchPredictionJobRequest

type CreateBatchPredictionJobRequest struct {

	// Required. The resource name of the Location to create the
	// BatchPredictionJob in. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The BatchPredictionJob to create.
	BatchPredictionJob *BatchPredictionJob `protobuf:"bytes,2,opt,name=batch_prediction_job,json=batchPredictionJob,proto3" json:"batch_prediction_job,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob].

func (*CreateBatchPredictionJobRequest) Descriptor deprecated

func (*CreateBatchPredictionJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateBatchPredictionJobRequest.ProtoReflect.Descriptor instead.

func (*CreateBatchPredictionJobRequest) GetBatchPredictionJob

func (x *CreateBatchPredictionJobRequest) GetBatchPredictionJob() *BatchPredictionJob

func (*CreateBatchPredictionJobRequest) GetParent

func (x *CreateBatchPredictionJobRequest) GetParent() string

func (*CreateBatchPredictionJobRequest) ProtoMessage

func (*CreateBatchPredictionJobRequest) ProtoMessage()

func (*CreateBatchPredictionJobRequest) ProtoReflect

func (*CreateBatchPredictionJobRequest) Reset

func (*CreateBatchPredictionJobRequest) String

type CreateContextRequest

type CreateContextRequest struct {

	// Required. The resource name of the MetadataStore where the Context should
	// be created. Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Context to create.
	Context *Context `protobuf:"bytes,2,opt,name=context,proto3" json:"context,omitempty"`
	// The {context} portion of the resource name with the format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`.
	// If not provided, the Context's ID will be a UUID generated by the service.
	// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
	// Must be unique across all Contexts in the parent MetadataStore. (Otherwise
	// the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the
	// caller can't view the preexisting Context.)
	ContextId string `protobuf:"bytes,3,opt,name=context_id,json=contextId,proto3" json:"context_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.CreateContext][google.cloud.aiplatform.v1.MetadataService.CreateContext].

func (*CreateContextRequest) Descriptor deprecated

func (*CreateContextRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateContextRequest.ProtoReflect.Descriptor instead.

func (*CreateContextRequest) GetContext

func (x *CreateContextRequest) GetContext() *Context

func (*CreateContextRequest) GetContextId

func (x *CreateContextRequest) GetContextId() string

func (*CreateContextRequest) GetParent

func (x *CreateContextRequest) GetParent() string

func (*CreateContextRequest) ProtoMessage

func (*CreateContextRequest) ProtoMessage()

func (*CreateContextRequest) ProtoReflect

func (x *CreateContextRequest) ProtoReflect() protoreflect.Message

func (*CreateContextRequest) Reset

func (x *CreateContextRequest) Reset()

func (*CreateContextRequest) String

func (x *CreateContextRequest) String() string

type CreateCustomJobRequest

type CreateCustomJobRequest struct {

	// Required. The resource name of the Location to create the CustomJob in.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The CustomJob to create.
	CustomJob *CustomJob `protobuf:"bytes,2,opt,name=custom_job,json=customJob,proto3" json:"custom_job,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.CreateCustomJob][google.cloud.aiplatform.v1.JobService.CreateCustomJob].

func (*CreateCustomJobRequest) Descriptor deprecated

func (*CreateCustomJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateCustomJobRequest.ProtoReflect.Descriptor instead.

func (*CreateCustomJobRequest) GetCustomJob

func (x *CreateCustomJobRequest) GetCustomJob() *CustomJob

func (*CreateCustomJobRequest) GetParent

func (x *CreateCustomJobRequest) GetParent() string

func (*CreateCustomJobRequest) ProtoMessage

func (*CreateCustomJobRequest) ProtoMessage()

func (*CreateCustomJobRequest) ProtoReflect

func (x *CreateCustomJobRequest) ProtoReflect() protoreflect.Message

func (*CreateCustomJobRequest) Reset

func (x *CreateCustomJobRequest) Reset()

func (*CreateCustomJobRequest) String

func (x *CreateCustomJobRequest) String() string

type CreateDataLabelingJobRequest

type CreateDataLabelingJobRequest struct {

	// Required. The parent of the DataLabelingJob.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The DataLabelingJob to create.
	DataLabelingJob *DataLabelingJob `protobuf:"bytes,2,opt,name=data_labeling_job,json=dataLabelingJob,proto3" json:"data_labeling_job,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob].

func (*CreateDataLabelingJobRequest) Descriptor deprecated

func (*CreateDataLabelingJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDataLabelingJobRequest.ProtoReflect.Descriptor instead.

func (*CreateDataLabelingJobRequest) GetDataLabelingJob

func (x *CreateDataLabelingJobRequest) GetDataLabelingJob() *DataLabelingJob

func (*CreateDataLabelingJobRequest) GetParent

func (x *CreateDataLabelingJobRequest) GetParent() string

func (*CreateDataLabelingJobRequest) ProtoMessage

func (*CreateDataLabelingJobRequest) ProtoMessage()

func (*CreateDataLabelingJobRequest) ProtoReflect

func (*CreateDataLabelingJobRequest) Reset

func (x *CreateDataLabelingJobRequest) Reset()

func (*CreateDataLabelingJobRequest) String

type CreateDatasetOperationMetadata

type CreateDatasetOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset].

func (*CreateDatasetOperationMetadata) Descriptor deprecated

func (*CreateDatasetOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateDatasetOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateDatasetOperationMetadata) GetGenericMetadata

func (*CreateDatasetOperationMetadata) ProtoMessage

func (*CreateDatasetOperationMetadata) ProtoMessage()

func (*CreateDatasetOperationMetadata) ProtoReflect

func (*CreateDatasetOperationMetadata) Reset

func (x *CreateDatasetOperationMetadata) Reset()

func (*CreateDatasetOperationMetadata) String

type CreateDatasetRequest

type CreateDatasetRequest struct {

	// Required. The resource name of the Location to create the Dataset in.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Dataset to create.
	Dataset *Dataset `protobuf:"bytes,2,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset].

func (*CreateDatasetRequest) Descriptor deprecated

func (*CreateDatasetRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDatasetRequest.ProtoReflect.Descriptor instead.

func (*CreateDatasetRequest) GetDataset

func (x *CreateDatasetRequest) GetDataset() *Dataset

func (*CreateDatasetRequest) GetParent

func (x *CreateDatasetRequest) GetParent() string

func (*CreateDatasetRequest) ProtoMessage

func (*CreateDatasetRequest) ProtoMessage()

func (*CreateDatasetRequest) ProtoReflect

func (x *CreateDatasetRequest) ProtoReflect() protoreflect.Message

func (*CreateDatasetRequest) Reset

func (x *CreateDatasetRequest) Reset()

func (*CreateDatasetRequest) String

func (x *CreateDatasetRequest) String() string

type CreateDatasetVersionOperationMetadata added in v1.49.0

type CreateDatasetVersionOperationMetadata struct {

	// The common part of the operation metadata.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [DatasetService.CreateDatasetVersion][google.cloud.aiplatform.v1.DatasetService.CreateDatasetVersion].

func (*CreateDatasetVersionOperationMetadata) Descriptor deprecated added in v1.49.0

func (*CreateDatasetVersionOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateDatasetVersionOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateDatasetVersionOperationMetadata) GetGenericMetadata added in v1.49.0

func (*CreateDatasetVersionOperationMetadata) ProtoMessage added in v1.49.0

func (*CreateDatasetVersionOperationMetadata) ProtoMessage()

func (*CreateDatasetVersionOperationMetadata) ProtoReflect added in v1.49.0

func (*CreateDatasetVersionOperationMetadata) Reset added in v1.49.0

func (*CreateDatasetVersionOperationMetadata) String added in v1.49.0

type CreateDatasetVersionRequest added in v1.51.0

type CreateDatasetVersionRequest struct {

	// Required. The name of the Dataset resource.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The version to be created. The same CMEK policies with the
	// original Dataset will be applied the dataset version. So here we don't need
	// to specify the EncryptionSpecType here.
	DatasetVersion *DatasetVersion `protobuf:"bytes,2,opt,name=dataset_version,json=datasetVersion,proto3" json:"dataset_version,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.CreateDatasetVersion][google.cloud.aiplatform.v1.DatasetService.CreateDatasetVersion].

func (*CreateDatasetVersionRequest) Descriptor deprecated added in v1.51.0

func (*CreateDatasetVersionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDatasetVersionRequest.ProtoReflect.Descriptor instead.

func (*CreateDatasetVersionRequest) GetDatasetVersion added in v1.51.0

func (x *CreateDatasetVersionRequest) GetDatasetVersion() *DatasetVersion

func (*CreateDatasetVersionRequest) GetParent added in v1.51.0

func (x *CreateDatasetVersionRequest) GetParent() string

func (*CreateDatasetVersionRequest) ProtoMessage added in v1.51.0

func (*CreateDatasetVersionRequest) ProtoMessage()

func (*CreateDatasetVersionRequest) ProtoReflect added in v1.51.0

func (*CreateDatasetVersionRequest) Reset added in v1.51.0

func (x *CreateDatasetVersionRequest) Reset()

func (*CreateDatasetVersionRequest) String added in v1.51.0

func (x *CreateDatasetVersionRequest) String() string

type CreateDeploymentResourcePoolOperationMetadata added in v1.57.0

type CreateDeploymentResourcePoolOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for CreateDeploymentResourcePool method.

func (*CreateDeploymentResourcePoolOperationMetadata) Descriptor deprecated added in v1.57.0

Deprecated: Use CreateDeploymentResourcePoolOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateDeploymentResourcePoolOperationMetadata) GetGenericMetadata added in v1.57.0

func (*CreateDeploymentResourcePoolOperationMetadata) ProtoMessage added in v1.57.0

func (*CreateDeploymentResourcePoolOperationMetadata) ProtoReflect added in v1.57.0

func (*CreateDeploymentResourcePoolOperationMetadata) Reset added in v1.57.0

func (*CreateDeploymentResourcePoolOperationMetadata) String added in v1.57.0

type CreateDeploymentResourcePoolRequest added in v1.57.0

type CreateDeploymentResourcePoolRequest struct {

	// Required. The parent location resource where this DeploymentResourcePool
	// will be created. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The DeploymentResourcePool to create.
	DeploymentResourcePool *DeploymentResourcePool `` /* 129-byte string literal not displayed */
	// Required. The ID to use for the DeploymentResourcePool, which
	// will become the final component of the DeploymentResourcePool's resource
	// name.
	//
	// The maximum length is 63 characters, and valid characters
	// are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
	DeploymentResourcePoolId string `` /* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for CreateDeploymentResourcePool method.

func (*CreateDeploymentResourcePoolRequest) Descriptor deprecated added in v1.57.0

func (*CreateDeploymentResourcePoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDeploymentResourcePoolRequest.ProtoReflect.Descriptor instead.

func (*CreateDeploymentResourcePoolRequest) GetDeploymentResourcePool added in v1.57.0

func (x *CreateDeploymentResourcePoolRequest) GetDeploymentResourcePool() *DeploymentResourcePool

func (*CreateDeploymentResourcePoolRequest) GetDeploymentResourcePoolId added in v1.57.0

func (x *CreateDeploymentResourcePoolRequest) GetDeploymentResourcePoolId() string

func (*CreateDeploymentResourcePoolRequest) GetParent added in v1.57.0

func (*CreateDeploymentResourcePoolRequest) ProtoMessage added in v1.57.0

func (*CreateDeploymentResourcePoolRequest) ProtoMessage()

func (*CreateDeploymentResourcePoolRequest) ProtoReflect added in v1.57.0

func (*CreateDeploymentResourcePoolRequest) Reset added in v1.57.0

func (*CreateDeploymentResourcePoolRequest) String added in v1.57.0

type CreateEndpointOperationMetadata

type CreateEndpointOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint].

func (*CreateEndpointOperationMetadata) Descriptor deprecated

func (*CreateEndpointOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateEndpointOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateEndpointOperationMetadata) GetGenericMetadata

func (*CreateEndpointOperationMetadata) ProtoMessage

func (*CreateEndpointOperationMetadata) ProtoMessage()

func (*CreateEndpointOperationMetadata) ProtoReflect

func (*CreateEndpointOperationMetadata) Reset

func (*CreateEndpointOperationMetadata) String

type CreateEndpointRequest

type CreateEndpointRequest struct {

	// Required. The resource name of the Location to create the Endpoint in.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Endpoint to create.
	Endpoint *Endpoint `protobuf:"bytes,2,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Immutable. The ID to use for endpoint, which will become the final
	// component of the endpoint resource name.
	// If not provided, Vertex AI will generate a value for this ID.
	//
	// If the first character is a letter, this value may be up to 63 characters,
	// and valid characters are `[a-z0-9-]`. The last character must be a letter
	// or number.
	//
	// If the first character is a number, this value may be up to 9 characters,
	// and valid characters are `[0-9]` with no leading zeros.
	//
	// When using HTTP/JSON, this field is populated
	// based on a query string argument, such as `?endpoint_id=12345`. This is the
	// fallback for fields that are not included in either the URI or the body.
	EndpointId string `protobuf:"bytes,4,opt,name=endpoint_id,json=endpointId,proto3" json:"endpoint_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint].

func (*CreateEndpointRequest) Descriptor deprecated

func (*CreateEndpointRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateEndpointRequest.ProtoReflect.Descriptor instead.

func (*CreateEndpointRequest) GetEndpoint

func (x *CreateEndpointRequest) GetEndpoint() *Endpoint

func (*CreateEndpointRequest) GetEndpointId

func (x *CreateEndpointRequest) GetEndpointId() string

func (*CreateEndpointRequest) GetParent

func (x *CreateEndpointRequest) GetParent() string

func (*CreateEndpointRequest) ProtoMessage

func (*CreateEndpointRequest) ProtoMessage()

func (*CreateEndpointRequest) ProtoReflect

func (x *CreateEndpointRequest) ProtoReflect() protoreflect.Message

func (*CreateEndpointRequest) Reset

func (x *CreateEndpointRequest) Reset()

func (*CreateEndpointRequest) String

func (x *CreateEndpointRequest) String() string

type CreateEntityTypeOperationMetadata

type CreateEntityTypeOperationMetadata struct {

	// Operation metadata for EntityType.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform create EntityType.

func (*CreateEntityTypeOperationMetadata) Descriptor deprecated

func (*CreateEntityTypeOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateEntityTypeOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateEntityTypeOperationMetadata) GetGenericMetadata

func (*CreateEntityTypeOperationMetadata) ProtoMessage

func (*CreateEntityTypeOperationMetadata) ProtoMessage()

func (*CreateEntityTypeOperationMetadata) ProtoReflect

func (*CreateEntityTypeOperationMetadata) Reset

func (*CreateEntityTypeOperationMetadata) String

type CreateEntityTypeRequest

type CreateEntityTypeRequest struct {

	// Required. The resource name of the Featurestore to create EntityTypes.
	// Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The EntityType to create.
	EntityType *EntityType `protobuf:"bytes,2,opt,name=entity_type,json=entityType,proto3" json:"entity_type,omitempty"`
	// Required. The ID to use for the EntityType, which will become the final
	// component of the EntityType's resource name.
	//
	// This value may be up to 60 characters, and valid characters are
	// `[a-z0-9_]`. The first character cannot be a number.
	//
	// The value must be unique within a featurestore.
	EntityTypeId string `protobuf:"bytes,3,opt,name=entity_type_id,json=entityTypeId,proto3" json:"entity_type_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.CreateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.CreateEntityType].

func (*CreateEntityTypeRequest) Descriptor deprecated

func (*CreateEntityTypeRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateEntityTypeRequest.ProtoReflect.Descriptor instead.

func (*CreateEntityTypeRequest) GetEntityType

func (x *CreateEntityTypeRequest) GetEntityType() *EntityType

func (*CreateEntityTypeRequest) GetEntityTypeId

func (x *CreateEntityTypeRequest) GetEntityTypeId() string

func (*CreateEntityTypeRequest) GetParent

func (x *CreateEntityTypeRequest) GetParent() string

func (*CreateEntityTypeRequest) ProtoMessage

func (*CreateEntityTypeRequest) ProtoMessage()

func (*CreateEntityTypeRequest) ProtoReflect

func (x *CreateEntityTypeRequest) ProtoReflect() protoreflect.Message

func (*CreateEntityTypeRequest) Reset

func (x *CreateEntityTypeRequest) Reset()

func (*CreateEntityTypeRequest) String

func (x *CreateEntityTypeRequest) String() string

type CreateExecutionRequest

type CreateExecutionRequest struct {

	// Required. The resource name of the MetadataStore where the Execution should
	// be created.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Execution to create.
	Execution *Execution `protobuf:"bytes,2,opt,name=execution,proto3" json:"execution,omitempty"`
	// The {execution} portion of the resource name with the format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
	// If not provided, the Execution's ID will be a UUID generated by the
	// service.
	// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
	// Must be unique across all Executions in the parent MetadataStore.
	// (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
	// if the caller can't view the preexisting Execution.)
	ExecutionId string `protobuf:"bytes,3,opt,name=execution_id,json=executionId,proto3" json:"execution_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.CreateExecution][google.cloud.aiplatform.v1.MetadataService.CreateExecution].

func (*CreateExecutionRequest) Descriptor deprecated

func (*CreateExecutionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateExecutionRequest.ProtoReflect.Descriptor instead.

func (*CreateExecutionRequest) GetExecution

func (x *CreateExecutionRequest) GetExecution() *Execution

func (*CreateExecutionRequest) GetExecutionId

func (x *CreateExecutionRequest) GetExecutionId() string

func (*CreateExecutionRequest) GetParent

func (x *CreateExecutionRequest) GetParent() string

func (*CreateExecutionRequest) ProtoMessage

func (*CreateExecutionRequest) ProtoMessage()

func (*CreateExecutionRequest) ProtoReflect

func (x *CreateExecutionRequest) ProtoReflect() protoreflect.Message

func (*CreateExecutionRequest) Reset

func (x *CreateExecutionRequest) Reset()

func (*CreateExecutionRequest) String

func (x *CreateExecutionRequest) String() string

type CreateFeatureGroupOperationMetadata added in v1.54.0

type CreateFeatureGroupOperationMetadata struct {

	// Operation metadata for FeatureGroup.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform create FeatureGroup.

func (*CreateFeatureGroupOperationMetadata) Descriptor deprecated added in v1.54.0

func (*CreateFeatureGroupOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateFeatureGroupOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateFeatureGroupOperationMetadata) GetGenericMetadata added in v1.54.0

func (*CreateFeatureGroupOperationMetadata) ProtoMessage added in v1.54.0

func (*CreateFeatureGroupOperationMetadata) ProtoMessage()

func (*CreateFeatureGroupOperationMetadata) ProtoReflect added in v1.54.0

func (*CreateFeatureGroupOperationMetadata) Reset added in v1.54.0

func (*CreateFeatureGroupOperationMetadata) String added in v1.54.0

type CreateFeatureGroupRequest added in v1.54.0

type CreateFeatureGroupRequest struct {

	// Required. The resource name of the Location to create FeatureGroups.
	// Format:
	// `projects/{project}/locations/{location}'`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The FeatureGroup to create.
	FeatureGroup *FeatureGroup `protobuf:"bytes,2,opt,name=feature_group,json=featureGroup,proto3" json:"feature_group,omitempty"`
	// Required. The ID to use for this FeatureGroup, which will become the final
	// component of the FeatureGroup's resource name.
	//
	// This value may be up to 60 characters, and valid characters are
	// `[a-z0-9_]`. The first character cannot be a number.
	//
	// The value must be unique within the project and location.
	FeatureGroupId string `protobuf:"bytes,3,opt,name=feature_group_id,json=featureGroupId,proto3" json:"feature_group_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureRegistryService.CreateFeatureGroup][google.cloud.aiplatform.v1.FeatureRegistryService.CreateFeatureGroup].

func (*CreateFeatureGroupRequest) Descriptor deprecated added in v1.54.0

func (*CreateFeatureGroupRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateFeatureGroupRequest.ProtoReflect.Descriptor instead.

func (*CreateFeatureGroupRequest) GetFeatureGroup added in v1.54.0

func (x *CreateFeatureGroupRequest) GetFeatureGroup() *FeatureGroup

func (*CreateFeatureGroupRequest) GetFeatureGroupId added in v1.54.0

func (x *CreateFeatureGroupRequest) GetFeatureGroupId() string

func (*CreateFeatureGroupRequest) GetParent added in v1.54.0

func (x *CreateFeatureGroupRequest) GetParent() string

func (*CreateFeatureGroupRequest) ProtoMessage added in v1.54.0

func (*CreateFeatureGroupRequest) ProtoMessage()

func (*CreateFeatureGroupRequest) ProtoReflect added in v1.54.0

func (*CreateFeatureGroupRequest) Reset added in v1.54.0

func (x *CreateFeatureGroupRequest) Reset()

func (*CreateFeatureGroupRequest) String added in v1.54.0

func (x *CreateFeatureGroupRequest) String() string

type CreateFeatureOnlineStoreOperationMetadata added in v1.54.0

type CreateFeatureOnlineStoreOperationMetadata struct {

	// Operation metadata for FeatureOnlineStore.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform create FeatureOnlineStore.

func (*CreateFeatureOnlineStoreOperationMetadata) Descriptor deprecated added in v1.54.0

func (*CreateFeatureOnlineStoreOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateFeatureOnlineStoreOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateFeatureOnlineStoreOperationMetadata) GetGenericMetadata added in v1.54.0

func (*CreateFeatureOnlineStoreOperationMetadata) ProtoMessage added in v1.54.0

func (*CreateFeatureOnlineStoreOperationMetadata) ProtoReflect added in v1.54.0

func (*CreateFeatureOnlineStoreOperationMetadata) Reset added in v1.54.0

func (*CreateFeatureOnlineStoreOperationMetadata) String added in v1.54.0

type CreateFeatureOnlineStoreRequest added in v1.54.0

type CreateFeatureOnlineStoreRequest struct {

	// Required. The resource name of the Location to create FeatureOnlineStores.
	// Format:
	// `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The FeatureOnlineStore to create.
	FeatureOnlineStore *FeatureOnlineStore `protobuf:"bytes,2,opt,name=feature_online_store,json=featureOnlineStore,proto3" json:"feature_online_store,omitempty"`
	// Required. The ID to use for this FeatureOnlineStore, which will become the
	// final component of the FeatureOnlineStore's resource name.
	//
	// This value may be up to 60 characters, and valid characters are
	// `[a-z0-9_]`. The first character cannot be a number.
	//
	// The value must be unique within the project and location.
	FeatureOnlineStoreId string `protobuf:"bytes,3,opt,name=feature_online_store_id,json=featureOnlineStoreId,proto3" json:"feature_online_store_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.CreateFeatureOnlineStore][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.CreateFeatureOnlineStore].

func (*CreateFeatureOnlineStoreRequest) Descriptor deprecated added in v1.54.0

func (*CreateFeatureOnlineStoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateFeatureOnlineStoreRequest.ProtoReflect.Descriptor instead.

func (*CreateFeatureOnlineStoreRequest) GetFeatureOnlineStore added in v1.54.0

func (x *CreateFeatureOnlineStoreRequest) GetFeatureOnlineStore() *FeatureOnlineStore

func (*CreateFeatureOnlineStoreRequest) GetFeatureOnlineStoreId added in v1.54.0

func (x *CreateFeatureOnlineStoreRequest) GetFeatureOnlineStoreId() string

func (*CreateFeatureOnlineStoreRequest) GetParent added in v1.54.0

func (x *CreateFeatureOnlineStoreRequest) GetParent() string

func (*CreateFeatureOnlineStoreRequest) ProtoMessage added in v1.54.0

func (*CreateFeatureOnlineStoreRequest) ProtoMessage()

func (*CreateFeatureOnlineStoreRequest) ProtoReflect added in v1.54.0

func (*CreateFeatureOnlineStoreRequest) Reset added in v1.54.0

func (*CreateFeatureOnlineStoreRequest) String added in v1.54.0

type CreateFeatureOperationMetadata

type CreateFeatureOperationMetadata struct {

	// Operation metadata for Feature.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform create Feature.

func (*CreateFeatureOperationMetadata) Descriptor deprecated

func (*CreateFeatureOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateFeatureOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateFeatureOperationMetadata) GetGenericMetadata

func (*CreateFeatureOperationMetadata) ProtoMessage

func (*CreateFeatureOperationMetadata) ProtoMessage()

func (*CreateFeatureOperationMetadata) ProtoReflect

func (*CreateFeatureOperationMetadata) Reset

func (x *CreateFeatureOperationMetadata) Reset()

func (*CreateFeatureOperationMetadata) String

type CreateFeatureRequest

type CreateFeatureRequest struct {

	// Required. The resource name of the EntityType or FeatureGroup to create a
	// Feature. Format for entity_type as parent:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
	// Format for feature_group as parent:
	// `projects/{project}/locations/{location}/featureGroups/{feature_group}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Feature to create.
	Feature *Feature `protobuf:"bytes,2,opt,name=feature,proto3" json:"feature,omitempty"`
	// Required. The ID to use for the Feature, which will become the final
	// component of the Feature's resource name.
	//
	// This value may be up to 128 characters, and valid characters are
	// `[a-z0-9_]`. The first character cannot be a number.
	//
	// The value must be unique within an EntityType/FeatureGroup.
	FeatureId string `protobuf:"bytes,3,opt,name=feature_id,json=featureId,proto3" json:"feature_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.CreateFeature][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeature]. Request message for [FeatureRegistryService.CreateFeature][google.cloud.aiplatform.v1.FeatureRegistryService.CreateFeature].

func (*CreateFeatureRequest) Descriptor deprecated

func (*CreateFeatureRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateFeatureRequest.ProtoReflect.Descriptor instead.

func (*CreateFeatureRequest) GetFeature

func (x *CreateFeatureRequest) GetFeature() *Feature

func (*CreateFeatureRequest) GetFeatureId

func (x *CreateFeatureRequest) GetFeatureId() string

func (*CreateFeatureRequest) GetParent

func (x *CreateFeatureRequest) GetParent() string

func (*CreateFeatureRequest) ProtoMessage

func (*CreateFeatureRequest) ProtoMessage()

func (*CreateFeatureRequest) ProtoReflect

func (x *CreateFeatureRequest) ProtoReflect() protoreflect.Message

func (*CreateFeatureRequest) Reset

func (x *CreateFeatureRequest) Reset()

func (*CreateFeatureRequest) String

func (x *CreateFeatureRequest) String() string

type CreateFeatureViewOperationMetadata added in v1.54.0

type CreateFeatureViewOperationMetadata struct {

	// Operation metadata for FeatureView Create.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform create FeatureView.

func (*CreateFeatureViewOperationMetadata) Descriptor deprecated added in v1.54.0

func (*CreateFeatureViewOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateFeatureViewOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateFeatureViewOperationMetadata) GetGenericMetadata added in v1.54.0

func (*CreateFeatureViewOperationMetadata) ProtoMessage added in v1.54.0

func (*CreateFeatureViewOperationMetadata) ProtoMessage()

func (*CreateFeatureViewOperationMetadata) ProtoReflect added in v1.54.0

func (*CreateFeatureViewOperationMetadata) Reset added in v1.54.0

func (*CreateFeatureViewOperationMetadata) String added in v1.54.0

type CreateFeatureViewRequest added in v1.54.0

type CreateFeatureViewRequest struct {

	// Required. The resource name of the FeatureOnlineStore to create
	// FeatureViews. Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The FeatureView to create.
	FeatureView *FeatureView `protobuf:"bytes,2,opt,name=feature_view,json=featureView,proto3" json:"feature_view,omitempty"`
	// Required. The ID to use for the FeatureView, which will become the final
	// component of the FeatureView's resource name.
	//
	// This value may be up to 60 characters, and valid characters are
	// `[a-z0-9_]`. The first character cannot be a number.
	//
	// The value must be unique within a FeatureOnlineStore.
	FeatureViewId string `protobuf:"bytes,3,opt,name=feature_view_id,json=featureViewId,proto3" json:"feature_view_id,omitempty"`
	// Immutable. If set to true, one on demand sync will be run immediately,
	// regardless whether the
	// [FeatureView.sync_config][google.cloud.aiplatform.v1.FeatureView.sync_config]
	// is configured or not.
	RunSyncImmediately bool `protobuf:"varint,4,opt,name=run_sync_immediately,json=runSyncImmediately,proto3" json:"run_sync_immediately,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.CreateFeatureView][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.CreateFeatureView].

func (*CreateFeatureViewRequest) Descriptor deprecated added in v1.54.0

func (*CreateFeatureViewRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateFeatureViewRequest.ProtoReflect.Descriptor instead.

func (*CreateFeatureViewRequest) GetFeatureView added in v1.54.0

func (x *CreateFeatureViewRequest) GetFeatureView() *FeatureView

func (*CreateFeatureViewRequest) GetFeatureViewId added in v1.54.0

func (x *CreateFeatureViewRequest) GetFeatureViewId() string

func (*CreateFeatureViewRequest) GetParent added in v1.54.0

func (x *CreateFeatureViewRequest) GetParent() string

func (*CreateFeatureViewRequest) GetRunSyncImmediately added in v1.54.0

func (x *CreateFeatureViewRequest) GetRunSyncImmediately() bool

func (*CreateFeatureViewRequest) ProtoMessage added in v1.54.0

func (*CreateFeatureViewRequest) ProtoMessage()

func (*CreateFeatureViewRequest) ProtoReflect added in v1.54.0

func (x *CreateFeatureViewRequest) ProtoReflect() protoreflect.Message

func (*CreateFeatureViewRequest) Reset added in v1.54.0

func (x *CreateFeatureViewRequest) Reset()

func (*CreateFeatureViewRequest) String added in v1.54.0

func (x *CreateFeatureViewRequest) String() string

type CreateFeaturestoreOperationMetadata

type CreateFeaturestoreOperationMetadata struct {

	// Operation metadata for Featurestore.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform create Featurestore.

func (*CreateFeaturestoreOperationMetadata) Descriptor deprecated

func (*CreateFeaturestoreOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateFeaturestoreOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateFeaturestoreOperationMetadata) GetGenericMetadata

func (*CreateFeaturestoreOperationMetadata) ProtoMessage

func (*CreateFeaturestoreOperationMetadata) ProtoMessage()

func (*CreateFeaturestoreOperationMetadata) ProtoReflect

func (*CreateFeaturestoreOperationMetadata) Reset

func (*CreateFeaturestoreOperationMetadata) String

type CreateFeaturestoreRequest

type CreateFeaturestoreRequest struct {

	// Required. The resource name of the Location to create Featurestores.
	// Format:
	// `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Featurestore to create.
	Featurestore *Featurestore `protobuf:"bytes,2,opt,name=featurestore,proto3" json:"featurestore,omitempty"`
	// Required. The ID to use for this Featurestore, which will become the final
	// component of the Featurestore's resource name.
	//
	// This value may be up to 60 characters, and valid characters are
	// `[a-z0-9_]`. The first character cannot be a number.
	//
	// The value must be unique within the project and location.
	FeaturestoreId string `protobuf:"bytes,3,opt,name=featurestore_id,json=featurestoreId,proto3" json:"featurestore_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.CreateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeaturestore].

func (*CreateFeaturestoreRequest) Descriptor deprecated

func (*CreateFeaturestoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateFeaturestoreRequest.ProtoReflect.Descriptor instead.

func (*CreateFeaturestoreRequest) GetFeaturestore

func (x *CreateFeaturestoreRequest) GetFeaturestore() *Featurestore

func (*CreateFeaturestoreRequest) GetFeaturestoreId

func (x *CreateFeaturestoreRequest) GetFeaturestoreId() string

func (*CreateFeaturestoreRequest) GetParent

func (x *CreateFeaturestoreRequest) GetParent() string

func (*CreateFeaturestoreRequest) ProtoMessage

func (*CreateFeaturestoreRequest) ProtoMessage()

func (*CreateFeaturestoreRequest) ProtoReflect

func (*CreateFeaturestoreRequest) Reset

func (x *CreateFeaturestoreRequest) Reset()

func (*CreateFeaturestoreRequest) String

func (x *CreateFeaturestoreRequest) String() string

type CreateHyperparameterTuningJobRequest

type CreateHyperparameterTuningJobRequest struct {

	// Required. The resource name of the Location to create the
	// HyperparameterTuningJob in. Format:
	// `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The HyperparameterTuningJob to create.
	HyperparameterTuningJob *HyperparameterTuningJob `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [JobService.CreateHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJob].

func (*CreateHyperparameterTuningJobRequest) Descriptor deprecated

func (*CreateHyperparameterTuningJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateHyperparameterTuningJobRequest.ProtoReflect.Descriptor instead.

func (*CreateHyperparameterTuningJobRequest) GetHyperparameterTuningJob

func (x *CreateHyperparameterTuningJobRequest) GetHyperparameterTuningJob() *HyperparameterTuningJob

func (*CreateHyperparameterTuningJobRequest) GetParent

func (*CreateHyperparameterTuningJobRequest) ProtoMessage

func (*CreateHyperparameterTuningJobRequest) ProtoMessage()

func (*CreateHyperparameterTuningJobRequest) ProtoReflect

func (*CreateHyperparameterTuningJobRequest) Reset

func (*CreateHyperparameterTuningJobRequest) String

type CreateIndexEndpointOperationMetadata

type CreateIndexEndpointOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint].

func (*CreateIndexEndpointOperationMetadata) Descriptor deprecated

func (*CreateIndexEndpointOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateIndexEndpointOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateIndexEndpointOperationMetadata) GetGenericMetadata

func (*CreateIndexEndpointOperationMetadata) ProtoMessage

func (*CreateIndexEndpointOperationMetadata) ProtoMessage()

func (*CreateIndexEndpointOperationMetadata) ProtoReflect

func (*CreateIndexEndpointOperationMetadata) Reset

func (*CreateIndexEndpointOperationMetadata) String

type CreateIndexEndpointRequest

type CreateIndexEndpointRequest struct {

	// Required. The resource name of the Location to create the IndexEndpoint in.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The IndexEndpoint to create.
	IndexEndpoint *IndexEndpoint `protobuf:"bytes,2,opt,name=index_endpoint,json=indexEndpoint,proto3" json:"index_endpoint,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint].

func (*CreateIndexEndpointRequest) Descriptor deprecated

func (*CreateIndexEndpointRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateIndexEndpointRequest.ProtoReflect.Descriptor instead.

func (*CreateIndexEndpointRequest) GetIndexEndpoint

func (x *CreateIndexEndpointRequest) GetIndexEndpoint() *IndexEndpoint

func (*CreateIndexEndpointRequest) GetParent

func (x *CreateIndexEndpointRequest) GetParent() string

func (*CreateIndexEndpointRequest) ProtoMessage

func (*CreateIndexEndpointRequest) ProtoMessage()

func (*CreateIndexEndpointRequest) ProtoReflect

func (*CreateIndexEndpointRequest) Reset

func (x *CreateIndexEndpointRequest) Reset()

func (*CreateIndexEndpointRequest) String

func (x *CreateIndexEndpointRequest) String() string

type CreateIndexOperationMetadata

type CreateIndexOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// The operation metadata with regard to Matching Engine Index operation.
	NearestNeighborSearchOperationMetadata *NearestNeighborSearchOperationMetadata `` /* 181-byte string literal not displayed */
	// contains filtered or unexported fields
}

Runtime operation information for [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex].

func (*CreateIndexOperationMetadata) Descriptor deprecated

func (*CreateIndexOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateIndexOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateIndexOperationMetadata) GetGenericMetadata

func (x *CreateIndexOperationMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*CreateIndexOperationMetadata) GetNearestNeighborSearchOperationMetadata

func (x *CreateIndexOperationMetadata) GetNearestNeighborSearchOperationMetadata() *NearestNeighborSearchOperationMetadata

func (*CreateIndexOperationMetadata) ProtoMessage

func (*CreateIndexOperationMetadata) ProtoMessage()

func (*CreateIndexOperationMetadata) ProtoReflect

func (*CreateIndexOperationMetadata) Reset

func (x *CreateIndexOperationMetadata) Reset()

func (*CreateIndexOperationMetadata) String

type CreateIndexRequest

type CreateIndexRequest struct {

	// Required. The resource name of the Location to create the Index in.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Index to create.
	Index *Index `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex].

func (*CreateIndexRequest) Descriptor deprecated

func (*CreateIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateIndexRequest.ProtoReflect.Descriptor instead.

func (*CreateIndexRequest) GetIndex

func (x *CreateIndexRequest) GetIndex() *Index

func (*CreateIndexRequest) GetParent

func (x *CreateIndexRequest) GetParent() string

func (*CreateIndexRequest) ProtoMessage

func (*CreateIndexRequest) ProtoMessage()

func (*CreateIndexRequest) ProtoReflect

func (x *CreateIndexRequest) ProtoReflect() protoreflect.Message

func (*CreateIndexRequest) Reset

func (x *CreateIndexRequest) Reset()

func (*CreateIndexRequest) String

func (x *CreateIndexRequest) String() string

type CreateMetadataSchemaRequest

type CreateMetadataSchemaRequest struct {

	// Required. The resource name of the MetadataStore where the MetadataSchema
	// should be created. Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The MetadataSchema to create.
	MetadataSchema *MetadataSchema `protobuf:"bytes,2,opt,name=metadata_schema,json=metadataSchema,proto3" json:"metadata_schema,omitempty"`
	// The {metadata_schema} portion of the resource name with the format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
	// If not provided, the MetadataStore's ID will be a UUID generated by the
	// service.
	// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
	// Must be unique across all MetadataSchemas in the parent Location.
	// (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
	// if the caller can't view the preexisting MetadataSchema.)
	MetadataSchemaId string `protobuf:"bytes,3,opt,name=metadata_schema_id,json=metadataSchemaId,proto3" json:"metadata_schema_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.CreateMetadataSchema][google.cloud.aiplatform.v1.MetadataService.CreateMetadataSchema].

func (*CreateMetadataSchemaRequest) Descriptor deprecated

func (*CreateMetadataSchemaRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateMetadataSchemaRequest.ProtoReflect.Descriptor instead.

func (*CreateMetadataSchemaRequest) GetMetadataSchema

func (x *CreateMetadataSchemaRequest) GetMetadataSchema() *MetadataSchema

func (*CreateMetadataSchemaRequest) GetMetadataSchemaId

func (x *CreateMetadataSchemaRequest) GetMetadataSchemaId() string

func (*CreateMetadataSchemaRequest) GetParent

func (x *CreateMetadataSchemaRequest) GetParent() string

func (*CreateMetadataSchemaRequest) ProtoMessage

func (*CreateMetadataSchemaRequest) ProtoMessage()

func (*CreateMetadataSchemaRequest) ProtoReflect

func (*CreateMetadataSchemaRequest) Reset

func (x *CreateMetadataSchemaRequest) Reset()

func (*CreateMetadataSchemaRequest) String

func (x *CreateMetadataSchemaRequest) String() string

type CreateMetadataStoreOperationMetadata

type CreateMetadataStoreOperationMetadata struct {

	// Operation metadata for creating a MetadataStore.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore].

func (*CreateMetadataStoreOperationMetadata) Descriptor deprecated

func (*CreateMetadataStoreOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateMetadataStoreOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateMetadataStoreOperationMetadata) GetGenericMetadata

func (*CreateMetadataStoreOperationMetadata) ProtoMessage

func (*CreateMetadataStoreOperationMetadata) ProtoMessage()

func (*CreateMetadataStoreOperationMetadata) ProtoReflect

func (*CreateMetadataStoreOperationMetadata) Reset

func (*CreateMetadataStoreOperationMetadata) String

type CreateMetadataStoreRequest

type CreateMetadataStoreRequest struct {

	// Required. The resource name of the Location where the MetadataStore should
	// be created.
	// Format: `projects/{project}/locations/{location}/`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The MetadataStore to create.
	MetadataStore *MetadataStore `protobuf:"bytes,2,opt,name=metadata_store,json=metadataStore,proto3" json:"metadata_store,omitempty"`
	// The {metadatastore} portion of the resource name with the format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	// If not provided, the MetadataStore's ID will be a UUID generated by the
	// service.
	// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
	// Must be unique across all MetadataStores in the parent Location.
	// (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
	// if the caller can't view the preexisting MetadataStore.)
	MetadataStoreId string `protobuf:"bytes,3,opt,name=metadata_store_id,json=metadataStoreId,proto3" json:"metadata_store_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore].

func (*CreateMetadataStoreRequest) Descriptor deprecated

func (*CreateMetadataStoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateMetadataStoreRequest.ProtoReflect.Descriptor instead.

func (*CreateMetadataStoreRequest) GetMetadataStore

func (x *CreateMetadataStoreRequest) GetMetadataStore() *MetadataStore

func (*CreateMetadataStoreRequest) GetMetadataStoreId

func (x *CreateMetadataStoreRequest) GetMetadataStoreId() string

func (*CreateMetadataStoreRequest) GetParent

func (x *CreateMetadataStoreRequest) GetParent() string

func (*CreateMetadataStoreRequest) ProtoMessage

func (*CreateMetadataStoreRequest) ProtoMessage()

func (*CreateMetadataStoreRequest) ProtoReflect

func (*CreateMetadataStoreRequest) Reset

func (x *CreateMetadataStoreRequest) Reset()

func (*CreateMetadataStoreRequest) String

func (x *CreateMetadataStoreRequest) String() string

type CreateModelDeploymentMonitoringJobRequest

type CreateModelDeploymentMonitoringJobRequest struct {

	// Required. The parent of the ModelDeploymentMonitoringJob.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The ModelDeploymentMonitoringJob to create
	ModelDeploymentMonitoringJob *ModelDeploymentMonitoringJob `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [JobService.CreateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.CreateModelDeploymentMonitoringJob].

func (*CreateModelDeploymentMonitoringJobRequest) Descriptor deprecated

func (*CreateModelDeploymentMonitoringJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateModelDeploymentMonitoringJobRequest.ProtoReflect.Descriptor instead.

func (*CreateModelDeploymentMonitoringJobRequest) GetModelDeploymentMonitoringJob

func (x *CreateModelDeploymentMonitoringJobRequest) GetModelDeploymentMonitoringJob() *ModelDeploymentMonitoringJob

func (*CreateModelDeploymentMonitoringJobRequest) GetParent

func (*CreateModelDeploymentMonitoringJobRequest) ProtoMessage

func (*CreateModelDeploymentMonitoringJobRequest) ProtoReflect

func (*CreateModelDeploymentMonitoringJobRequest) Reset

func (*CreateModelDeploymentMonitoringJobRequest) String

type CreateNasJobRequest added in v1.34.0

type CreateNasJobRequest struct {

	// Required. The resource name of the Location to create the NasJob in.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The NasJob to create.
	NasJob *NasJob `protobuf:"bytes,2,opt,name=nas_job,json=nasJob,proto3" json:"nas_job,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.CreateNasJob][google.cloud.aiplatform.v1.JobService.CreateNasJob].

func (*CreateNasJobRequest) Descriptor deprecated added in v1.34.0

func (*CreateNasJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateNasJobRequest.ProtoReflect.Descriptor instead.

func (*CreateNasJobRequest) GetNasJob added in v1.34.0

func (x *CreateNasJobRequest) GetNasJob() *NasJob

func (*CreateNasJobRequest) GetParent added in v1.34.0

func (x *CreateNasJobRequest) GetParent() string

func (*CreateNasJobRequest) ProtoMessage added in v1.34.0

func (*CreateNasJobRequest) ProtoMessage()

func (*CreateNasJobRequest) ProtoReflect added in v1.34.0

func (x *CreateNasJobRequest) ProtoReflect() protoreflect.Message

func (*CreateNasJobRequest) Reset added in v1.34.0

func (x *CreateNasJobRequest) Reset()

func (*CreateNasJobRequest) String added in v1.34.0

func (x *CreateNasJobRequest) String() string

type CreateNotebookRuntimeTemplateOperationMetadata added in v1.67.0

type CreateNotebookRuntimeTemplateOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Metadata information for [NotebookService.CreateNotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookService.CreateNotebookRuntimeTemplate].

func (*CreateNotebookRuntimeTemplateOperationMetadata) Descriptor deprecated added in v1.67.0

Deprecated: Use CreateNotebookRuntimeTemplateOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateNotebookRuntimeTemplateOperationMetadata) GetGenericMetadata added in v1.67.0

func (*CreateNotebookRuntimeTemplateOperationMetadata) ProtoMessage added in v1.67.0

func (*CreateNotebookRuntimeTemplateOperationMetadata) ProtoReflect added in v1.67.0

func (*CreateNotebookRuntimeTemplateOperationMetadata) Reset added in v1.67.0

func (*CreateNotebookRuntimeTemplateOperationMetadata) String added in v1.67.0

type CreateNotebookRuntimeTemplateRequest added in v1.67.0

type CreateNotebookRuntimeTemplateRequest struct {

	// Required. The resource name of the Location to create the
	// NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The NotebookRuntimeTemplate to create.
	NotebookRuntimeTemplate *NotebookRuntimeTemplate `` /* 132-byte string literal not displayed */
	// Optional. User specified ID for the notebook runtime template.
	NotebookRuntimeTemplateId string `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [NotebookService.CreateNotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookService.CreateNotebookRuntimeTemplate].

func (*CreateNotebookRuntimeTemplateRequest) Descriptor deprecated added in v1.67.0

func (*CreateNotebookRuntimeTemplateRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateNotebookRuntimeTemplateRequest.ProtoReflect.Descriptor instead.

func (*CreateNotebookRuntimeTemplateRequest) GetNotebookRuntimeTemplate added in v1.67.0

func (x *CreateNotebookRuntimeTemplateRequest) GetNotebookRuntimeTemplate() *NotebookRuntimeTemplate

func (*CreateNotebookRuntimeTemplateRequest) GetNotebookRuntimeTemplateId added in v1.67.0

func (x *CreateNotebookRuntimeTemplateRequest) GetNotebookRuntimeTemplateId() string

func (*CreateNotebookRuntimeTemplateRequest) GetParent added in v1.67.0

func (*CreateNotebookRuntimeTemplateRequest) ProtoMessage added in v1.67.0

func (*CreateNotebookRuntimeTemplateRequest) ProtoMessage()

func (*CreateNotebookRuntimeTemplateRequest) ProtoReflect added in v1.67.0

func (*CreateNotebookRuntimeTemplateRequest) Reset added in v1.67.0

func (*CreateNotebookRuntimeTemplateRequest) String added in v1.67.0

type CreatePersistentResourceOperationMetadata added in v1.67.0

type CreatePersistentResourceOperationMetadata struct {

	// Operation metadata for PersistentResource.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// Progress Message for Create LRO
	ProgressMessage string `protobuf:"bytes,2,opt,name=progress_message,json=progressMessage,proto3" json:"progress_message,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform create PersistentResource.

func (*CreatePersistentResourceOperationMetadata) Descriptor deprecated added in v1.67.0

func (*CreatePersistentResourceOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreatePersistentResourceOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreatePersistentResourceOperationMetadata) GetGenericMetadata added in v1.67.0

func (*CreatePersistentResourceOperationMetadata) GetProgressMessage added in v1.67.0

func (x *CreatePersistentResourceOperationMetadata) GetProgressMessage() string

func (*CreatePersistentResourceOperationMetadata) ProtoMessage added in v1.67.0

func (*CreatePersistentResourceOperationMetadata) ProtoReflect added in v1.67.0

func (*CreatePersistentResourceOperationMetadata) Reset added in v1.67.0

func (*CreatePersistentResourceOperationMetadata) String added in v1.67.0

type CreatePersistentResourceRequest added in v1.67.0

type CreatePersistentResourceRequest struct {

	// Required. The resource name of the Location to create the
	// PersistentResource in. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The PersistentResource to create.
	PersistentResource *PersistentResource `protobuf:"bytes,2,opt,name=persistent_resource,json=persistentResource,proto3" json:"persistent_resource,omitempty"`
	// Required. The ID to use for the PersistentResource, which become the final
	// component of the PersistentResource's resource name.
	//
	// The maximum length is 63 characters, and valid characters
	// are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
	PersistentResourceId string `protobuf:"bytes,3,opt,name=persistent_resource_id,json=persistentResourceId,proto3" json:"persistent_resource_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PersistentResourceService.CreatePersistentResource][google.cloud.aiplatform.v1.PersistentResourceService.CreatePersistentResource].

func (*CreatePersistentResourceRequest) Descriptor deprecated added in v1.67.0

func (*CreatePersistentResourceRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreatePersistentResourceRequest.ProtoReflect.Descriptor instead.

func (*CreatePersistentResourceRequest) GetParent added in v1.67.0

func (x *CreatePersistentResourceRequest) GetParent() string

func (*CreatePersistentResourceRequest) GetPersistentResource added in v1.67.0

func (x *CreatePersistentResourceRequest) GetPersistentResource() *PersistentResource

func (*CreatePersistentResourceRequest) GetPersistentResourceId added in v1.67.0

func (x *CreatePersistentResourceRequest) GetPersistentResourceId() string

func (*CreatePersistentResourceRequest) ProtoMessage added in v1.67.0

func (*CreatePersistentResourceRequest) ProtoMessage()

func (*CreatePersistentResourceRequest) ProtoReflect added in v1.67.0

func (*CreatePersistentResourceRequest) Reset added in v1.67.0

func (*CreatePersistentResourceRequest) String added in v1.67.0

type CreatePipelineJobRequest

type CreatePipelineJobRequest struct {

	// Required. The resource name of the Location to create the PipelineJob in.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The PipelineJob to create.
	PipelineJob *PipelineJob `protobuf:"bytes,2,opt,name=pipeline_job,json=pipelineJob,proto3" json:"pipeline_job,omitempty"`
	// The ID to use for the PipelineJob, which will become the final component of
	// the PipelineJob name. If not provided, an ID will be automatically
	// generated.
	//
	// This value should be less than 128 characters, and valid characters
	// are `/[a-z][0-9]-/`.
	PipelineJobId string `protobuf:"bytes,3,opt,name=pipeline_job_id,json=pipelineJobId,proto3" json:"pipeline_job_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob].

func (*CreatePipelineJobRequest) Descriptor deprecated

func (*CreatePipelineJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreatePipelineJobRequest.ProtoReflect.Descriptor instead.

func (*CreatePipelineJobRequest) GetParent

func (x *CreatePipelineJobRequest) GetParent() string

func (*CreatePipelineJobRequest) GetPipelineJob

func (x *CreatePipelineJobRequest) GetPipelineJob() *PipelineJob

func (*CreatePipelineJobRequest) GetPipelineJobId

func (x *CreatePipelineJobRequest) GetPipelineJobId() string

func (*CreatePipelineJobRequest) ProtoMessage

func (*CreatePipelineJobRequest) ProtoMessage()

func (*CreatePipelineJobRequest) ProtoReflect

func (x *CreatePipelineJobRequest) ProtoReflect() protoreflect.Message

func (*CreatePipelineJobRequest) Reset

func (x *CreatePipelineJobRequest) Reset()

func (*CreatePipelineJobRequest) String

func (x *CreatePipelineJobRequest) String() string

type CreateRegistryFeatureOperationMetadata added in v1.54.0

type CreateRegistryFeatureOperationMetadata struct {

	// Operation metadata for Feature.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform create FeatureGroup.

func (*CreateRegistryFeatureOperationMetadata) Descriptor deprecated added in v1.54.0

func (*CreateRegistryFeatureOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateRegistryFeatureOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateRegistryFeatureOperationMetadata) GetGenericMetadata added in v1.54.0

func (*CreateRegistryFeatureOperationMetadata) ProtoMessage added in v1.54.0

func (*CreateRegistryFeatureOperationMetadata) ProtoReflect added in v1.54.0

func (*CreateRegistryFeatureOperationMetadata) Reset added in v1.54.0

func (*CreateRegistryFeatureOperationMetadata) String added in v1.54.0

type CreateScheduleRequest added in v1.47.0

type CreateScheduleRequest struct {

	// Required. The resource name of the Location to create the Schedule in.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Schedule to create.
	Schedule *Schedule `protobuf:"bytes,2,opt,name=schedule,proto3" json:"schedule,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ScheduleService.CreateSchedule][google.cloud.aiplatform.v1.ScheduleService.CreateSchedule].

func (*CreateScheduleRequest) Descriptor deprecated added in v1.47.0

func (*CreateScheduleRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateScheduleRequest.ProtoReflect.Descriptor instead.

func (*CreateScheduleRequest) GetParent added in v1.47.0

func (x *CreateScheduleRequest) GetParent() string

func (*CreateScheduleRequest) GetSchedule added in v1.47.0

func (x *CreateScheduleRequest) GetSchedule() *Schedule

func (*CreateScheduleRequest) ProtoMessage added in v1.47.0

func (*CreateScheduleRequest) ProtoMessage()

func (*CreateScheduleRequest) ProtoReflect added in v1.47.0

func (x *CreateScheduleRequest) ProtoReflect() protoreflect.Message

func (*CreateScheduleRequest) Reset added in v1.47.0

func (x *CreateScheduleRequest) Reset()

func (*CreateScheduleRequest) String added in v1.47.0

func (x *CreateScheduleRequest) String() string

type CreateSpecialistPoolOperationMetadata

type CreateSpecialistPoolOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool].

func (*CreateSpecialistPoolOperationMetadata) Descriptor deprecated

func (*CreateSpecialistPoolOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateSpecialistPoolOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateSpecialistPoolOperationMetadata) GetGenericMetadata

func (*CreateSpecialistPoolOperationMetadata) ProtoMessage

func (*CreateSpecialistPoolOperationMetadata) ProtoMessage()

func (*CreateSpecialistPoolOperationMetadata) ProtoReflect

func (*CreateSpecialistPoolOperationMetadata) Reset

func (*CreateSpecialistPoolOperationMetadata) String

type CreateSpecialistPoolRequest

type CreateSpecialistPoolRequest struct {

	// Required. The parent Project name for the new SpecialistPool.
	// The form is `projects/{project}/locations/{location}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The SpecialistPool to create.
	SpecialistPool *SpecialistPool `protobuf:"bytes,2,opt,name=specialist_pool,json=specialistPool,proto3" json:"specialist_pool,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool].

func (*CreateSpecialistPoolRequest) Descriptor deprecated

func (*CreateSpecialistPoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateSpecialistPoolRequest.ProtoReflect.Descriptor instead.

func (*CreateSpecialistPoolRequest) GetParent

func (x *CreateSpecialistPoolRequest) GetParent() string

func (*CreateSpecialistPoolRequest) GetSpecialistPool

func (x *CreateSpecialistPoolRequest) GetSpecialistPool() *SpecialistPool

func (*CreateSpecialistPoolRequest) ProtoMessage

func (*CreateSpecialistPoolRequest) ProtoMessage()

func (*CreateSpecialistPoolRequest) ProtoReflect

func (*CreateSpecialistPoolRequest) Reset

func (x *CreateSpecialistPoolRequest) Reset()

func (*CreateSpecialistPoolRequest) String

func (x *CreateSpecialistPoolRequest) String() string

type CreateStudyRequest

type CreateStudyRequest struct {

	// Required. The resource name of the Location to create the CustomJob in.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Study configuration used to create the Study.
	Study *Study `protobuf:"bytes,2,opt,name=study,proto3" json:"study,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.CreateStudy][google.cloud.aiplatform.v1.VizierService.CreateStudy].

func (*CreateStudyRequest) Descriptor deprecated

func (*CreateStudyRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateStudyRequest.ProtoReflect.Descriptor instead.

func (*CreateStudyRequest) GetParent

func (x *CreateStudyRequest) GetParent() string

func (*CreateStudyRequest) GetStudy

func (x *CreateStudyRequest) GetStudy() *Study

func (*CreateStudyRequest) ProtoMessage

func (*CreateStudyRequest) ProtoMessage()

func (*CreateStudyRequest) ProtoReflect

func (x *CreateStudyRequest) ProtoReflect() protoreflect.Message

func (*CreateStudyRequest) Reset

func (x *CreateStudyRequest) Reset()

func (*CreateStudyRequest) String

func (x *CreateStudyRequest) String() string

type CreateTensorboardExperimentRequest

type CreateTensorboardExperimentRequest struct {

	// Required. The resource name of the Tensorboard to create the
	// TensorboardExperiment in. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The TensorboardExperiment to create.
	TensorboardExperiment *TensorboardExperiment `protobuf:"bytes,2,opt,name=tensorboard_experiment,json=tensorboardExperiment,proto3" json:"tensorboard_experiment,omitempty"`
	// Required. The ID to use for the Tensorboard experiment, which becomes the
	// final component of the Tensorboard experiment's resource name.
	//
	// This value should be 1-128 characters, and valid characters
	// are `/[a-z][0-9]-/`.
	TensorboardExperimentId string `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [TensorboardService.CreateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardExperiment].

func (*CreateTensorboardExperimentRequest) Descriptor deprecated

func (*CreateTensorboardExperimentRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTensorboardExperimentRequest.ProtoReflect.Descriptor instead.

func (*CreateTensorboardExperimentRequest) GetParent

func (*CreateTensorboardExperimentRequest) GetTensorboardExperiment

func (x *CreateTensorboardExperimentRequest) GetTensorboardExperiment() *TensorboardExperiment

func (*CreateTensorboardExperimentRequest) GetTensorboardExperimentId

func (x *CreateTensorboardExperimentRequest) GetTensorboardExperimentId() string

func (*CreateTensorboardExperimentRequest) ProtoMessage

func (*CreateTensorboardExperimentRequest) ProtoMessage()

func (*CreateTensorboardExperimentRequest) ProtoReflect

func (*CreateTensorboardExperimentRequest) Reset

func (*CreateTensorboardExperimentRequest) String

type CreateTensorboardOperationMetadata

type CreateTensorboardOperationMetadata struct {

	// Operation metadata for Tensorboard.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform create Tensorboard.

func (*CreateTensorboardOperationMetadata) Descriptor deprecated

func (*CreateTensorboardOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateTensorboardOperationMetadata.ProtoReflect.Descriptor instead.

func (*CreateTensorboardOperationMetadata) GetGenericMetadata

func (*CreateTensorboardOperationMetadata) ProtoMessage

func (*CreateTensorboardOperationMetadata) ProtoMessage()

func (*CreateTensorboardOperationMetadata) ProtoReflect

func (*CreateTensorboardOperationMetadata) Reset

func (*CreateTensorboardOperationMetadata) String

type CreateTensorboardRequest

type CreateTensorboardRequest struct {

	// Required. The resource name of the Location to create the Tensorboard in.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Tensorboard to create.
	Tensorboard *Tensorboard `protobuf:"bytes,2,opt,name=tensorboard,proto3" json:"tensorboard,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.CreateTensorboard][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboard].

func (*CreateTensorboardRequest) Descriptor deprecated

func (*CreateTensorboardRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTensorboardRequest.ProtoReflect.Descriptor instead.

func (*CreateTensorboardRequest) GetParent

func (x *CreateTensorboardRequest) GetParent() string

func (*CreateTensorboardRequest) GetTensorboard

func (x *CreateTensorboardRequest) GetTensorboard() *Tensorboard

func (*CreateTensorboardRequest) ProtoMessage

func (*CreateTensorboardRequest) ProtoMessage()

func (*CreateTensorboardRequest) ProtoReflect

func (x *CreateTensorboardRequest) ProtoReflect() protoreflect.Message

func (*CreateTensorboardRequest) Reset

func (x *CreateTensorboardRequest) Reset()

func (*CreateTensorboardRequest) String

func (x *CreateTensorboardRequest) String() string

type CreateTensorboardRunRequest

type CreateTensorboardRunRequest struct {

	// Required. The resource name of the TensorboardExperiment to create the
	// TensorboardRun in. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The TensorboardRun to create.
	TensorboardRun *TensorboardRun `protobuf:"bytes,2,opt,name=tensorboard_run,json=tensorboardRun,proto3" json:"tensorboard_run,omitempty"`
	// Required. The ID to use for the Tensorboard run, which becomes the final
	// component of the Tensorboard run's resource name.
	//
	// This value should be 1-128 characters, and valid characters
	// are `/[a-z][0-9]-/`.
	TensorboardRunId string `protobuf:"bytes,3,opt,name=tensorboard_run_id,json=tensorboardRunId,proto3" json:"tensorboard_run_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.CreateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardRun].

func (*CreateTensorboardRunRequest) Descriptor deprecated

func (*CreateTensorboardRunRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTensorboardRunRequest.ProtoReflect.Descriptor instead.

func (*CreateTensorboardRunRequest) GetParent

func (x *CreateTensorboardRunRequest) GetParent() string

func (*CreateTensorboardRunRequest) GetTensorboardRun

func (x *CreateTensorboardRunRequest) GetTensorboardRun() *TensorboardRun

func (*CreateTensorboardRunRequest) GetTensorboardRunId

func (x *CreateTensorboardRunRequest) GetTensorboardRunId() string

func (*CreateTensorboardRunRequest) ProtoMessage

func (*CreateTensorboardRunRequest) ProtoMessage()

func (*CreateTensorboardRunRequest) ProtoReflect

func (*CreateTensorboardRunRequest) Reset

func (x *CreateTensorboardRunRequest) Reset()

func (*CreateTensorboardRunRequest) String

func (x *CreateTensorboardRunRequest) String() string

type CreateTensorboardTimeSeriesRequest

type CreateTensorboardTimeSeriesRequest struct {

	// Required. The resource name of the TensorboardRun to create the
	// TensorboardTimeSeries in.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The user specified unique ID to use for the
	// TensorboardTimeSeries, which becomes the final component of the
	// TensorboardTimeSeries's resource name. This value should match
	// "[a-z0-9][a-z0-9-]{0, 127}"
	TensorboardTimeSeriesId string `` /* 134-byte string literal not displayed */
	// Required. The TensorboardTimeSeries to create.
	TensorboardTimeSeries *TensorboardTimeSeries `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [TensorboardService.CreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardTimeSeries].

func (*CreateTensorboardTimeSeriesRequest) Descriptor deprecated

func (*CreateTensorboardTimeSeriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTensorboardTimeSeriesRequest.ProtoReflect.Descriptor instead.

func (*CreateTensorboardTimeSeriesRequest) GetParent

func (*CreateTensorboardTimeSeriesRequest) GetTensorboardTimeSeries

func (x *CreateTensorboardTimeSeriesRequest) GetTensorboardTimeSeries() *TensorboardTimeSeries

func (*CreateTensorboardTimeSeriesRequest) GetTensorboardTimeSeriesId

func (x *CreateTensorboardTimeSeriesRequest) GetTensorboardTimeSeriesId() string

func (*CreateTensorboardTimeSeriesRequest) ProtoMessage

func (*CreateTensorboardTimeSeriesRequest) ProtoMessage()

func (*CreateTensorboardTimeSeriesRequest) ProtoReflect

func (*CreateTensorboardTimeSeriesRequest) Reset

func (*CreateTensorboardTimeSeriesRequest) String

type CreateTrainingPipelineRequest

type CreateTrainingPipelineRequest struct {

	// Required. The resource name of the Location to create the TrainingPipeline
	// in. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The TrainingPipeline to create.
	TrainingPipeline *TrainingPipeline `protobuf:"bytes,2,opt,name=training_pipeline,json=trainingPipeline,proto3" json:"training_pipeline,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PipelineService.CreateTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CreateTrainingPipeline].

func (*CreateTrainingPipelineRequest) Descriptor deprecated

func (*CreateTrainingPipelineRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTrainingPipelineRequest.ProtoReflect.Descriptor instead.

func (*CreateTrainingPipelineRequest) GetParent

func (x *CreateTrainingPipelineRequest) GetParent() string

func (*CreateTrainingPipelineRequest) GetTrainingPipeline

func (x *CreateTrainingPipelineRequest) GetTrainingPipeline() *TrainingPipeline

func (*CreateTrainingPipelineRequest) ProtoMessage

func (*CreateTrainingPipelineRequest) ProtoMessage()

func (*CreateTrainingPipelineRequest) ProtoReflect

func (*CreateTrainingPipelineRequest) Reset

func (x *CreateTrainingPipelineRequest) Reset()

func (*CreateTrainingPipelineRequest) String

type CreateTrialRequest

type CreateTrialRequest struct {

	// Required. The resource name of the Study to create the Trial in.
	// Format: `projects/{project}/locations/{location}/studies/{study}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Trial to create.
	Trial *Trial `protobuf:"bytes,2,opt,name=trial,proto3" json:"trial,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.CreateTrial][google.cloud.aiplatform.v1.VizierService.CreateTrial].

func (*CreateTrialRequest) Descriptor deprecated

func (*CreateTrialRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTrialRequest.ProtoReflect.Descriptor instead.

func (*CreateTrialRequest) GetParent

func (x *CreateTrialRequest) GetParent() string

func (*CreateTrialRequest) GetTrial

func (x *CreateTrialRequest) GetTrial() *Trial

func (*CreateTrialRequest) ProtoMessage

func (*CreateTrialRequest) ProtoMessage()

func (*CreateTrialRequest) ProtoReflect

func (x *CreateTrialRequest) ProtoReflect() protoreflect.Message

func (*CreateTrialRequest) Reset

func (x *CreateTrialRequest) Reset()

func (*CreateTrialRequest) String

func (x *CreateTrialRequest) String() string

type CreateTuningJobRequest added in v1.67.0

type CreateTuningJobRequest struct {

	// Required. The resource name of the Location to create the TuningJob in.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The TuningJob to create.
	TuningJob *TuningJob `protobuf:"bytes,2,opt,name=tuning_job,json=tuningJob,proto3" json:"tuning_job,omitempty"`
	// contains filtered or unexported fields
}

Request message for [GenAiTuningService.CreateTuningJob][google.cloud.aiplatform.v1.GenAiTuningService.CreateTuningJob].

func (*CreateTuningJobRequest) Descriptor deprecated added in v1.67.0

func (*CreateTuningJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTuningJobRequest.ProtoReflect.Descriptor instead.

func (*CreateTuningJobRequest) GetParent added in v1.67.0

func (x *CreateTuningJobRequest) GetParent() string

func (*CreateTuningJobRequest) GetTuningJob added in v1.67.0

func (x *CreateTuningJobRequest) GetTuningJob() *TuningJob

func (*CreateTuningJobRequest) ProtoMessage added in v1.67.0

func (*CreateTuningJobRequest) ProtoMessage()

func (*CreateTuningJobRequest) ProtoReflect added in v1.67.0

func (x *CreateTuningJobRequest) ProtoReflect() protoreflect.Message

func (*CreateTuningJobRequest) Reset added in v1.67.0

func (x *CreateTuningJobRequest) Reset()

func (*CreateTuningJobRequest) String added in v1.67.0

func (x *CreateTuningJobRequest) String() string

type CsvDestination

type CsvDestination struct {

	// Required. Google Cloud Storage location.
	GcsDestination *GcsDestination `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3" json:"gcs_destination,omitempty"`
	// contains filtered or unexported fields
}

The storage details for CSV output content.

func (*CsvDestination) Descriptor deprecated

func (*CsvDestination) Descriptor() ([]byte, []int)

Deprecated: Use CsvDestination.ProtoReflect.Descriptor instead.

func (*CsvDestination) GetGcsDestination

func (x *CsvDestination) GetGcsDestination() *GcsDestination

func (*CsvDestination) ProtoMessage

func (*CsvDestination) ProtoMessage()

func (*CsvDestination) ProtoReflect

func (x *CsvDestination) ProtoReflect() protoreflect.Message

func (*CsvDestination) Reset

func (x *CsvDestination) Reset()

func (*CsvDestination) String

func (x *CsvDestination) String() string

type CsvSource

type CsvSource struct {

	// Required. Google Cloud Storage location.
	GcsSource *GcsSource `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3" json:"gcs_source,omitempty"`
	// contains filtered or unexported fields
}

The storage details for CSV input content.

func (*CsvSource) Descriptor deprecated

func (*CsvSource) Descriptor() ([]byte, []int)

Deprecated: Use CsvSource.ProtoReflect.Descriptor instead.

func (*CsvSource) GetGcsSource

func (x *CsvSource) GetGcsSource() *GcsSource

func (*CsvSource) ProtoMessage

func (*CsvSource) ProtoMessage()

func (*CsvSource) ProtoReflect

func (x *CsvSource) ProtoReflect() protoreflect.Message

func (*CsvSource) Reset

func (x *CsvSource) Reset()

func (*CsvSource) String

func (x *CsvSource) String() string

type CustomJob

type CustomJob struct {

	// Output only. Resource name of a CustomJob.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The display name of the CustomJob.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Required. Job spec.
	JobSpec *CustomJobSpec `protobuf:"bytes,4,opt,name=job_spec,json=jobSpec,proto3" json:"job_spec,omitempty"`
	// Output only. The detailed state of the job.
	State JobState `protobuf:"varint,5,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.JobState" json:"state,omitempty"`
	// Output only. Time when the CustomJob was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Time when the CustomJob for the first time entered the
	// `JOB_STATE_RUNNING` state.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. Time when the CustomJob entered any of the following states:
	// `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Time when the CustomJob was most recently updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Only populated when job's state is `JOB_STATE_FAILED` or
	// `JOB_STATE_CANCELLED`.
	Error *status.Status `protobuf:"bytes,10,opt,name=error,proto3" json:"error,omitempty"`
	// The labels with user-defined metadata to organize CustomJobs.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Customer-managed encryption key options for a CustomJob. If this is set,
	// then all resources created by the CustomJob will be encrypted with the
	// provided encryption key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,12,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// Output only. URIs for accessing [interactive
	// shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
	// (one URI for each training node). Only available if
	// [job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
	// is `true`.
	//
	// The keys are names of each node in the training job; for example,
	// `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
	// the second worker pool, and `workerpool1-1` for the second node in the
	// second worker pool.
	//
	// The values are the URIs for each node's interactive shell.
	WebAccessUris map[string]string `` /* 191-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).

func (*CustomJob) Descriptor deprecated

func (*CustomJob) Descriptor() ([]byte, []int)

Deprecated: Use CustomJob.ProtoReflect.Descriptor instead.

func (*CustomJob) GetCreateTime

func (x *CustomJob) GetCreateTime() *timestamppb.Timestamp

func (*CustomJob) GetDisplayName

func (x *CustomJob) GetDisplayName() string

func (*CustomJob) GetEncryptionSpec

func (x *CustomJob) GetEncryptionSpec() *EncryptionSpec

func (*CustomJob) GetEndTime

func (x *CustomJob) GetEndTime() *timestamppb.Timestamp

func (*CustomJob) GetError

func (x *CustomJob) GetError() *status.Status

func (*CustomJob) GetJobSpec

func (x *CustomJob) GetJobSpec() *CustomJobSpec

func (*CustomJob) GetLabels

func (x *CustomJob) GetLabels() map[string]string

func (*CustomJob) GetName

func (x *CustomJob) GetName() string

func (*CustomJob) GetStartTime

func (x *CustomJob) GetStartTime() *timestamppb.Timestamp

func (*CustomJob) GetState

func (x *CustomJob) GetState() JobState

func (*CustomJob) GetUpdateTime

func (x *CustomJob) GetUpdateTime() *timestamppb.Timestamp

func (*CustomJob) GetWebAccessUris

func (x *CustomJob) GetWebAccessUris() map[string]string

func (*CustomJob) ProtoMessage

func (*CustomJob) ProtoMessage()

func (*CustomJob) ProtoReflect

func (x *CustomJob) ProtoReflect() protoreflect.Message

func (*CustomJob) Reset

func (x *CustomJob) Reset()

func (*CustomJob) String

func (x *CustomJob) String() string

type CustomJobSpec

type CustomJobSpec struct {

	// Optional. The ID of the PersistentResource in the same Project and Location
	// which to run
	//
	// If this is specified, the job will be run on existing machines held by the
	// PersistentResource instead of on-demand short-live machines.
	// The network and CMEK configs on the job should be consistent with those on
	// the PersistentResource, otherwise, the job will be rejected.
	PersistentResourceId string `protobuf:"bytes,14,opt,name=persistent_resource_id,json=persistentResourceId,proto3" json:"persistent_resource_id,omitempty"`
	// Required. The spec of the worker pools including machine type and Docker
	// image. All worker pools except the first one are optional and can be
	// skipped by providing an empty value.
	WorkerPoolSpecs []*WorkerPoolSpec `protobuf:"bytes,1,rep,name=worker_pool_specs,json=workerPoolSpecs,proto3" json:"worker_pool_specs,omitempty"`
	// Scheduling options for a CustomJob.
	Scheduling *Scheduling `protobuf:"bytes,3,opt,name=scheduling,proto3" json:"scheduling,omitempty"`
	// Specifies the service account for workload run-as account.
	// Users submitting jobs must have act-as permission on this run-as account.
	// If unspecified, the [Vertex AI Custom Code Service
	// Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
	// for the CustomJob's project is used.
	ServiceAccount string `protobuf:"bytes,4,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// Optional. The full name of the Compute Engine
	// [network](/compute/docs/networks-and-firewalls#networks) to which the Job
	// should be peered. For example, `projects/12345/global/networks/myVPC`.
	// [Format](/compute/docs/reference/rest/v1/networks/insert)
	// is of the form `projects/{project}/global/networks/{network}`.
	// Where {project} is a project number, as in `12345`, and {network} is a
	// network name.
	//
	// To specify this field, you must have already [configured VPC Network
	// Peering for Vertex
	// AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).
	//
	// If this field is left unspecified, the job is not peered with any network.
	Network string `protobuf:"bytes,5,opt,name=network,proto3" json:"network,omitempty"`
	// Optional. A list of names for the reserved ip ranges under the VPC network
	// that can be used for this job.
	//
	// If set, we will deploy the job within the provided ip ranges. Otherwise,
	// the job will be deployed to any ip ranges under the provided VPC
	// network.
	//
	// Example: ['vertex-ai-ip-range'].
	ReservedIpRanges []string `protobuf:"bytes,13,rep,name=reserved_ip_ranges,json=reservedIpRanges,proto3" json:"reserved_ip_ranges,omitempty"`
	// The Cloud Storage location to store the output of this CustomJob or
	// HyperparameterTuningJob. For HyperparameterTuningJob,
	// the baseOutputDirectory of
	// each child CustomJob backing a Trial is set to a subdirectory of name
	// [id][google.cloud.aiplatform.v1.Trial.id] under its parent
	// HyperparameterTuningJob's baseOutputDirectory.
	//
	// The following Vertex AI environment variables will be passed to
	// containers or python modules when this field is set:
	//
	//	For CustomJob:
	//
	//	* AIP_MODEL_DIR = `<base_output_directory>/model/`
	//	* AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
	//	* AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`
	//
	//	For CustomJob backing a Trial of HyperparameterTuningJob:
	//
	//	* AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
	//	* AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
	//	* AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
	BaseOutputDirectory *GcsDestination `protobuf:"bytes,6,opt,name=base_output_directory,json=baseOutputDirectory,proto3" json:"base_output_directory,omitempty"`
	// The ID of the location to store protected artifacts. e.g. us-central1.
	// Populate only when the location is different than CustomJob location.
	// List of supported locations:
	// https://cloud.google.com/vertex-ai/docs/general/locations
	ProtectedArtifactLocationId string `` /* 147-byte string literal not displayed */
	// Optional. The name of a Vertex AI
	// [Tensorboard][google.cloud.aiplatform.v1.Tensorboard] resource to which
	// this CustomJob will upload Tensorboard logs. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
	Tensorboard string `protobuf:"bytes,7,opt,name=tensorboard,proto3" json:"tensorboard,omitempty"`
	// Optional. Whether you want Vertex AI to enable [interactive shell
	// access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
	// to training containers.
	//
	// If set to `true`, you can access interactive shells at the URIs given
	// by
	// [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris]
	// or
	// [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris]
	// (within
	// [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
	EnableWebAccess bool `protobuf:"varint,10,opt,name=enable_web_access,json=enableWebAccess,proto3" json:"enable_web_access,omitempty"`
	// Optional. Whether you want Vertex AI to enable access to the customized
	// dashboard in training chief container.
	//
	// If set to `true`, you can access the dashboard at the URIs given
	// by
	// [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris]
	// or
	// [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris]
	// (within
	// [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
	EnableDashboardAccess bool `` /* 128-byte string literal not displayed */
	// Optional. The Experiment associated with this job.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
	Experiment string `protobuf:"bytes,17,opt,name=experiment,proto3" json:"experiment,omitempty"`
	// Optional. The Experiment Run associated with this job.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
	ExperimentRun string `protobuf:"bytes,18,opt,name=experiment_run,json=experimentRun,proto3" json:"experiment_run,omitempty"`
	// Optional. The name of the Model resources for which to generate a mapping
	// to artifact URIs. Applicable only to some of the Google-provided custom
	// jobs. Format: `projects/{project}/locations/{location}/models/{model}`
	//
	// In order to retrieve a specific version of the model, also provide
	// the version ID or version alias.
	//
	//	Example: `projects/{project}/locations/{location}/models/{model}@2`
	//	           or
	//	         `projects/{project}/locations/{location}/models/{model}@golden`
	//
	// If no version ID or alias is specified, the "default" version will be
	// returned. The "default" version alias is created for the first version of
	// the model, and can be moved to other versions later on. There will be
	// exactly one default version.
	Models []string `protobuf:"bytes,20,rep,name=models,proto3" json:"models,omitempty"`
	// contains filtered or unexported fields
}

Represents the spec of a CustomJob.

func (*CustomJobSpec) Descriptor deprecated

func (*CustomJobSpec) Descriptor() ([]byte, []int)

Deprecated: Use CustomJobSpec.ProtoReflect.Descriptor instead.

func (*CustomJobSpec) GetBaseOutputDirectory

func (x *CustomJobSpec) GetBaseOutputDirectory() *GcsDestination

func (*CustomJobSpec) GetEnableDashboardAccess added in v1.33.0

func (x *CustomJobSpec) GetEnableDashboardAccess() bool

func (*CustomJobSpec) GetEnableWebAccess

func (x *CustomJobSpec) GetEnableWebAccess() bool

func (*CustomJobSpec) GetExperiment added in v1.40.0

func (x *CustomJobSpec) GetExperiment() string

func (*CustomJobSpec) GetExperimentRun added in v1.40.0

func (x *CustomJobSpec) GetExperimentRun() string

func (*CustomJobSpec) GetModels added in v1.58.1

func (x *CustomJobSpec) GetModels() []string

func (*CustomJobSpec) GetNetwork

func (x *CustomJobSpec) GetNetwork() string

func (*CustomJobSpec) GetPersistentResourceId added in v1.67.0

func (x *CustomJobSpec) GetPersistentResourceId() string

func (*CustomJobSpec) GetProtectedArtifactLocationId added in v1.54.0

func (x *CustomJobSpec) GetProtectedArtifactLocationId() string

func (*CustomJobSpec) GetReservedIpRanges

func (x *CustomJobSpec) GetReservedIpRanges() []string

func (*CustomJobSpec) GetScheduling

func (x *CustomJobSpec) GetScheduling() *Scheduling

func (*CustomJobSpec) GetServiceAccount

func (x *CustomJobSpec) GetServiceAccount() string

func (*CustomJobSpec) GetTensorboard

func (x *CustomJobSpec) GetTensorboard() string

func (*CustomJobSpec) GetWorkerPoolSpecs

func (x *CustomJobSpec) GetWorkerPoolSpecs() []*WorkerPoolSpec

func (*CustomJobSpec) ProtoMessage

func (*CustomJobSpec) ProtoMessage()

func (*CustomJobSpec) ProtoReflect

func (x *CustomJobSpec) ProtoReflect() protoreflect.Message

func (*CustomJobSpec) Reset

func (x *CustomJobSpec) Reset()

func (*CustomJobSpec) String

func (x *CustomJobSpec) String() string

type DataItem

type DataItem struct {

	// Output only. The resource name of the DataItem.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Timestamp when this DataItem was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this DataItem was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. The labels with user-defined metadata to organize your DataItems.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one DataItem(System
	// labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Required. The data that the DataItem represents (for example, an image or a
	// text snippet). The schema of the payload is stored in the parent Dataset's
	// [metadata schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
	// dataItemSchemaUri field.
	Payload *structpb.Value `protobuf:"bytes,4,opt,name=payload,proto3" json:"payload,omitempty"`
	// Optional. Used to perform consistent read-modify-write updates. If not set,
	// a blind "overwrite" update happens.
	Etag string `protobuf:"bytes,7,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

A piece of data in a Dataset. Could be an image, a video, a document or plain text.

func (*DataItem) Descriptor deprecated

func (*DataItem) Descriptor() ([]byte, []int)

Deprecated: Use DataItem.ProtoReflect.Descriptor instead.

func (*DataItem) GetCreateTime

func (x *DataItem) GetCreateTime() *timestamppb.Timestamp

func (*DataItem) GetEtag

func (x *DataItem) GetEtag() string

func (*DataItem) GetLabels

func (x *DataItem) GetLabels() map[string]string

func (*DataItem) GetName

func (x *DataItem) GetName() string

func (*DataItem) GetPayload

func (x *DataItem) GetPayload() *structpb.Value

func (*DataItem) GetUpdateTime

func (x *DataItem) GetUpdateTime() *timestamppb.Timestamp

func (*DataItem) ProtoMessage

func (*DataItem) ProtoMessage()

func (*DataItem) ProtoReflect

func (x *DataItem) ProtoReflect() protoreflect.Message

func (*DataItem) Reset

func (x *DataItem) Reset()

func (*DataItem) String

func (x *DataItem) String() string

type DataItemView added in v1.29.0

type DataItemView struct {

	// The DataItem.
	DataItem *DataItem `protobuf:"bytes,1,opt,name=data_item,json=dataItem,proto3" json:"data_item,omitempty"`
	// The Annotations on the DataItem. If too many Annotations should be returned
	// for the DataItem, this field will be truncated per annotations_limit in
	// request. If it was, then the has_truncated_annotations will be set to true.
	Annotations []*Annotation `protobuf:"bytes,2,rep,name=annotations,proto3" json:"annotations,omitempty"`
	// True if and only if the Annotations field has been truncated. It happens if
	// more Annotations for this DataItem met the request's annotation_filter than
	// are allowed to be returned by annotations_limit.
	// Note that if Annotations field is not being returned due to field mask,
	// then this field will not be set to true no matter how many Annotations are
	// there.
	HasTruncatedAnnotations bool `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

A container for a single DataItem and Annotations on it.

func (*DataItemView) Descriptor deprecated added in v1.29.0

func (*DataItemView) Descriptor() ([]byte, []int)

Deprecated: Use DataItemView.ProtoReflect.Descriptor instead.

func (*DataItemView) GetAnnotations added in v1.29.0

func (x *DataItemView) GetAnnotations() []*Annotation

func (*DataItemView) GetDataItem added in v1.29.0

func (x *DataItemView) GetDataItem() *DataItem

func (*DataItemView) GetHasTruncatedAnnotations added in v1.29.0

func (x *DataItemView) GetHasTruncatedAnnotations() bool

func (*DataItemView) ProtoMessage added in v1.29.0

func (*DataItemView) ProtoMessage()

func (*DataItemView) ProtoReflect added in v1.29.0

func (x *DataItemView) ProtoReflect() protoreflect.Message

func (*DataItemView) Reset added in v1.29.0

func (x *DataItemView) Reset()

func (*DataItemView) String added in v1.29.0

func (x *DataItemView) String() string

type DataLabelingJob

type DataLabelingJob struct {

	// Output only. Resource name of the DataLabelingJob.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The user-defined name of the DataLabelingJob.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	// Display name of a DataLabelingJob.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Required. Dataset resource names. Right now we only support labeling from a
	// single Dataset. Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`
	Datasets []string `protobuf:"bytes,3,rep,name=datasets,proto3" json:"datasets,omitempty"`
	// Labels to assign to annotations generated by this DataLabelingJob.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable.
	AnnotationLabels map[string]string `` /* 198-byte string literal not displayed */
	// Required. Number of labelers to work on each DataItem.
	LabelerCount int32 `protobuf:"varint,4,opt,name=labeler_count,json=labelerCount,proto3" json:"labeler_count,omitempty"`
	// Required. The Google Cloud Storage location of the instruction pdf. This
	// pdf is shared with labelers, and provides detailed description on how to
	// label DataItems in Datasets.
	InstructionUri string `protobuf:"bytes,5,opt,name=instruction_uri,json=instructionUri,proto3" json:"instruction_uri,omitempty"`
	// Required. Points to a YAML file stored on Google Cloud Storage describing
	// the config for a specific type of DataLabelingJob. The schema files that
	// can be used here are found in the
	// https://storage.googleapis.com/google-cloud-aiplatform bucket in the
	// /schema/datalabelingjob/inputs/ folder.
	InputsSchemaUri string `protobuf:"bytes,6,opt,name=inputs_schema_uri,json=inputsSchemaUri,proto3" json:"inputs_schema_uri,omitempty"`
	// Required. Input config parameters for the DataLabelingJob.
	Inputs *structpb.Value `protobuf:"bytes,7,opt,name=inputs,proto3" json:"inputs,omitempty"`
	// Output only. The detailed state of the job.
	State JobState `protobuf:"varint,8,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.JobState" json:"state,omitempty"`
	// Output only. Current labeling job progress percentage scaled in interval
	// [0, 100], indicating the percentage of DataItems that has been finished.
	LabelingProgress int32 `protobuf:"varint,13,opt,name=labeling_progress,json=labelingProgress,proto3" json:"labeling_progress,omitempty"`
	// Output only. Estimated cost(in US dollars) that the DataLabelingJob has
	// incurred to date.
	CurrentSpend *money.Money `protobuf:"bytes,14,opt,name=current_spend,json=currentSpend,proto3" json:"current_spend,omitempty"`
	// Output only. Timestamp when this DataLabelingJob was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this DataLabelingJob was updated most recently.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. DataLabelingJob errors. It is only populated when job's state
	// is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
	Error *status.Status `protobuf:"bytes,22,opt,name=error,proto3" json:"error,omitempty"`
	// The labels with user-defined metadata to organize your DataLabelingJobs.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable. Following system labels exist for each DataLabelingJob:
	//
	//   - "aiplatform.googleapis.com/schema": output only, its value is the
	//     [inputs_schema][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s
	//     title.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// The SpecialistPools' resource names associated with this job.
	SpecialistPools []string `protobuf:"bytes,16,rep,name=specialist_pools,json=specialistPools,proto3" json:"specialist_pools,omitempty"`
	// Customer-managed encryption key spec for a DataLabelingJob. If set, this
	// DataLabelingJob will be secured by this key.
	//
	// Note: Annotations created in the DataLabelingJob are associated with
	// the EncryptionSpec of the Dataset they are exported to.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,20,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// Parameters that configure the active learning pipeline. Active learning
	// will label the data incrementally via several iterations. For every
	// iteration, it will select a batch of data based on the sampling strategy.
	ActiveLearningConfig *ActiveLearningConfig `protobuf:"bytes,21,opt,name=active_learning_config,json=activeLearningConfig,proto3" json:"active_learning_config,omitempty"`
	// contains filtered or unexported fields
}

DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset:

func (*DataLabelingJob) Descriptor deprecated

func (*DataLabelingJob) Descriptor() ([]byte, []int)

Deprecated: Use DataLabelingJob.ProtoReflect.Descriptor instead.

func (*DataLabelingJob) GetActiveLearningConfig

func (x *DataLabelingJob) GetActiveLearningConfig() *ActiveLearningConfig

func (*DataLabelingJob) GetAnnotationLabels

func (x *DataLabelingJob) GetAnnotationLabels() map[string]string

func (*DataLabelingJob) GetCreateTime

func (x *DataLabelingJob) GetCreateTime() *timestamppb.Timestamp

func (*DataLabelingJob) GetCurrentSpend

func (x *DataLabelingJob) GetCurrentSpend() *money.Money

func (*DataLabelingJob) GetDatasets

func (x *DataLabelingJob) GetDatasets() []string

func (*DataLabelingJob) GetDisplayName

func (x *DataLabelingJob) GetDisplayName() string

func (*DataLabelingJob) GetEncryptionSpec

func (x *DataLabelingJob) GetEncryptionSpec() *EncryptionSpec

func (*DataLabelingJob) GetError

func (x *DataLabelingJob) GetError() *status.Status

func (*DataLabelingJob) GetInputs

func (x *DataLabelingJob) GetInputs() *structpb.Value

func (*DataLabelingJob) GetInputsSchemaUri

func (x *DataLabelingJob) GetInputsSchemaUri() string

func (*DataLabelingJob) GetInstructionUri

func (x *DataLabelingJob) GetInstructionUri() string

func (*DataLabelingJob) GetLabelerCount

func (x *DataLabelingJob) GetLabelerCount() int32

func (*DataLabelingJob) GetLabelingProgress

func (x *DataLabelingJob) GetLabelingProgress() int32

func (*DataLabelingJob) GetLabels

func (x *DataLabelingJob) GetLabels() map[string]string

func (*DataLabelingJob) GetName

func (x *DataLabelingJob) GetName() string

func (*DataLabelingJob) GetSpecialistPools

func (x *DataLabelingJob) GetSpecialistPools() []string

func (*DataLabelingJob) GetState

func (x *DataLabelingJob) GetState() JobState

func (*DataLabelingJob) GetUpdateTime

func (x *DataLabelingJob) GetUpdateTime() *timestamppb.Timestamp

func (*DataLabelingJob) ProtoMessage

func (*DataLabelingJob) ProtoMessage()

func (*DataLabelingJob) ProtoReflect

func (x *DataLabelingJob) ProtoReflect() protoreflect.Message

func (*DataLabelingJob) Reset

func (x *DataLabelingJob) Reset()

func (*DataLabelingJob) String

func (x *DataLabelingJob) String() string

type Dataset

type Dataset struct {

	// Output only. The resource name of the Dataset.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The user-defined name of the Dataset.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The description of the Dataset.
	Description string `protobuf:"bytes,16,opt,name=description,proto3" json:"description,omitempty"`
	// Required. Points to a YAML file stored on Google Cloud Storage describing
	// additional information about the Dataset. The schema is defined as an
	// OpenAPI 3.0.2 Schema Object. The schema files that can be used here are
	// found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
	MetadataSchemaUri string `protobuf:"bytes,3,opt,name=metadata_schema_uri,json=metadataSchemaUri,proto3" json:"metadata_schema_uri,omitempty"`
	// Required. Additional information about the Dataset.
	Metadata *structpb.Value `protobuf:"bytes,8,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Output only. The number of DataItems in this Dataset. Only apply for
	// non-structured Dataset.
	DataItemCount int64 `protobuf:"varint,10,opt,name=data_item_count,json=dataItemCount,proto3" json:"data_item_count,omitempty"`
	// Output only. Timestamp when this Dataset was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Dataset was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Used to perform consistent read-modify-write updates. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,6,opt,name=etag,proto3" json:"etag,omitempty"`
	// The labels with user-defined metadata to organize your Datasets.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one Dataset (System
	// labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable. Following system labels exist for each Dataset:
	//
	//   - "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
	//     value is the
	//     [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
	//     title.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// All SavedQueries belong to the Dataset will be returned in List/Get
	// Dataset response. The annotation_specs field
	// will not be populated except for UI cases which will only use
	// [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count].
	// In CreateDataset request, a SavedQuery is created together if
	// this field is set, up to one SavedQuery can be set in CreateDatasetRequest.
	// The SavedQuery should not contain any AnnotationSpec.
	SavedQueries []*SavedQuery `protobuf:"bytes,9,rep,name=saved_queries,json=savedQueries,proto3" json:"saved_queries,omitempty"`
	// Customer-managed encryption key spec for a Dataset. If set, this Dataset
	// and all sub-resources of this Dataset will be secured by this key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,11,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// Output only. The resource name of the Artifact that was created in
	// MetadataStore when creating the Dataset. The Artifact resource name pattern
	// is
	// `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
	MetadataArtifact string `protobuf:"bytes,17,opt,name=metadata_artifact,json=metadataArtifact,proto3" json:"metadata_artifact,omitempty"`
	// contains filtered or unexported fields
}

A collection of DataItems and Annotations on them.

func (*Dataset) Descriptor deprecated

func (*Dataset) Descriptor() ([]byte, []int)

Deprecated: Use Dataset.ProtoReflect.Descriptor instead.

func (*Dataset) GetCreateTime

func (x *Dataset) GetCreateTime() *timestamppb.Timestamp

func (*Dataset) GetDataItemCount added in v1.46.0

func (x *Dataset) GetDataItemCount() int64

func (*Dataset) GetDescription

func (x *Dataset) GetDescription() string

func (*Dataset) GetDisplayName

func (x *Dataset) GetDisplayName() string

func (*Dataset) GetEncryptionSpec

func (x *Dataset) GetEncryptionSpec() *EncryptionSpec

func (*Dataset) GetEtag

func (x *Dataset) GetEtag() string

func (*Dataset) GetLabels

func (x *Dataset) GetLabels() map[string]string

func (*Dataset) GetMetadata

func (x *Dataset) GetMetadata() *structpb.Value

func (*Dataset) GetMetadataArtifact

func (x *Dataset) GetMetadataArtifact() string

func (*Dataset) GetMetadataSchemaUri

func (x *Dataset) GetMetadataSchemaUri() string

func (*Dataset) GetName

func (x *Dataset) GetName() string

func (*Dataset) GetSavedQueries added in v1.30.0

func (x *Dataset) GetSavedQueries() []*SavedQuery

func (*Dataset) GetUpdateTime

func (x *Dataset) GetUpdateTime() *timestamppb.Timestamp

func (*Dataset) ProtoMessage

func (*Dataset) ProtoMessage()

func (*Dataset) ProtoReflect

func (x *Dataset) ProtoReflect() protoreflect.Message

func (*Dataset) Reset

func (x *Dataset) Reset()

func (*Dataset) String

func (x *Dataset) String() string

type DatasetServiceClient

type DatasetServiceClient interface {
	// Creates a Dataset.
	CreateDataset(ctx context.Context, in *CreateDatasetRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a Dataset.
	GetDataset(ctx context.Context, in *GetDatasetRequest, opts ...grpc.CallOption) (*Dataset, error)
	// Updates a Dataset.
	UpdateDataset(ctx context.Context, in *UpdateDatasetRequest, opts ...grpc.CallOption) (*Dataset, error)
	// Lists Datasets in a Location.
	ListDatasets(ctx context.Context, in *ListDatasetsRequest, opts ...grpc.CallOption) (*ListDatasetsResponse, error)
	// Deletes a Dataset.
	DeleteDataset(ctx context.Context, in *DeleteDatasetRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Imports data into a Dataset.
	ImportData(ctx context.Context, in *ImportDataRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Exports data from a Dataset.
	ExportData(ctx context.Context, in *ExportDataRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Create a version from a Dataset.
	CreateDatasetVersion(ctx context.Context, in *CreateDatasetVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a Dataset version.
	DeleteDatasetVersion(ctx context.Context, in *DeleteDatasetVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a Dataset version.
	GetDatasetVersion(ctx context.Context, in *GetDatasetVersionRequest, opts ...grpc.CallOption) (*DatasetVersion, error)
	// Lists DatasetVersions in a Dataset.
	ListDatasetVersions(ctx context.Context, in *ListDatasetVersionsRequest, opts ...grpc.CallOption) (*ListDatasetVersionsResponse, error)
	// Restores a dataset version.
	RestoreDatasetVersion(ctx context.Context, in *RestoreDatasetVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Lists DataItems in a Dataset.
	ListDataItems(ctx context.Context, in *ListDataItemsRequest, opts ...grpc.CallOption) (*ListDataItemsResponse, error)
	// Searches DataItems in a Dataset.
	SearchDataItems(ctx context.Context, in *SearchDataItemsRequest, opts ...grpc.CallOption) (*SearchDataItemsResponse, error)
	// Lists SavedQueries in a Dataset.
	ListSavedQueries(ctx context.Context, in *ListSavedQueriesRequest, opts ...grpc.CallOption) (*ListSavedQueriesResponse, error)
	// Deletes a SavedQuery.
	DeleteSavedQuery(ctx context.Context, in *DeleteSavedQueryRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets an AnnotationSpec.
	GetAnnotationSpec(ctx context.Context, in *GetAnnotationSpecRequest, opts ...grpc.CallOption) (*AnnotationSpec, error)
	// Lists Annotations belongs to a dataitem
	ListAnnotations(ctx context.Context, in *ListAnnotationsRequest, opts ...grpc.CallOption) (*ListAnnotationsResponse, error)
}

DatasetServiceClient is the client API for DatasetService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type DatasetServiceServer

type DatasetServiceServer interface {
	// Creates a Dataset.
	CreateDataset(context.Context, *CreateDatasetRequest) (*longrunningpb.Operation, error)
	// Gets a Dataset.
	GetDataset(context.Context, *GetDatasetRequest) (*Dataset, error)
	// Updates a Dataset.
	UpdateDataset(context.Context, *UpdateDatasetRequest) (*Dataset, error)
	// Lists Datasets in a Location.
	ListDatasets(context.Context, *ListDatasetsRequest) (*ListDatasetsResponse, error)
	// Deletes a Dataset.
	DeleteDataset(context.Context, *DeleteDatasetRequest) (*longrunningpb.Operation, error)
	// Imports data into a Dataset.
	ImportData(context.Context, *ImportDataRequest) (*longrunningpb.Operation, error)
	// Exports data from a Dataset.
	ExportData(context.Context, *ExportDataRequest) (*longrunningpb.Operation, error)
	// Create a version from a Dataset.
	CreateDatasetVersion(context.Context, *CreateDatasetVersionRequest) (*longrunningpb.Operation, error)
	// Deletes a Dataset version.
	DeleteDatasetVersion(context.Context, *DeleteDatasetVersionRequest) (*longrunningpb.Operation, error)
	// Gets a Dataset version.
	GetDatasetVersion(context.Context, *GetDatasetVersionRequest) (*DatasetVersion, error)
	// Lists DatasetVersions in a Dataset.
	ListDatasetVersions(context.Context, *ListDatasetVersionsRequest) (*ListDatasetVersionsResponse, error)
	// Restores a dataset version.
	RestoreDatasetVersion(context.Context, *RestoreDatasetVersionRequest) (*longrunningpb.Operation, error)
	// Lists DataItems in a Dataset.
	ListDataItems(context.Context, *ListDataItemsRequest) (*ListDataItemsResponse, error)
	// Searches DataItems in a Dataset.
	SearchDataItems(context.Context, *SearchDataItemsRequest) (*SearchDataItemsResponse, error)
	// Lists SavedQueries in a Dataset.
	ListSavedQueries(context.Context, *ListSavedQueriesRequest) (*ListSavedQueriesResponse, error)
	// Deletes a SavedQuery.
	DeleteSavedQuery(context.Context, *DeleteSavedQueryRequest) (*longrunningpb.Operation, error)
	// Gets an AnnotationSpec.
	GetAnnotationSpec(context.Context, *GetAnnotationSpecRequest) (*AnnotationSpec, error)
	// Lists Annotations belongs to a dataitem
	ListAnnotations(context.Context, *ListAnnotationsRequest) (*ListAnnotationsResponse, error)
}

DatasetServiceServer is the server API for DatasetService service.

type DatasetVersion added in v1.51.0

type DatasetVersion struct {

	// Output only. The resource name of the DatasetVersion.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Timestamp when this DatasetVersion was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this DatasetVersion was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Used to perform consistent read-modify-write updates. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
	// Output only. Name of the associated BigQuery dataset.
	BigQueryDatasetName string `protobuf:"bytes,4,opt,name=big_query_dataset_name,json=bigQueryDatasetName,proto3" json:"big_query_dataset_name,omitempty"`
	// The user-defined name of the DatasetVersion.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,7,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Required. Output only. Additional information about the DatasetVersion.
	Metadata *structpb.Value `protobuf:"bytes,8,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

Describes the dataset version.

func (*DatasetVersion) Descriptor deprecated added in v1.51.0

func (*DatasetVersion) Descriptor() ([]byte, []int)

Deprecated: Use DatasetVersion.ProtoReflect.Descriptor instead.

func (*DatasetVersion) GetBigQueryDatasetName added in v1.51.0

func (x *DatasetVersion) GetBigQueryDatasetName() string

func (*DatasetVersion) GetCreateTime added in v1.51.0

func (x *DatasetVersion) GetCreateTime() *timestamppb.Timestamp

func (*DatasetVersion) GetDisplayName added in v1.63.0

func (x *DatasetVersion) GetDisplayName() string

func (*DatasetVersion) GetEtag added in v1.51.0

func (x *DatasetVersion) GetEtag() string

func (*DatasetVersion) GetMetadata added in v1.63.0

func (x *DatasetVersion) GetMetadata() *structpb.Value

func (*DatasetVersion) GetName added in v1.51.0

func (x *DatasetVersion) GetName() string

func (*DatasetVersion) GetUpdateTime added in v1.51.0

func (x *DatasetVersion) GetUpdateTime() *timestamppb.Timestamp

func (*DatasetVersion) ProtoMessage added in v1.51.0

func (*DatasetVersion) ProtoMessage()

func (*DatasetVersion) ProtoReflect added in v1.51.0

func (x *DatasetVersion) ProtoReflect() protoreflect.Message

func (*DatasetVersion) Reset added in v1.51.0

func (x *DatasetVersion) Reset()

func (*DatasetVersion) String added in v1.51.0

func (x *DatasetVersion) String() string

type DedicatedResources

type DedicatedResources struct {

	// Required. Immutable. The specification of a single machine used by the
	// prediction.
	MachineSpec *MachineSpec `protobuf:"bytes,1,opt,name=machine_spec,json=machineSpec,proto3" json:"machine_spec,omitempty"`
	// Required. Immutable. The minimum number of machine replicas this
	// DeployedModel will be always deployed on. This value must be greater than
	// or equal to 1.
	//
	// If traffic against the DeployedModel increases, it may dynamically be
	// deployed onto more replicas, and as traffic decreases, some of these extra
	// replicas may be freed.
	MinReplicaCount int32 `protobuf:"varint,2,opt,name=min_replica_count,json=minReplicaCount,proto3" json:"min_replica_count,omitempty"`
	// Immutable. The maximum number of replicas this DeployedModel may be
	// deployed on when the traffic against it increases. If the requested value
	// is too large, the deployment will error, but if deployment succeeds then
	// the ability to scale the model to that many replicas is guaranteed (barring
	// service outages). If traffic against the DeployedModel increases beyond
	// what its replicas at maximum may handle, a portion of the traffic will be
	// dropped. If this value is not provided, will use
	// [min_replica_count][google.cloud.aiplatform.v1.DedicatedResources.min_replica_count]
	// as the default value.
	//
	// The value of this field impacts the charge against Vertex CPU and GPU
	// quotas. Specifically, you will be charged for (max_replica_count *
	// number of cores in the selected machine type) and (max_replica_count *
	// number of GPUs per replica in the selected machine type).
	MaxReplicaCount int32 `protobuf:"varint,3,opt,name=max_replica_count,json=maxReplicaCount,proto3" json:"max_replica_count,omitempty"`
	// Immutable. The metric specifications that overrides a resource
	// utilization metric (CPU utilization, accelerator's duty cycle, and so on)
	// target value (default to 60 if not set). At most one entry is allowed per
	// metric.
	//
	// If
	// [machine_spec.accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count]
	// is above 0, the autoscaling will be based on both CPU utilization and
	// accelerator's duty cycle metrics and scale up when either metrics exceeds
	// its target value while scale down if both metrics are under their target
	// value. The default target value is 60 for both metrics.
	//
	// If
	// [machine_spec.accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count]
	// is 0, the autoscaling will be based on CPU utilization metric only with
	// default target value 60 if not explicitly set.
	//
	// For example, in the case of Online Prediction, if you want to override
	// target CPU utilization to 80, you should set
	// [autoscaling_metric_specs.metric_name][google.cloud.aiplatform.v1.AutoscalingMetricSpec.metric_name]
	// to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and
	// [autoscaling_metric_specs.target][google.cloud.aiplatform.v1.AutoscalingMetricSpec.target]
	// to `80`.
	AutoscalingMetricSpecs []*AutoscalingMetricSpec `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.

func (*DedicatedResources) Descriptor deprecated

func (*DedicatedResources) Descriptor() ([]byte, []int)

Deprecated: Use DedicatedResources.ProtoReflect.Descriptor instead.

func (*DedicatedResources) GetAutoscalingMetricSpecs

func (x *DedicatedResources) GetAutoscalingMetricSpecs() []*AutoscalingMetricSpec

func (*DedicatedResources) GetMachineSpec

func (x *DedicatedResources) GetMachineSpec() *MachineSpec

func (*DedicatedResources) GetMaxReplicaCount

func (x *DedicatedResources) GetMaxReplicaCount() int32

func (*DedicatedResources) GetMinReplicaCount

func (x *DedicatedResources) GetMinReplicaCount() int32

func (*DedicatedResources) ProtoMessage

func (*DedicatedResources) ProtoMessage()

func (*DedicatedResources) ProtoReflect

func (x *DedicatedResources) ProtoReflect() protoreflect.Message

func (*DedicatedResources) Reset

func (x *DedicatedResources) Reset()

func (*DedicatedResources) String

func (x *DedicatedResources) String() string

type DeleteArtifactRequest

type DeleteArtifactRequest struct {

	// Required. The resource name of the Artifact to delete.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The etag of the Artifact to delete.
	// If this is provided, it must match the server's etag. Otherwise, the
	// request will fail with a FAILED_PRECONDITION.
	Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.DeleteArtifact][google.cloud.aiplatform.v1.MetadataService.DeleteArtifact].

func (*DeleteArtifactRequest) Descriptor deprecated

func (*DeleteArtifactRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteArtifactRequest.ProtoReflect.Descriptor instead.

func (*DeleteArtifactRequest) GetEtag

func (x *DeleteArtifactRequest) GetEtag() string

func (*DeleteArtifactRequest) GetName

func (x *DeleteArtifactRequest) GetName() string

func (*DeleteArtifactRequest) ProtoMessage

func (*DeleteArtifactRequest) ProtoMessage()

func (*DeleteArtifactRequest) ProtoReflect

func (x *DeleteArtifactRequest) ProtoReflect() protoreflect.Message

func (*DeleteArtifactRequest) Reset

func (x *DeleteArtifactRequest) Reset()

func (*DeleteArtifactRequest) String

func (x *DeleteArtifactRequest) String() string

type DeleteBatchPredictionJobRequest

type DeleteBatchPredictionJobRequest struct {

	// Required. The name of the BatchPredictionJob resource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.DeleteBatchPredictionJob][google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJob].

func (*DeleteBatchPredictionJobRequest) Descriptor deprecated

func (*DeleteBatchPredictionJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteBatchPredictionJobRequest.ProtoReflect.Descriptor instead.

func (*DeleteBatchPredictionJobRequest) GetName

func (*DeleteBatchPredictionJobRequest) ProtoMessage

func (*DeleteBatchPredictionJobRequest) ProtoMessage()

func (*DeleteBatchPredictionJobRequest) ProtoReflect

func (*DeleteBatchPredictionJobRequest) Reset

func (*DeleteBatchPredictionJobRequest) String

type DeleteContextRequest

type DeleteContextRequest struct {

	// Required. The resource name of the Context to delete.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The force deletion semantics is still undefined.
	// Users should not use this field.
	Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	// Optional. The etag of the Context to delete.
	// If this is provided, it must match the server's etag. Otherwise, the
	// request will fail with a FAILED_PRECONDITION.
	Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.DeleteContext][google.cloud.aiplatform.v1.MetadataService.DeleteContext].

func (*DeleteContextRequest) Descriptor deprecated

func (*DeleteContextRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteContextRequest.ProtoReflect.Descriptor instead.

func (*DeleteContextRequest) GetEtag

func (x *DeleteContextRequest) GetEtag() string

func (*DeleteContextRequest) GetForce

func (x *DeleteContextRequest) GetForce() bool

func (*DeleteContextRequest) GetName

func (x *DeleteContextRequest) GetName() string

func (*DeleteContextRequest) ProtoMessage

func (*DeleteContextRequest) ProtoMessage()

func (*DeleteContextRequest) ProtoReflect

func (x *DeleteContextRequest) ProtoReflect() protoreflect.Message

func (*DeleteContextRequest) Reset

func (x *DeleteContextRequest) Reset()

func (*DeleteContextRequest) String

func (x *DeleteContextRequest) String() string

type DeleteCustomJobRequest

type DeleteCustomJobRequest struct {

	// Required. The name of the CustomJob resource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/customJobs/{custom_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.DeleteCustomJob][google.cloud.aiplatform.v1.JobService.DeleteCustomJob].

func (*DeleteCustomJobRequest) Descriptor deprecated

func (*DeleteCustomJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteCustomJobRequest.ProtoReflect.Descriptor instead.

func (*DeleteCustomJobRequest) GetName

func (x *DeleteCustomJobRequest) GetName() string

func (*DeleteCustomJobRequest) ProtoMessage

func (*DeleteCustomJobRequest) ProtoMessage()

func (*DeleteCustomJobRequest) ProtoReflect

func (x *DeleteCustomJobRequest) ProtoReflect() protoreflect.Message

func (*DeleteCustomJobRequest) Reset

func (x *DeleteCustomJobRequest) Reset()

func (*DeleteCustomJobRequest) String

func (x *DeleteCustomJobRequest) String() string

type DeleteDataLabelingJobRequest

type DeleteDataLabelingJobRequest struct {

	// Required. The name of the DataLabelingJob to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.DeleteDataLabelingJob][google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJob].

func (*DeleteDataLabelingJobRequest) Descriptor deprecated

func (*DeleteDataLabelingJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDataLabelingJobRequest.ProtoReflect.Descriptor instead.

func (*DeleteDataLabelingJobRequest) GetName

func (x *DeleteDataLabelingJobRequest) GetName() string

func (*DeleteDataLabelingJobRequest) ProtoMessage

func (*DeleteDataLabelingJobRequest) ProtoMessage()

func (*DeleteDataLabelingJobRequest) ProtoReflect

func (*DeleteDataLabelingJobRequest) Reset

func (x *DeleteDataLabelingJobRequest) Reset()

func (*DeleteDataLabelingJobRequest) String

type DeleteDatasetRequest

type DeleteDatasetRequest struct {

	// Required. The resource name of the Dataset to delete.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.DeleteDataset][google.cloud.aiplatform.v1.DatasetService.DeleteDataset].

func (*DeleteDatasetRequest) Descriptor deprecated

func (*DeleteDatasetRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDatasetRequest.ProtoReflect.Descriptor instead.

func (*DeleteDatasetRequest) GetName

func (x *DeleteDatasetRequest) GetName() string

func (*DeleteDatasetRequest) ProtoMessage

func (*DeleteDatasetRequest) ProtoMessage()

func (*DeleteDatasetRequest) ProtoReflect

func (x *DeleteDatasetRequest) ProtoReflect() protoreflect.Message

func (*DeleteDatasetRequest) Reset

func (x *DeleteDatasetRequest) Reset()

func (*DeleteDatasetRequest) String

func (x *DeleteDatasetRequest) String() string

type DeleteDatasetVersionRequest added in v1.51.0

type DeleteDatasetVersionRequest struct {

	// Required. The resource name of the Dataset version to delete.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.DeleteDatasetVersion][google.cloud.aiplatform.v1.DatasetService.DeleteDatasetVersion].

func (*DeleteDatasetVersionRequest) Descriptor deprecated added in v1.51.0

func (*DeleteDatasetVersionRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDatasetVersionRequest.ProtoReflect.Descriptor instead.

func (*DeleteDatasetVersionRequest) GetName added in v1.51.0

func (x *DeleteDatasetVersionRequest) GetName() string

func (*DeleteDatasetVersionRequest) ProtoMessage added in v1.51.0

func (*DeleteDatasetVersionRequest) ProtoMessage()

func (*DeleteDatasetVersionRequest) ProtoReflect added in v1.51.0

func (*DeleteDatasetVersionRequest) Reset added in v1.51.0

func (x *DeleteDatasetVersionRequest) Reset()

func (*DeleteDatasetVersionRequest) String added in v1.51.0

func (x *DeleteDatasetVersionRequest) String() string

type DeleteDeploymentResourcePoolRequest added in v1.57.0

type DeleteDeploymentResourcePoolRequest struct {

	// Required. The name of the DeploymentResourcePool to delete.
	// Format:
	// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for DeleteDeploymentResourcePool method.

func (*DeleteDeploymentResourcePoolRequest) Descriptor deprecated added in v1.57.0

func (*DeleteDeploymentResourcePoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDeploymentResourcePoolRequest.ProtoReflect.Descriptor instead.

func (*DeleteDeploymentResourcePoolRequest) GetName added in v1.57.0

func (*DeleteDeploymentResourcePoolRequest) ProtoMessage added in v1.57.0

func (*DeleteDeploymentResourcePoolRequest) ProtoMessage()

func (*DeleteDeploymentResourcePoolRequest) ProtoReflect added in v1.57.0

func (*DeleteDeploymentResourcePoolRequest) Reset added in v1.57.0

func (*DeleteDeploymentResourcePoolRequest) String added in v1.57.0

type DeleteEndpointRequest

type DeleteEndpointRequest struct {

	// Required. The name of the Endpoint resource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EndpointService.DeleteEndpoint][google.cloud.aiplatform.v1.EndpointService.DeleteEndpoint].

func (*DeleteEndpointRequest) Descriptor deprecated

func (*DeleteEndpointRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteEndpointRequest.ProtoReflect.Descriptor instead.

func (*DeleteEndpointRequest) GetName

func (x *DeleteEndpointRequest) GetName() string

func (*DeleteEndpointRequest) ProtoMessage

func (*DeleteEndpointRequest) ProtoMessage()

func (*DeleteEndpointRequest) ProtoReflect

func (x *DeleteEndpointRequest) ProtoReflect() protoreflect.Message

func (*DeleteEndpointRequest) Reset

func (x *DeleteEndpointRequest) Reset()

func (*DeleteEndpointRequest) String

func (x *DeleteEndpointRequest) String() string

type DeleteEntityTypeRequest

type DeleteEntityTypeRequest struct {

	// Required. The name of the EntityType to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If set to true, any Features for this EntityType will also be deleted.
	// (Otherwise, the request will only work if the EntityType has no Features.)
	Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.DeleteEntityTypes][].

func (*DeleteEntityTypeRequest) Descriptor deprecated

func (*DeleteEntityTypeRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteEntityTypeRequest.ProtoReflect.Descriptor instead.

func (*DeleteEntityTypeRequest) GetForce

func (x *DeleteEntityTypeRequest) GetForce() bool

func (*DeleteEntityTypeRequest) GetName

func (x *DeleteEntityTypeRequest) GetName() string

func (*DeleteEntityTypeRequest) ProtoMessage

func (*DeleteEntityTypeRequest) ProtoMessage()

func (*DeleteEntityTypeRequest) ProtoReflect

func (x *DeleteEntityTypeRequest) ProtoReflect() protoreflect.Message

func (*DeleteEntityTypeRequest) Reset

func (x *DeleteEntityTypeRequest) Reset()

func (*DeleteEntityTypeRequest) String

func (x *DeleteEntityTypeRequest) String() string

type DeleteExecutionRequest

type DeleteExecutionRequest struct {

	// Required. The resource name of the Execution to delete.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The etag of the Execution to delete.
	// If this is provided, it must match the server's etag. Otherwise, the
	// request will fail with a FAILED_PRECONDITION.
	Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.DeleteExecution][google.cloud.aiplatform.v1.MetadataService.DeleteExecution].

func (*DeleteExecutionRequest) Descriptor deprecated

func (*DeleteExecutionRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteExecutionRequest.ProtoReflect.Descriptor instead.

func (*DeleteExecutionRequest) GetEtag

func (x *DeleteExecutionRequest) GetEtag() string

func (*DeleteExecutionRequest) GetName

func (x *DeleteExecutionRequest) GetName() string

func (*DeleteExecutionRequest) ProtoMessage

func (*DeleteExecutionRequest) ProtoMessage()

func (*DeleteExecutionRequest) ProtoReflect

func (x *DeleteExecutionRequest) ProtoReflect() protoreflect.Message

func (*DeleteExecutionRequest) Reset

func (x *DeleteExecutionRequest) Reset()

func (*DeleteExecutionRequest) String

func (x *DeleteExecutionRequest) String() string

type DeleteFeatureGroupRequest added in v1.54.0

type DeleteFeatureGroupRequest struct {

	// Required. The name of the FeatureGroup to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/featureGroups/{feature_group}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If set to true, any Features under this FeatureGroup
	// will also be deleted. (Otherwise, the request will only work if the
	// FeatureGroup has no Features.)
	Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureRegistryService.DeleteFeatureGroup][google.cloud.aiplatform.v1.FeatureRegistryService.DeleteFeatureGroup].

func (*DeleteFeatureGroupRequest) Descriptor deprecated added in v1.54.0

func (*DeleteFeatureGroupRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFeatureGroupRequest.ProtoReflect.Descriptor instead.

func (*DeleteFeatureGroupRequest) GetForce added in v1.54.0

func (x *DeleteFeatureGroupRequest) GetForce() bool

func (*DeleteFeatureGroupRequest) GetName added in v1.54.0

func (x *DeleteFeatureGroupRequest) GetName() string

func (*DeleteFeatureGroupRequest) ProtoMessage added in v1.54.0

func (*DeleteFeatureGroupRequest) ProtoMessage()

func (*DeleteFeatureGroupRequest) ProtoReflect added in v1.54.0

func (*DeleteFeatureGroupRequest) Reset added in v1.54.0

func (x *DeleteFeatureGroupRequest) Reset()

func (*DeleteFeatureGroupRequest) String added in v1.54.0

func (x *DeleteFeatureGroupRequest) String() string

type DeleteFeatureOnlineStoreRequest added in v1.54.0

type DeleteFeatureOnlineStoreRequest struct {

	// Required. The name of the FeatureOnlineStore to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If set to true, any FeatureViews and Features for this FeatureOnlineStore
	// will also be deleted. (Otherwise, the request will only work if the
	// FeatureOnlineStore has no FeatureViews.)
	Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.DeleteFeatureOnlineStore][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.DeleteFeatureOnlineStore].

func (*DeleteFeatureOnlineStoreRequest) Descriptor deprecated added in v1.54.0

func (*DeleteFeatureOnlineStoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFeatureOnlineStoreRequest.ProtoReflect.Descriptor instead.

func (*DeleteFeatureOnlineStoreRequest) GetForce added in v1.54.0

func (x *DeleteFeatureOnlineStoreRequest) GetForce() bool

func (*DeleteFeatureOnlineStoreRequest) GetName added in v1.54.0

func (*DeleteFeatureOnlineStoreRequest) ProtoMessage added in v1.54.0

func (*DeleteFeatureOnlineStoreRequest) ProtoMessage()

func (*DeleteFeatureOnlineStoreRequest) ProtoReflect added in v1.54.0

func (*DeleteFeatureOnlineStoreRequest) Reset added in v1.54.0

func (*DeleteFeatureOnlineStoreRequest) String added in v1.54.0

type DeleteFeatureRequest

type DeleteFeatureRequest struct {

	// Required. The name of the Features to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
	// `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.DeleteFeature][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeature]. Request message for [FeatureRegistryService.DeleteFeature][google.cloud.aiplatform.v1.FeatureRegistryService.DeleteFeature].

func (*DeleteFeatureRequest) Descriptor deprecated

func (*DeleteFeatureRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFeatureRequest.ProtoReflect.Descriptor instead.

func (*DeleteFeatureRequest) GetName

func (x *DeleteFeatureRequest) GetName() string

func (*DeleteFeatureRequest) ProtoMessage

func (*DeleteFeatureRequest) ProtoMessage()

func (*DeleteFeatureRequest) ProtoReflect

func (x *DeleteFeatureRequest) ProtoReflect() protoreflect.Message

func (*DeleteFeatureRequest) Reset

func (x *DeleteFeatureRequest) Reset()

func (*DeleteFeatureRequest) String

func (x *DeleteFeatureRequest) String() string

type DeleteFeatureValuesOperationMetadata added in v1.36.0

type DeleteFeatureValuesOperationMetadata struct {

	// Operation metadata for Featurestore delete Features values.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that delete Feature values.

func (*DeleteFeatureValuesOperationMetadata) Descriptor deprecated added in v1.36.0

func (*DeleteFeatureValuesOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFeatureValuesOperationMetadata.ProtoReflect.Descriptor instead.

func (*DeleteFeatureValuesOperationMetadata) GetGenericMetadata added in v1.36.0

func (*DeleteFeatureValuesOperationMetadata) ProtoMessage added in v1.36.0

func (*DeleteFeatureValuesOperationMetadata) ProtoMessage()

func (*DeleteFeatureValuesOperationMetadata) ProtoReflect added in v1.36.0

func (*DeleteFeatureValuesOperationMetadata) Reset added in v1.36.0

func (*DeleteFeatureValuesOperationMetadata) String added in v1.36.0

type DeleteFeatureValuesRequest added in v1.36.0

type DeleteFeatureValuesRequest struct {

	// Defines options to select feature values to be deleted.
	//
	// Types that are assignable to DeleteOption:
	//
	//	*DeleteFeatureValuesRequest_SelectEntity_
	//	*DeleteFeatureValuesRequest_SelectTimeRangeAndFeature_
	DeleteOption isDeleteFeatureValuesRequest_DeleteOption `protobuf_oneof:"DeleteOption"`
	// Required. The resource name of the EntityType grouping the Features for
	// which values are being deleted from. Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
	EntityType string `protobuf:"bytes,1,opt,name=entity_type,json=entityType,proto3" json:"entity_type,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeatureValues].

func (*DeleteFeatureValuesRequest) Descriptor deprecated added in v1.36.0

func (*DeleteFeatureValuesRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFeatureValuesRequest.ProtoReflect.Descriptor instead.

func (*DeleteFeatureValuesRequest) GetDeleteOption added in v1.36.0

func (m *DeleteFeatureValuesRequest) GetDeleteOption() isDeleteFeatureValuesRequest_DeleteOption

func (*DeleteFeatureValuesRequest) GetEntityType added in v1.36.0

func (x *DeleteFeatureValuesRequest) GetEntityType() string

func (*DeleteFeatureValuesRequest) GetSelectEntity added in v1.36.0

func (*DeleteFeatureValuesRequest) GetSelectTimeRangeAndFeature added in v1.36.0

func (*DeleteFeatureValuesRequest) ProtoMessage added in v1.36.0

func (*DeleteFeatureValuesRequest) ProtoMessage()

func (*DeleteFeatureValuesRequest) ProtoReflect added in v1.36.0

func (*DeleteFeatureValuesRequest) Reset added in v1.36.0

func (x *DeleteFeatureValuesRequest) Reset()

func (*DeleteFeatureValuesRequest) String added in v1.36.0

func (x *DeleteFeatureValuesRequest) String() string

type DeleteFeatureValuesRequest_SelectEntity added in v1.36.0

type DeleteFeatureValuesRequest_SelectEntity struct {

	// Required. Selectors choosing feature values of which entity id to be
	// deleted from the EntityType.
	EntityIdSelector *EntityIdSelector `protobuf:"bytes,1,opt,name=entity_id_selector,json=entityIdSelector,proto3" json:"entity_id_selector,omitempty"`
	// contains filtered or unexported fields
}

Message to select entity. If an entity id is selected, all the feature values corresponding to the entity id will be deleted, including the entityId.

func (*DeleteFeatureValuesRequest_SelectEntity) Descriptor deprecated added in v1.36.0

func (*DeleteFeatureValuesRequest_SelectEntity) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFeatureValuesRequest_SelectEntity.ProtoReflect.Descriptor instead.

func (*DeleteFeatureValuesRequest_SelectEntity) GetEntityIdSelector added in v1.36.0

func (*DeleteFeatureValuesRequest_SelectEntity) ProtoMessage added in v1.36.0

func (*DeleteFeatureValuesRequest_SelectEntity) ProtoReflect added in v1.36.0

func (*DeleteFeatureValuesRequest_SelectEntity) Reset added in v1.36.0

func (*DeleteFeatureValuesRequest_SelectEntity) String added in v1.36.0

type DeleteFeatureValuesRequest_SelectEntity_ added in v1.36.0

type DeleteFeatureValuesRequest_SelectEntity_ struct {
	// Select feature values to be deleted by specifying entities.
	SelectEntity *DeleteFeatureValuesRequest_SelectEntity `protobuf:"bytes,2,opt,name=select_entity,json=selectEntity,proto3,oneof"`
}

type DeleteFeatureValuesRequest_SelectTimeRangeAndFeature added in v1.36.0

type DeleteFeatureValuesRequest_SelectTimeRangeAndFeature struct {

	// Required. Select feature generated within a half-inclusive time range.
	// The time range is lower inclusive and upper exclusive.
	TimeRange *interval.Interval `protobuf:"bytes,1,opt,name=time_range,json=timeRange,proto3" json:"time_range,omitempty"`
	// Required. Selectors choosing which feature values to be deleted from the
	// EntityType.
	FeatureSelector *FeatureSelector `protobuf:"bytes,2,opt,name=feature_selector,json=featureSelector,proto3" json:"feature_selector,omitempty"`
	// If set, data will not be deleted from online storage.
	// When time range is older than the data in online storage, setting this to
	// be true will make the deletion have no impact on online serving.
	SkipOnlineStorageDelete bool `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

Message to select time range and feature. Values of the selected feature generated within an inclusive time range will be deleted. Using this option permanently deletes the feature values from the specified feature IDs within the specified time range. This might include data from the online storage. If you want to retain any deleted historical data in the online storage, you must re-ingest it.

func (*DeleteFeatureValuesRequest_SelectTimeRangeAndFeature) Descriptor deprecated added in v1.36.0

Deprecated: Use DeleteFeatureValuesRequest_SelectTimeRangeAndFeature.ProtoReflect.Descriptor instead.

func (*DeleteFeatureValuesRequest_SelectTimeRangeAndFeature) GetFeatureSelector added in v1.36.0

func (*DeleteFeatureValuesRequest_SelectTimeRangeAndFeature) GetSkipOnlineStorageDelete added in v1.36.0

func (x *DeleteFeatureValuesRequest_SelectTimeRangeAndFeature) GetSkipOnlineStorageDelete() bool

func (*DeleteFeatureValuesRequest_SelectTimeRangeAndFeature) GetTimeRange added in v1.36.0

func (*DeleteFeatureValuesRequest_SelectTimeRangeAndFeature) ProtoMessage added in v1.36.0

func (*DeleteFeatureValuesRequest_SelectTimeRangeAndFeature) ProtoReflect added in v1.36.0

func (*DeleteFeatureValuesRequest_SelectTimeRangeAndFeature) Reset added in v1.36.0

func (*DeleteFeatureValuesRequest_SelectTimeRangeAndFeature) String added in v1.36.0

type DeleteFeatureValuesRequest_SelectTimeRangeAndFeature_ added in v1.36.0

type DeleteFeatureValuesRequest_SelectTimeRangeAndFeature_ struct {
	// Select feature values to be deleted by specifying time range and
	// features.
	SelectTimeRangeAndFeature *DeleteFeatureValuesRequest_SelectTimeRangeAndFeature `protobuf:"bytes,3,opt,name=select_time_range_and_feature,json=selectTimeRangeAndFeature,proto3,oneof"`
}

type DeleteFeatureValuesResponse added in v1.36.0

type DeleteFeatureValuesResponse struct {

	// Response based on which delete option is specified in the
	// request
	//
	// Types that are assignable to Response:
	//
	//	*DeleteFeatureValuesResponse_SelectEntity_
	//	*DeleteFeatureValuesResponse_SelectTimeRangeAndFeature_
	Response isDeleteFeatureValuesResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

Response message for [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeatureValues].

func (*DeleteFeatureValuesResponse) Descriptor deprecated added in v1.36.0

func (*DeleteFeatureValuesResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFeatureValuesResponse.ProtoReflect.Descriptor instead.

func (*DeleteFeatureValuesResponse) GetResponse added in v1.36.0

func (m *DeleteFeatureValuesResponse) GetResponse() isDeleteFeatureValuesResponse_Response

func (*DeleteFeatureValuesResponse) GetSelectEntity added in v1.36.0

func (*DeleteFeatureValuesResponse) GetSelectTimeRangeAndFeature added in v1.36.0

func (*DeleteFeatureValuesResponse) ProtoMessage added in v1.36.0

func (*DeleteFeatureValuesResponse) ProtoMessage()

func (*DeleteFeatureValuesResponse) ProtoReflect added in v1.36.0

func (*DeleteFeatureValuesResponse) Reset added in v1.36.0

func (x *DeleteFeatureValuesResponse) Reset()

func (*DeleteFeatureValuesResponse) String added in v1.36.0

func (x *DeleteFeatureValuesResponse) String() string

type DeleteFeatureValuesResponse_SelectEntity added in v1.36.0

type DeleteFeatureValuesResponse_SelectEntity struct {

	// The count of deleted entity rows in the offline storage.
	// Each row corresponds to the combination of an entity ID and a timestamp.
	// One entity ID can have multiple rows in the offline storage.
	OfflineStorageDeletedEntityRowCount int64 `` /* 175-byte string literal not displayed */
	// The count of deleted entities in the online storage.
	// Each entity ID corresponds to one entity.
	OnlineStorageDeletedEntityCount int64 `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message if the request uses the SelectEntity option.

func (*DeleteFeatureValuesResponse_SelectEntity) Descriptor deprecated added in v1.36.0

func (*DeleteFeatureValuesResponse_SelectEntity) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFeatureValuesResponse_SelectEntity.ProtoReflect.Descriptor instead.

func (*DeleteFeatureValuesResponse_SelectEntity) GetOfflineStorageDeletedEntityRowCount added in v1.36.0

func (x *DeleteFeatureValuesResponse_SelectEntity) GetOfflineStorageDeletedEntityRowCount() int64

func (*DeleteFeatureValuesResponse_SelectEntity) GetOnlineStorageDeletedEntityCount added in v1.36.0

func (x *DeleteFeatureValuesResponse_SelectEntity) GetOnlineStorageDeletedEntityCount() int64

func (*DeleteFeatureValuesResponse_SelectEntity) ProtoMessage added in v1.36.0

func (*DeleteFeatureValuesResponse_SelectEntity) ProtoReflect added in v1.36.0

func (*DeleteFeatureValuesResponse_SelectEntity) Reset added in v1.36.0

func (*DeleteFeatureValuesResponse_SelectEntity) String added in v1.36.0

type DeleteFeatureValuesResponse_SelectEntity_ added in v1.36.0

type DeleteFeatureValuesResponse_SelectEntity_ struct {
	// Response for request specifying the entities to delete
	SelectEntity *DeleteFeatureValuesResponse_SelectEntity `protobuf:"bytes,1,opt,name=select_entity,json=selectEntity,proto3,oneof"`
}

type DeleteFeatureValuesResponse_SelectTimeRangeAndFeature added in v1.36.0

type DeleteFeatureValuesResponse_SelectTimeRangeAndFeature struct {

	// The count of the features or columns impacted.
	// This is the same as the feature count in the request.
	ImpactedFeatureCount int64 `protobuf:"varint,1,opt,name=impacted_feature_count,json=impactedFeatureCount,proto3" json:"impacted_feature_count,omitempty"`
	// The count of modified entity rows in the offline storage.
	// Each row corresponds to the combination of an entity ID and a timestamp.
	// One entity ID can have multiple rows in the offline storage.
	// Within each row, only the features specified in the request are
	// deleted.
	OfflineStorageModifiedEntityRowCount int64 `` /* 178-byte string literal not displayed */
	// The count of modified entities in the online storage.
	// Each entity ID corresponds to one entity.
	// Within each entity, only the features specified in the request are
	// deleted.
	OnlineStorageModifiedEntityCount int64 `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message if the request uses the SelectTimeRangeAndFeature option.

func (*DeleteFeatureValuesResponse_SelectTimeRangeAndFeature) Descriptor deprecated added in v1.36.0

Deprecated: Use DeleteFeatureValuesResponse_SelectTimeRangeAndFeature.ProtoReflect.Descriptor instead.

func (*DeleteFeatureValuesResponse_SelectTimeRangeAndFeature) GetImpactedFeatureCount added in v1.36.0

func (x *DeleteFeatureValuesResponse_SelectTimeRangeAndFeature) GetImpactedFeatureCount() int64

func (*DeleteFeatureValuesResponse_SelectTimeRangeAndFeature) GetOfflineStorageModifiedEntityRowCount added in v1.36.0

func (x *DeleteFeatureValuesResponse_SelectTimeRangeAndFeature) GetOfflineStorageModifiedEntityRowCount() int64

func (*DeleteFeatureValuesResponse_SelectTimeRangeAndFeature) GetOnlineStorageModifiedEntityCount added in v1.36.0

func (x *DeleteFeatureValuesResponse_SelectTimeRangeAndFeature) GetOnlineStorageModifiedEntityCount() int64

func (*DeleteFeatureValuesResponse_SelectTimeRangeAndFeature) ProtoMessage added in v1.36.0

func (*DeleteFeatureValuesResponse_SelectTimeRangeAndFeature) ProtoReflect added in v1.36.0

func (*DeleteFeatureValuesResponse_SelectTimeRangeAndFeature) Reset added in v1.36.0

func (*DeleteFeatureValuesResponse_SelectTimeRangeAndFeature) String added in v1.36.0

type DeleteFeatureValuesResponse_SelectTimeRangeAndFeature_ added in v1.36.0

type DeleteFeatureValuesResponse_SelectTimeRangeAndFeature_ struct {
	// Response for request specifying time range and feature
	SelectTimeRangeAndFeature *DeleteFeatureValuesResponse_SelectTimeRangeAndFeature `protobuf:"bytes,2,opt,name=select_time_range_and_feature,json=selectTimeRangeAndFeature,proto3,oneof"`
}

type DeleteFeatureViewRequest added in v1.54.0

type DeleteFeatureViewRequest struct {

	// Required. The name of the FeatureView to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.DeleteFeatureViews][].

func (*DeleteFeatureViewRequest) Descriptor deprecated added in v1.54.0

func (*DeleteFeatureViewRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFeatureViewRequest.ProtoReflect.Descriptor instead.

func (*DeleteFeatureViewRequest) GetName added in v1.54.0

func (x *DeleteFeatureViewRequest) GetName() string

func (*DeleteFeatureViewRequest) ProtoMessage added in v1.54.0

func (*DeleteFeatureViewRequest) ProtoMessage()

func (*DeleteFeatureViewRequest) ProtoReflect added in v1.54.0

func (x *DeleteFeatureViewRequest) ProtoReflect() protoreflect.Message

func (*DeleteFeatureViewRequest) Reset added in v1.54.0

func (x *DeleteFeatureViewRequest) Reset()

func (*DeleteFeatureViewRequest) String added in v1.54.0

func (x *DeleteFeatureViewRequest) String() string

type DeleteFeaturestoreRequest

type DeleteFeaturestoreRequest struct {

	// Required. The name of the Featurestore to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If set to true, any EntityTypes and Features for this Featurestore will
	// also be deleted. (Otherwise, the request will only work if the Featurestore
	// has no EntityTypes.)
	Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.DeleteFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeaturestore].

func (*DeleteFeaturestoreRequest) Descriptor deprecated

func (*DeleteFeaturestoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFeaturestoreRequest.ProtoReflect.Descriptor instead.

func (*DeleteFeaturestoreRequest) GetForce

func (x *DeleteFeaturestoreRequest) GetForce() bool

func (*DeleteFeaturestoreRequest) GetName

func (x *DeleteFeaturestoreRequest) GetName() string

func (*DeleteFeaturestoreRequest) ProtoMessage

func (*DeleteFeaturestoreRequest) ProtoMessage()

func (*DeleteFeaturestoreRequest) ProtoReflect

func (*DeleteFeaturestoreRequest) Reset

func (x *DeleteFeaturestoreRequest) Reset()

func (*DeleteFeaturestoreRequest) String

func (x *DeleteFeaturestoreRequest) String() string

type DeleteHyperparameterTuningJobRequest

type DeleteHyperparameterTuningJobRequest struct {

	// Required. The name of the HyperparameterTuningJob resource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.DeleteHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.DeleteHyperparameterTuningJob].

func (*DeleteHyperparameterTuningJobRequest) Descriptor deprecated

func (*DeleteHyperparameterTuningJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteHyperparameterTuningJobRequest.ProtoReflect.Descriptor instead.

func (*DeleteHyperparameterTuningJobRequest) GetName

func (*DeleteHyperparameterTuningJobRequest) ProtoMessage

func (*DeleteHyperparameterTuningJobRequest) ProtoMessage()

func (*DeleteHyperparameterTuningJobRequest) ProtoReflect

func (*DeleteHyperparameterTuningJobRequest) Reset

func (*DeleteHyperparameterTuningJobRequest) String

type DeleteIndexEndpointRequest

type DeleteIndexEndpointRequest struct {

	// Required. The name of the IndexEndpoint resource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexEndpointService.DeleteIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.DeleteIndexEndpoint].

func (*DeleteIndexEndpointRequest) Descriptor deprecated

func (*DeleteIndexEndpointRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteIndexEndpointRequest.ProtoReflect.Descriptor instead.

func (*DeleteIndexEndpointRequest) GetName

func (x *DeleteIndexEndpointRequest) GetName() string

func (*DeleteIndexEndpointRequest) ProtoMessage

func (*DeleteIndexEndpointRequest) ProtoMessage()

func (*DeleteIndexEndpointRequest) ProtoReflect

func (*DeleteIndexEndpointRequest) Reset

func (x *DeleteIndexEndpointRequest) Reset()

func (*DeleteIndexEndpointRequest) String

func (x *DeleteIndexEndpointRequest) String() string

type DeleteIndexRequest

type DeleteIndexRequest struct {

	// Required. The name of the Index resource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/indexes/{index}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexService.DeleteIndex][google.cloud.aiplatform.v1.IndexService.DeleteIndex].

func (*DeleteIndexRequest) Descriptor deprecated

func (*DeleteIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteIndexRequest.ProtoReflect.Descriptor instead.

func (*DeleteIndexRequest) GetName

func (x *DeleteIndexRequest) GetName() string

func (*DeleteIndexRequest) ProtoMessage

func (*DeleteIndexRequest) ProtoMessage()

func (*DeleteIndexRequest) ProtoReflect

func (x *DeleteIndexRequest) ProtoReflect() protoreflect.Message

func (*DeleteIndexRequest) Reset

func (x *DeleteIndexRequest) Reset()

func (*DeleteIndexRequest) String

func (x *DeleteIndexRequest) String() string

type DeleteMetadataStoreOperationMetadata

type DeleteMetadataStoreOperationMetadata struct {

	// Operation metadata for deleting a MetadataStore.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore].

func (*DeleteMetadataStoreOperationMetadata) Descriptor deprecated

func (*DeleteMetadataStoreOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DeleteMetadataStoreOperationMetadata.ProtoReflect.Descriptor instead.

func (*DeleteMetadataStoreOperationMetadata) GetGenericMetadata

func (*DeleteMetadataStoreOperationMetadata) ProtoMessage

func (*DeleteMetadataStoreOperationMetadata) ProtoMessage()

func (*DeleteMetadataStoreOperationMetadata) ProtoReflect

func (*DeleteMetadataStoreOperationMetadata) Reset

func (*DeleteMetadataStoreOperationMetadata) String

type DeleteMetadataStoreRequest

type DeleteMetadataStoreRequest struct {

	// Required. The resource name of the MetadataStore to delete.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Deprecated: Field is no longer supported.
	//
	// Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/metadata_service.proto.
	Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore].

func (*DeleteMetadataStoreRequest) Descriptor deprecated

func (*DeleteMetadataStoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteMetadataStoreRequest.ProtoReflect.Descriptor instead.

func (*DeleteMetadataStoreRequest) GetForce deprecated

func (x *DeleteMetadataStoreRequest) GetForce() bool

Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/metadata_service.proto.

func (*DeleteMetadataStoreRequest) GetName

func (x *DeleteMetadataStoreRequest) GetName() string

func (*DeleteMetadataStoreRequest) ProtoMessage

func (*DeleteMetadataStoreRequest) ProtoMessage()

func (*DeleteMetadataStoreRequest) ProtoReflect

func (*DeleteMetadataStoreRequest) Reset

func (x *DeleteMetadataStoreRequest) Reset()

func (*DeleteMetadataStoreRequest) String

func (x *DeleteMetadataStoreRequest) String() string

type DeleteModelDeploymentMonitoringJobRequest

type DeleteModelDeploymentMonitoringJobRequest struct {

	// Required. The resource name of the model monitoring job to delete.
	// Format:
	// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.DeleteModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.DeleteModelDeploymentMonitoringJob].

func (*DeleteModelDeploymentMonitoringJobRequest) Descriptor deprecated

func (*DeleteModelDeploymentMonitoringJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteModelDeploymentMonitoringJobRequest.ProtoReflect.Descriptor instead.

func (*DeleteModelDeploymentMonitoringJobRequest) GetName

func (*DeleteModelDeploymentMonitoringJobRequest) ProtoMessage

func (*DeleteModelDeploymentMonitoringJobRequest) ProtoReflect

func (*DeleteModelDeploymentMonitoringJobRequest) Reset

func (*DeleteModelDeploymentMonitoringJobRequest) String

type DeleteModelRequest

type DeleteModelRequest struct {

	// Required. The name of the Model resource to be deleted.
	// Format: `projects/{project}/locations/{location}/models/{model}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel].

func (*DeleteModelRequest) Descriptor deprecated

func (*DeleteModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteModelRequest.ProtoReflect.Descriptor instead.

func (*DeleteModelRequest) GetName

func (x *DeleteModelRequest) GetName() string

func (*DeleteModelRequest) ProtoMessage

func (*DeleteModelRequest) ProtoMessage()

func (*DeleteModelRequest) ProtoReflect

func (x *DeleteModelRequest) ProtoReflect() protoreflect.Message

func (*DeleteModelRequest) Reset

func (x *DeleteModelRequest) Reset()

func (*DeleteModelRequest) String

func (x *DeleteModelRequest) String() string

type DeleteModelVersionRequest

type DeleteModelVersionRequest struct {

	// Required. The name of the model version to be deleted, with a version ID
	// explicitly included.
	//
	// Example: `projects/{project}/locations/{location}/models/{model}@1234`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.DeleteModelVersion][google.cloud.aiplatform.v1.ModelService.DeleteModelVersion].

func (*DeleteModelVersionRequest) Descriptor deprecated

func (*DeleteModelVersionRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteModelVersionRequest.ProtoReflect.Descriptor instead.

func (*DeleteModelVersionRequest) GetName

func (x *DeleteModelVersionRequest) GetName() string

func (*DeleteModelVersionRequest) ProtoMessage

func (*DeleteModelVersionRequest) ProtoMessage()

func (*DeleteModelVersionRequest) ProtoReflect

func (*DeleteModelVersionRequest) Reset

func (x *DeleteModelVersionRequest) Reset()

func (*DeleteModelVersionRequest) String

func (x *DeleteModelVersionRequest) String() string

type DeleteNasJobRequest added in v1.34.0

type DeleteNasJobRequest struct {

	// Required. The name of the NasJob resource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/nasJobs/{nas_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.DeleteNasJob][google.cloud.aiplatform.v1.JobService.DeleteNasJob].

func (*DeleteNasJobRequest) Descriptor deprecated added in v1.34.0

func (*DeleteNasJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteNasJobRequest.ProtoReflect.Descriptor instead.

func (*DeleteNasJobRequest) GetName added in v1.34.0

func (x *DeleteNasJobRequest) GetName() string

func (*DeleteNasJobRequest) ProtoMessage added in v1.34.0

func (*DeleteNasJobRequest) ProtoMessage()

func (*DeleteNasJobRequest) ProtoReflect added in v1.34.0

func (x *DeleteNasJobRequest) ProtoReflect() protoreflect.Message

func (*DeleteNasJobRequest) Reset added in v1.34.0

func (x *DeleteNasJobRequest) Reset()

func (*DeleteNasJobRequest) String added in v1.34.0

func (x *DeleteNasJobRequest) String() string

type DeleteNotebookRuntimeRequest added in v1.67.0

type DeleteNotebookRuntimeRequest struct {

	// Required. The name of the NotebookRuntime resource to be deleted.
	// Instead of checking whether the name is in valid NotebookRuntime resource
	// name format, directly throw NotFound exception if there is no such
	// NotebookRuntime in spanner.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [NotebookService.DeleteNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.DeleteNotebookRuntime].

func (*DeleteNotebookRuntimeRequest) Descriptor deprecated added in v1.67.0

func (*DeleteNotebookRuntimeRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteNotebookRuntimeRequest.ProtoReflect.Descriptor instead.

func (*DeleteNotebookRuntimeRequest) GetName added in v1.67.0

func (x *DeleteNotebookRuntimeRequest) GetName() string

func (*DeleteNotebookRuntimeRequest) ProtoMessage added in v1.67.0

func (*DeleteNotebookRuntimeRequest) ProtoMessage()

func (*DeleteNotebookRuntimeRequest) ProtoReflect added in v1.67.0

func (*DeleteNotebookRuntimeRequest) Reset added in v1.67.0

func (x *DeleteNotebookRuntimeRequest) Reset()

func (*DeleteNotebookRuntimeRequest) String added in v1.67.0

type DeleteNotebookRuntimeTemplateRequest added in v1.67.0

type DeleteNotebookRuntimeTemplateRequest struct {

	// Required. The name of the NotebookRuntimeTemplate resource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [NotebookService.DeleteNotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookService.DeleteNotebookRuntimeTemplate].

func (*DeleteNotebookRuntimeTemplateRequest) Descriptor deprecated added in v1.67.0

func (*DeleteNotebookRuntimeTemplateRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteNotebookRuntimeTemplateRequest.ProtoReflect.Descriptor instead.

func (*DeleteNotebookRuntimeTemplateRequest) GetName added in v1.67.0

func (*DeleteNotebookRuntimeTemplateRequest) ProtoMessage added in v1.67.0

func (*DeleteNotebookRuntimeTemplateRequest) ProtoMessage()

func (*DeleteNotebookRuntimeTemplateRequest) ProtoReflect added in v1.67.0

func (*DeleteNotebookRuntimeTemplateRequest) Reset added in v1.67.0

func (*DeleteNotebookRuntimeTemplateRequest) String added in v1.67.0

type DeleteOperationMetadata

type DeleteOperationMetadata struct {

	// The common part of the operation metadata.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform deletes of any entities.

func (*DeleteOperationMetadata) Descriptor deprecated

func (*DeleteOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DeleteOperationMetadata.ProtoReflect.Descriptor instead.

func (*DeleteOperationMetadata) GetGenericMetadata

func (x *DeleteOperationMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*DeleteOperationMetadata) ProtoMessage

func (*DeleteOperationMetadata) ProtoMessage()

func (*DeleteOperationMetadata) ProtoReflect

func (x *DeleteOperationMetadata) ProtoReflect() protoreflect.Message

func (*DeleteOperationMetadata) Reset

func (x *DeleteOperationMetadata) Reset()

func (*DeleteOperationMetadata) String

func (x *DeleteOperationMetadata) String() string

type DeletePersistentResourceRequest added in v1.67.0

type DeletePersistentResourceRequest struct {

	// Required. The name of the PersistentResource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PersistentResourceService.DeletePersistentResource][google.cloud.aiplatform.v1.PersistentResourceService.DeletePersistentResource].

func (*DeletePersistentResourceRequest) Descriptor deprecated added in v1.67.0

func (*DeletePersistentResourceRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeletePersistentResourceRequest.ProtoReflect.Descriptor instead.

func (*DeletePersistentResourceRequest) GetName added in v1.67.0

func (*DeletePersistentResourceRequest) ProtoMessage added in v1.67.0

func (*DeletePersistentResourceRequest) ProtoMessage()

func (*DeletePersistentResourceRequest) ProtoReflect added in v1.67.0

func (*DeletePersistentResourceRequest) Reset added in v1.67.0

func (*DeletePersistentResourceRequest) String added in v1.67.0

type DeletePipelineJobRequest

type DeletePipelineJobRequest struct {

	// Required. The name of the PipelineJob resource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PipelineService.DeletePipelineJob][google.cloud.aiplatform.v1.PipelineService.DeletePipelineJob].

func (*DeletePipelineJobRequest) Descriptor deprecated

func (*DeletePipelineJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeletePipelineJobRequest.ProtoReflect.Descriptor instead.

func (*DeletePipelineJobRequest) GetName

func (x *DeletePipelineJobRequest) GetName() string

func (*DeletePipelineJobRequest) ProtoMessage

func (*DeletePipelineJobRequest) ProtoMessage()

func (*DeletePipelineJobRequest) ProtoReflect

func (x *DeletePipelineJobRequest) ProtoReflect() protoreflect.Message

func (*DeletePipelineJobRequest) Reset

func (x *DeletePipelineJobRequest) Reset()

func (*DeletePipelineJobRequest) String

func (x *DeletePipelineJobRequest) String() string

type DeleteSavedQueryRequest added in v1.46.0

type DeleteSavedQueryRequest struct {

	// Required. The resource name of the SavedQuery to delete.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.DeleteSavedQuery][google.cloud.aiplatform.v1.DatasetService.DeleteSavedQuery].

func (*DeleteSavedQueryRequest) Descriptor deprecated added in v1.46.0

func (*DeleteSavedQueryRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteSavedQueryRequest.ProtoReflect.Descriptor instead.

func (*DeleteSavedQueryRequest) GetName added in v1.46.0

func (x *DeleteSavedQueryRequest) GetName() string

func (*DeleteSavedQueryRequest) ProtoMessage added in v1.46.0

func (*DeleteSavedQueryRequest) ProtoMessage()

func (*DeleteSavedQueryRequest) ProtoReflect added in v1.46.0

func (x *DeleteSavedQueryRequest) ProtoReflect() protoreflect.Message

func (*DeleteSavedQueryRequest) Reset added in v1.46.0

func (x *DeleteSavedQueryRequest) Reset()

func (*DeleteSavedQueryRequest) String added in v1.46.0

func (x *DeleteSavedQueryRequest) String() string

type DeleteScheduleRequest added in v1.47.0

type DeleteScheduleRequest struct {

	// Required. The name of the Schedule resource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/schedules/{schedule}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ScheduleService.DeleteSchedule][google.cloud.aiplatform.v1.ScheduleService.DeleteSchedule].

func (*DeleteScheduleRequest) Descriptor deprecated added in v1.47.0

func (*DeleteScheduleRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteScheduleRequest.ProtoReflect.Descriptor instead.

func (*DeleteScheduleRequest) GetName added in v1.47.0

func (x *DeleteScheduleRequest) GetName() string

func (*DeleteScheduleRequest) ProtoMessage added in v1.47.0

func (*DeleteScheduleRequest) ProtoMessage()

func (*DeleteScheduleRequest) ProtoReflect added in v1.47.0

func (x *DeleteScheduleRequest) ProtoReflect() protoreflect.Message

func (*DeleteScheduleRequest) Reset added in v1.47.0

func (x *DeleteScheduleRequest) Reset()

func (*DeleteScheduleRequest) String added in v1.47.0

func (x *DeleteScheduleRequest) String() string

type DeleteSpecialistPoolRequest

type DeleteSpecialistPoolRequest struct {

	// Required. The resource name of the SpecialistPool to delete. Format:
	// `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If set to true, any specialist managers in this SpecialistPool will also be
	// deleted. (Otherwise, the request will only work if the SpecialistPool has
	// no specialist managers.)
	Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SpecialistPoolService.DeleteSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.DeleteSpecialistPool].

func (*DeleteSpecialistPoolRequest) Descriptor deprecated

func (*DeleteSpecialistPoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteSpecialistPoolRequest.ProtoReflect.Descriptor instead.

func (*DeleteSpecialistPoolRequest) GetForce

func (x *DeleteSpecialistPoolRequest) GetForce() bool

func (*DeleteSpecialistPoolRequest) GetName

func (x *DeleteSpecialistPoolRequest) GetName() string

func (*DeleteSpecialistPoolRequest) ProtoMessage

func (*DeleteSpecialistPoolRequest) ProtoMessage()

func (*DeleteSpecialistPoolRequest) ProtoReflect

func (*DeleteSpecialistPoolRequest) Reset

func (x *DeleteSpecialistPoolRequest) Reset()

func (*DeleteSpecialistPoolRequest) String

func (x *DeleteSpecialistPoolRequest) String() string

type DeleteStudyRequest

type DeleteStudyRequest struct {

	// Required. The name of the Study resource to be deleted.
	// Format: `projects/{project}/locations/{location}/studies/{study}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.DeleteStudy][google.cloud.aiplatform.v1.VizierService.DeleteStudy].

func (*DeleteStudyRequest) Descriptor deprecated

func (*DeleteStudyRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteStudyRequest.ProtoReflect.Descriptor instead.

func (*DeleteStudyRequest) GetName

func (x *DeleteStudyRequest) GetName() string

func (*DeleteStudyRequest) ProtoMessage

func (*DeleteStudyRequest) ProtoMessage()

func (*DeleteStudyRequest) ProtoReflect

func (x *DeleteStudyRequest) ProtoReflect() protoreflect.Message

func (*DeleteStudyRequest) Reset

func (x *DeleteStudyRequest) Reset()

func (*DeleteStudyRequest) String

func (x *DeleteStudyRequest) String() string

type DeleteTensorboardExperimentRequest

type DeleteTensorboardExperimentRequest struct {

	// Required. The name of the TensorboardExperiment to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.DeleteTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardExperiment].

func (*DeleteTensorboardExperimentRequest) Descriptor deprecated

func (*DeleteTensorboardExperimentRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteTensorboardExperimentRequest.ProtoReflect.Descriptor instead.

func (*DeleteTensorboardExperimentRequest) GetName

func (*DeleteTensorboardExperimentRequest) ProtoMessage

func (*DeleteTensorboardExperimentRequest) ProtoMessage()

func (*DeleteTensorboardExperimentRequest) ProtoReflect

func (*DeleteTensorboardExperimentRequest) Reset

func (*DeleteTensorboardExperimentRequest) String

type DeleteTensorboardRequest

type DeleteTensorboardRequest struct {

	// Required. The name of the Tensorboard to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.DeleteTensorboard][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboard].

func (*DeleteTensorboardRequest) Descriptor deprecated

func (*DeleteTensorboardRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteTensorboardRequest.ProtoReflect.Descriptor instead.

func (*DeleteTensorboardRequest) GetName

func (x *DeleteTensorboardRequest) GetName() string

func (*DeleteTensorboardRequest) ProtoMessage

func (*DeleteTensorboardRequest) ProtoMessage()

func (*DeleteTensorboardRequest) ProtoReflect

func (x *DeleteTensorboardRequest) ProtoReflect() protoreflect.Message

func (*DeleteTensorboardRequest) Reset

func (x *DeleteTensorboardRequest) Reset()

func (*DeleteTensorboardRequest) String

func (x *DeleteTensorboardRequest) String() string

type DeleteTensorboardRunRequest

type DeleteTensorboardRunRequest struct {

	// Required. The name of the TensorboardRun to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.DeleteTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardRun].

func (*DeleteTensorboardRunRequest) Descriptor deprecated

func (*DeleteTensorboardRunRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteTensorboardRunRequest.ProtoReflect.Descriptor instead.

func (*DeleteTensorboardRunRequest) GetName

func (x *DeleteTensorboardRunRequest) GetName() string

func (*DeleteTensorboardRunRequest) ProtoMessage

func (*DeleteTensorboardRunRequest) ProtoMessage()

func (*DeleteTensorboardRunRequest) ProtoReflect

func (*DeleteTensorboardRunRequest) Reset

func (x *DeleteTensorboardRunRequest) Reset()

func (*DeleteTensorboardRunRequest) String

func (x *DeleteTensorboardRunRequest) String() string

type DeleteTensorboardTimeSeriesRequest

type DeleteTensorboardTimeSeriesRequest struct {

	// Required. The name of the TensorboardTimeSeries to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.DeleteTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardTimeSeries].

func (*DeleteTensorboardTimeSeriesRequest) Descriptor deprecated

func (*DeleteTensorboardTimeSeriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteTensorboardTimeSeriesRequest.ProtoReflect.Descriptor instead.

func (*DeleteTensorboardTimeSeriesRequest) GetName

func (*DeleteTensorboardTimeSeriesRequest) ProtoMessage

func (*DeleteTensorboardTimeSeriesRequest) ProtoMessage()

func (*DeleteTensorboardTimeSeriesRequest) ProtoReflect

func (*DeleteTensorboardTimeSeriesRequest) Reset

func (*DeleteTensorboardTimeSeriesRequest) String

type DeleteTrainingPipelineRequest

type DeleteTrainingPipelineRequest struct {

	// Required. The name of the TrainingPipeline resource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PipelineService.DeleteTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.DeleteTrainingPipeline].

func (*DeleteTrainingPipelineRequest) Descriptor deprecated

func (*DeleteTrainingPipelineRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteTrainingPipelineRequest.ProtoReflect.Descriptor instead.

func (*DeleteTrainingPipelineRequest) GetName

func (*DeleteTrainingPipelineRequest) ProtoMessage

func (*DeleteTrainingPipelineRequest) ProtoMessage()

func (*DeleteTrainingPipelineRequest) ProtoReflect

func (*DeleteTrainingPipelineRequest) Reset

func (x *DeleteTrainingPipelineRequest) Reset()

func (*DeleteTrainingPipelineRequest) String

type DeleteTrialRequest

type DeleteTrialRequest struct {

	// Required. The Trial's name.
	// Format:
	// `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.DeleteTrial][google.cloud.aiplatform.v1.VizierService.DeleteTrial].

func (*DeleteTrialRequest) Descriptor deprecated

func (*DeleteTrialRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteTrialRequest.ProtoReflect.Descriptor instead.

func (*DeleteTrialRequest) GetName

func (x *DeleteTrialRequest) GetName() string

func (*DeleteTrialRequest) ProtoMessage

func (*DeleteTrialRequest) ProtoMessage()

func (*DeleteTrialRequest) ProtoReflect

func (x *DeleteTrialRequest) ProtoReflect() protoreflect.Message

func (*DeleteTrialRequest) Reset

func (x *DeleteTrialRequest) Reset()

func (*DeleteTrialRequest) String

func (x *DeleteTrialRequest) String() string

type DeployIndexOperationMetadata

type DeployIndexOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// The unique index id specified by user
	DeployedIndexId string `protobuf:"bytes,2,opt,name=deployed_index_id,json=deployedIndexId,proto3" json:"deployed_index_id,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].

func (*DeployIndexOperationMetadata) Descriptor deprecated

func (*DeployIndexOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DeployIndexOperationMetadata.ProtoReflect.Descriptor instead.

func (*DeployIndexOperationMetadata) GetDeployedIndexId

func (x *DeployIndexOperationMetadata) GetDeployedIndexId() string

func (*DeployIndexOperationMetadata) GetGenericMetadata

func (x *DeployIndexOperationMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*DeployIndexOperationMetadata) ProtoMessage

func (*DeployIndexOperationMetadata) ProtoMessage()

func (*DeployIndexOperationMetadata) ProtoReflect

func (*DeployIndexOperationMetadata) Reset

func (x *DeployIndexOperationMetadata) Reset()

func (*DeployIndexOperationMetadata) String

type DeployIndexRequest

type DeployIndexRequest struct {

	// Required. The name of the IndexEndpoint resource into which to deploy an
	// Index. Format:
	// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
	IndexEndpoint string `protobuf:"bytes,1,opt,name=index_endpoint,json=indexEndpoint,proto3" json:"index_endpoint,omitempty"`
	// Required. The DeployedIndex to be created within the IndexEndpoint.
	DeployedIndex *DeployedIndex `protobuf:"bytes,2,opt,name=deployed_index,json=deployedIndex,proto3" json:"deployed_index,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].

func (*DeployIndexRequest) Descriptor deprecated

func (*DeployIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeployIndexRequest.ProtoReflect.Descriptor instead.

func (*DeployIndexRequest) GetDeployedIndex

func (x *DeployIndexRequest) GetDeployedIndex() *DeployedIndex

func (*DeployIndexRequest) GetIndexEndpoint

func (x *DeployIndexRequest) GetIndexEndpoint() string

func (*DeployIndexRequest) ProtoMessage

func (*DeployIndexRequest) ProtoMessage()

func (*DeployIndexRequest) ProtoReflect

func (x *DeployIndexRequest) ProtoReflect() protoreflect.Message

func (*DeployIndexRequest) Reset

func (x *DeployIndexRequest) Reset()

func (*DeployIndexRequest) String

func (x *DeployIndexRequest) String() string

type DeployIndexResponse

type DeployIndexResponse struct {

	// The DeployedIndex that had been deployed in the IndexEndpoint.
	DeployedIndex *DeployedIndex `protobuf:"bytes,1,opt,name=deployed_index,json=deployedIndex,proto3" json:"deployed_index,omitempty"`
	// contains filtered or unexported fields
}

Response message for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].

func (*DeployIndexResponse) Descriptor deprecated

func (*DeployIndexResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeployIndexResponse.ProtoReflect.Descriptor instead.

func (*DeployIndexResponse) GetDeployedIndex

func (x *DeployIndexResponse) GetDeployedIndex() *DeployedIndex

func (*DeployIndexResponse) ProtoMessage

func (*DeployIndexResponse) ProtoMessage()

func (*DeployIndexResponse) ProtoReflect

func (x *DeployIndexResponse) ProtoReflect() protoreflect.Message

func (*DeployIndexResponse) Reset

func (x *DeployIndexResponse) Reset()

func (*DeployIndexResponse) String

func (x *DeployIndexResponse) String() string

type DeployModelOperationMetadata

type DeployModelOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].

func (*DeployModelOperationMetadata) Descriptor deprecated

func (*DeployModelOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DeployModelOperationMetadata.ProtoReflect.Descriptor instead.

func (*DeployModelOperationMetadata) GetGenericMetadata

func (x *DeployModelOperationMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*DeployModelOperationMetadata) ProtoMessage

func (*DeployModelOperationMetadata) ProtoMessage()

func (*DeployModelOperationMetadata) ProtoReflect

func (*DeployModelOperationMetadata) Reset

func (x *DeployModelOperationMetadata) Reset()

func (*DeployModelOperationMetadata) String

type DeployModelRequest

type DeployModelRequest struct {

	// Required. The name of the Endpoint resource into which to deploy a Model.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Required. The DeployedModel to be created within the Endpoint. Note that
	// [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split]
	// must be updated for the DeployedModel to start receiving traffic, either as
	// part of this call, or via
	// [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint].
	DeployedModel *DeployedModel `protobuf:"bytes,2,opt,name=deployed_model,json=deployedModel,proto3" json:"deployed_model,omitempty"`
	// A map from a DeployedModel's ID to the percentage of this Endpoint's
	// traffic that should be forwarded to that DeployedModel.
	//
	// If this field is non-empty, then the Endpoint's
	// [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be
	// overwritten with it. To refer to the ID of the just being deployed Model, a
	// "0" should be used, and the actual ID of the new DeployedModel will be
	// filled in its place by this method. The traffic percentage values must add
	// up to 100.
	//
	// If this field is empty, then the Endpoint's
	// [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not
	// updated.
	TrafficSplit map[string]int32 `` /* 186-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].

func (*DeployModelRequest) Descriptor deprecated

func (*DeployModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeployModelRequest.ProtoReflect.Descriptor instead.

func (*DeployModelRequest) GetDeployedModel

func (x *DeployModelRequest) GetDeployedModel() *DeployedModel

func (*DeployModelRequest) GetEndpoint

func (x *DeployModelRequest) GetEndpoint() string

func (*DeployModelRequest) GetTrafficSplit

func (x *DeployModelRequest) GetTrafficSplit() map[string]int32

func (*DeployModelRequest) ProtoMessage

func (*DeployModelRequest) ProtoMessage()

func (*DeployModelRequest) ProtoReflect

func (x *DeployModelRequest) ProtoReflect() protoreflect.Message

func (*DeployModelRequest) Reset

func (x *DeployModelRequest) Reset()

func (*DeployModelRequest) String

func (x *DeployModelRequest) String() string

type DeployModelResponse

type DeployModelResponse struct {

	// The DeployedModel that had been deployed in the Endpoint.
	DeployedModel *DeployedModel `protobuf:"bytes,1,opt,name=deployed_model,json=deployedModel,proto3" json:"deployed_model,omitempty"`
	// contains filtered or unexported fields
}

Response message for [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].

func (*DeployModelResponse) Descriptor deprecated

func (*DeployModelResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeployModelResponse.ProtoReflect.Descriptor instead.

func (*DeployModelResponse) GetDeployedModel

func (x *DeployModelResponse) GetDeployedModel() *DeployedModel

func (*DeployModelResponse) ProtoMessage

func (*DeployModelResponse) ProtoMessage()

func (*DeployModelResponse) ProtoReflect

func (x *DeployModelResponse) ProtoReflect() protoreflect.Message

func (*DeployModelResponse) Reset

func (x *DeployModelResponse) Reset()

func (*DeployModelResponse) String

func (x *DeployModelResponse) String() string

type DeployedIndex

type DeployedIndex struct {

	// Required. The user specified ID of the DeployedIndex.
	// The ID can be up to 128 characters long and must start with a letter and
	// only contain letters, numbers, and underscores.
	// The ID must be unique within the project it is created in.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Required. The name of the Index this is the deployment of.
	// We may refer to this Index as the DeployedIndex's "original" Index.
	Index string `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
	// The display name of the DeployedIndex. If not provided upon creation,
	// the Index's display_name is used.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. Timestamp when the DeployedIndex was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Provides paths for users to send requests directly to the
	// deployed index services running on Cloud via private services access. This
	// field is populated if
	// [network][google.cloud.aiplatform.v1.IndexEndpoint.network] is configured.
	PrivateEndpoints *IndexPrivateEndpoints `protobuf:"bytes,5,opt,name=private_endpoints,json=privateEndpoints,proto3" json:"private_endpoints,omitempty"`
	// Output only. The DeployedIndex may depend on various data on its original
	// Index. Additionally when certain changes to the original Index are being
	// done (e.g. when what the Index contains is being changed) the DeployedIndex
	// may be asynchronously updated in the background to reflect these changes.
	// If this timestamp's value is at least the
	// [Index.update_time][google.cloud.aiplatform.v1.Index.update_time] of the
	// original Index, it means that this DeployedIndex and the original Index are
	// in sync. If this timestamp is older, then to see which updates this
	// DeployedIndex already contains (and which it does not), one must
	// [list][google.longrunning.Operations.ListOperations] the operations that
	// are running on the original Index. Only the successfully completed
	// Operations with
	// [update_time][google.cloud.aiplatform.v1.GenericOperationMetadata.update_time]
	// equal or before this sync time are contained in this DeployedIndex.
	IndexSyncTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=index_sync_time,json=indexSyncTime,proto3" json:"index_sync_time,omitempty"`
	// Optional. A description of resources that the DeployedIndex uses, which to
	// large degree are decided by Vertex AI, and optionally allows only a modest
	// additional configuration.
	// If min_replica_count is not set, the default value is 2 (we don't provide
	// SLA when min_replica_count=1). If max_replica_count is not set, the
	// default value is min_replica_count. The max allowed replica count is
	// 1000.
	AutomaticResources *AutomaticResources `protobuf:"bytes,7,opt,name=automatic_resources,json=automaticResources,proto3" json:"automatic_resources,omitempty"`
	// Optional. A description of resources that are dedicated to the
	// DeployedIndex, and that need a higher degree of manual configuration. The
	// field min_replica_count must be set to a value strictly greater than 0, or
	// else validation will fail. We don't provide SLA when min_replica_count=1.
	// If max_replica_count is not set, the default value is min_replica_count.
	// The max allowed replica count is 1000.
	//
	// Available machine types for SMALL shard:
	// e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
	//
	// Available machine types for MEDIUM shard:
	// e2-standard-16 and all machine types available for LARGE shard.
	//
	// Available machine types for LARGE shard:
	// e2-highmem-16, n2d-standard-32.
	//
	// n1-standard-16 and n1-standard-32 are still available, but we recommend
	// e2-standard-16 and e2-highmem-16 for cost efficiency.
	DedicatedResources *DedicatedResources `protobuf:"bytes,16,opt,name=dedicated_resources,json=dedicatedResources,proto3" json:"dedicated_resources,omitempty"`
	// Optional. If true, private endpoint's access logs are sent to Cloud
	// Logging.
	//
	// These logs are like standard server access logs, containing
	// information like timestamp and latency for each MatchRequest.
	//
	// Note that logs may incur a cost, especially if the deployed
	// index receives a high queries per second rate (QPS).
	// Estimate your costs before enabling this option.
	EnableAccessLogging bool `protobuf:"varint,8,opt,name=enable_access_logging,json=enableAccessLogging,proto3" json:"enable_access_logging,omitempty"`
	// Optional. If set, the authentication is enabled for the private endpoint.
	DeployedIndexAuthConfig *DeployedIndexAuthConfig `` /* 134-byte string literal not displayed */
	// Optional. A list of reserved ip ranges under the VPC network that can be
	// used for this DeployedIndex.
	//
	// If set, we will deploy the index within the provided ip ranges. Otherwise,
	// the index might be deployed to any ip ranges under the provided VPC
	// network.
	//
	// The value should be the name of the address
	// (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
	// Example: ['vertex-ai-ip-range'].
	//
	// For more information about subnets and network IP ranges, please see
	// https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.
	ReservedIpRanges []string `protobuf:"bytes,10,rep,name=reserved_ip_ranges,json=reservedIpRanges,proto3" json:"reserved_ip_ranges,omitempty"`
	// Optional. The deployment group can be no longer than 64 characters (eg:
	// 'test', 'prod'). If not set, we will use the 'default' deployment group.
	//
	// Creating `deployment_groups` with `reserved_ip_ranges` is a recommended
	// practice when the peered network has multiple peering ranges. This creates
	// your deployments from predictable IP spaces for easier traffic
	// administration. Also, one deployment_group (except 'default') can only be
	// used with the same reserved_ip_ranges which means if the deployment_group
	// has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or
	// [d, e] is disallowed.
	//
	// Note: we only support up to 5 deployment groups(not including 'default').
	DeploymentGroup string `protobuf:"bytes,11,opt,name=deployment_group,json=deploymentGroup,proto3" json:"deployment_group,omitempty"`
	// contains filtered or unexported fields
}

A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.

func (*DeployedIndex) Descriptor deprecated

func (*DeployedIndex) Descriptor() ([]byte, []int)

Deprecated: Use DeployedIndex.ProtoReflect.Descriptor instead.

func (*DeployedIndex) GetAutomaticResources

func (x *DeployedIndex) GetAutomaticResources() *AutomaticResources

func (*DeployedIndex) GetCreateTime

func (x *DeployedIndex) GetCreateTime() *timestamppb.Timestamp

func (*DeployedIndex) GetDedicatedResources

func (x *DeployedIndex) GetDedicatedResources() *DedicatedResources

func (*DeployedIndex) GetDeployedIndexAuthConfig

func (x *DeployedIndex) GetDeployedIndexAuthConfig() *DeployedIndexAuthConfig

func (*DeployedIndex) GetDeploymentGroup

func (x *DeployedIndex) GetDeploymentGroup() string

func (*DeployedIndex) GetDisplayName

func (x *DeployedIndex) GetDisplayName() string

func (*DeployedIndex) GetEnableAccessLogging

func (x *DeployedIndex) GetEnableAccessLogging() bool

func (*DeployedIndex) GetId

func (x *DeployedIndex) GetId() string

func (*DeployedIndex) GetIndex

func (x *DeployedIndex) GetIndex() string

func (*DeployedIndex) GetIndexSyncTime

func (x *DeployedIndex) GetIndexSyncTime() *timestamppb.Timestamp

func (*DeployedIndex) GetPrivateEndpoints

func (x *DeployedIndex) GetPrivateEndpoints() *IndexPrivateEndpoints

func (*DeployedIndex) GetReservedIpRanges

func (x *DeployedIndex) GetReservedIpRanges() []string

func (*DeployedIndex) ProtoMessage

func (*DeployedIndex) ProtoMessage()

func (*DeployedIndex) ProtoReflect

func (x *DeployedIndex) ProtoReflect() protoreflect.Message

func (*DeployedIndex) Reset

func (x *DeployedIndex) Reset()

func (*DeployedIndex) String

func (x *DeployedIndex) String() string

type DeployedIndexAuthConfig

type DeployedIndexAuthConfig struct {

	// Defines the authentication provider that the DeployedIndex uses.
	AuthProvider *DeployedIndexAuthConfig_AuthProvider `protobuf:"bytes,1,opt,name=auth_provider,json=authProvider,proto3" json:"auth_provider,omitempty"`
	// contains filtered or unexported fields
}

Used to set up the auth on the DeployedIndex's private endpoint.

func (*DeployedIndexAuthConfig) Descriptor deprecated

func (*DeployedIndexAuthConfig) Descriptor() ([]byte, []int)

Deprecated: Use DeployedIndexAuthConfig.ProtoReflect.Descriptor instead.

func (*DeployedIndexAuthConfig) GetAuthProvider

func (*DeployedIndexAuthConfig) ProtoMessage

func (*DeployedIndexAuthConfig) ProtoMessage()

func (*DeployedIndexAuthConfig) ProtoReflect

func (x *DeployedIndexAuthConfig) ProtoReflect() protoreflect.Message

func (*DeployedIndexAuthConfig) Reset

func (x *DeployedIndexAuthConfig) Reset()

func (*DeployedIndexAuthConfig) String

func (x *DeployedIndexAuthConfig) String() string

type DeployedIndexAuthConfig_AuthProvider

type DeployedIndexAuthConfig_AuthProvider struct {

	// The list of JWT
	// [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
	// that are allowed to access. A JWT containing any of these audiences will
	// be accepted.
	Audiences []string `protobuf:"bytes,1,rep,name=audiences,proto3" json:"audiences,omitempty"`
	// A list of allowed JWT issuers. Each entry must be a valid Google
	// service account, in the following format:
	//
	// `service-account-name@project-id.iam.gserviceaccount.com`
	AllowedIssuers []string `protobuf:"bytes,2,rep,name=allowed_issuers,json=allowedIssuers,proto3" json:"allowed_issuers,omitempty"`
	// contains filtered or unexported fields
}

Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

func (*DeployedIndexAuthConfig_AuthProvider) Descriptor deprecated

func (*DeployedIndexAuthConfig_AuthProvider) Descriptor() ([]byte, []int)

Deprecated: Use DeployedIndexAuthConfig_AuthProvider.ProtoReflect.Descriptor instead.

func (*DeployedIndexAuthConfig_AuthProvider) GetAllowedIssuers

func (x *DeployedIndexAuthConfig_AuthProvider) GetAllowedIssuers() []string

func (*DeployedIndexAuthConfig_AuthProvider) GetAudiences

func (x *DeployedIndexAuthConfig_AuthProvider) GetAudiences() []string

func (*DeployedIndexAuthConfig_AuthProvider) ProtoMessage

func (*DeployedIndexAuthConfig_AuthProvider) ProtoMessage()

func (*DeployedIndexAuthConfig_AuthProvider) ProtoReflect

func (*DeployedIndexAuthConfig_AuthProvider) Reset

func (*DeployedIndexAuthConfig_AuthProvider) String

type DeployedIndexRef

type DeployedIndexRef struct {

	// Immutable. A resource name of the IndexEndpoint.
	IndexEndpoint string `protobuf:"bytes,1,opt,name=index_endpoint,json=indexEndpoint,proto3" json:"index_endpoint,omitempty"`
	// Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
	DeployedIndexId string `protobuf:"bytes,2,opt,name=deployed_index_id,json=deployedIndexId,proto3" json:"deployed_index_id,omitempty"`
	// Output only. The display name of the DeployedIndex.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

Points to a DeployedIndex.

func (*DeployedIndexRef) Descriptor deprecated

func (*DeployedIndexRef) Descriptor() ([]byte, []int)

Deprecated: Use DeployedIndexRef.ProtoReflect.Descriptor instead.

func (*DeployedIndexRef) GetDeployedIndexId

func (x *DeployedIndexRef) GetDeployedIndexId() string

func (*DeployedIndexRef) GetDisplayName added in v1.57.0

func (x *DeployedIndexRef) GetDisplayName() string

func (*DeployedIndexRef) GetIndexEndpoint

func (x *DeployedIndexRef) GetIndexEndpoint() string

func (*DeployedIndexRef) ProtoMessage

func (*DeployedIndexRef) ProtoMessage()

func (*DeployedIndexRef) ProtoReflect

func (x *DeployedIndexRef) ProtoReflect() protoreflect.Message

func (*DeployedIndexRef) Reset

func (x *DeployedIndexRef) Reset()

func (*DeployedIndexRef) String

func (x *DeployedIndexRef) String() string

type DeployedModel

type DeployedModel struct {

	// The prediction (for example, the machine) resources that the DeployedModel
	// uses. The user is billed for the resources (at least their minimal amount)
	// even if the DeployedModel receives no traffic.
	// Not all Models support all resources types. See
	// [Model.supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types].
	// Required except for Large Model Deploy use cases.
	//
	// Types that are assignable to PredictionResources:
	//
	//	*DeployedModel_DedicatedResources
	//	*DeployedModel_AutomaticResources
	//	*DeployedModel_SharedResources
	PredictionResources isDeployedModel_PredictionResources `protobuf_oneof:"prediction_resources"`
	// Immutable. The ID of the DeployedModel. If not provided upon deployment,
	// Vertex AI will generate a value for this ID.
	//
	// This value should be 1-10 characters, and valid characters are `/[0-9]/`.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Required. The resource name of the Model that this is the deployment of.
	// Note that the Model may be in a different location than the DeployedModel's
	// Endpoint.
	//
	// The resource name may contain version id or version alias to specify the
	// version.
	//
	//	Example: `projects/{project}/locations/{location}/models/{model}@2`
	//	            or
	//	          `projects/{project}/locations/{location}/models/{model}@golden`
	//
	// if no version is specified, the default version will be deployed.
	Model string `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"`
	// Output only. The version ID of the model that is deployed.
	ModelVersionId string `protobuf:"bytes,18,opt,name=model_version_id,json=modelVersionId,proto3" json:"model_version_id,omitempty"`
	// The display name of the DeployedModel. If not provided upon creation,
	// the Model's display_name is used.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. Timestamp when the DeployedModel was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Explanation configuration for this DeployedModel.
	//
	// When deploying a Model using
	// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel],
	// this value overrides the value of
	// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec].
	// All fields of
	// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
	// are optional in the request. If a field of
	// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
	// is not populated, the value of the same field of
	// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
	// is inherited. If the corresponding
	// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
	// is not populated, all fields of the
	// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
	// will be used for the explanation configuration.
	ExplanationSpec *ExplanationSpec `protobuf:"bytes,9,opt,name=explanation_spec,json=explanationSpec,proto3" json:"explanation_spec,omitempty"`
	// If true, deploy the model without explainable feature, regardless the
	// existence of
	// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
	// or
	// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec].
	DisableExplanations bool `protobuf:"varint,19,opt,name=disable_explanations,json=disableExplanations,proto3" json:"disable_explanations,omitempty"`
	// The service account that the DeployedModel's container runs as. Specify the
	// email address of the service account. If this service account is not
	// specified, the container runs as a service account that doesn't have access
	// to the resource project.
	//
	// Users deploying the Model must have the `iam.serviceAccounts.actAs`
	// permission on this service account.
	ServiceAccount string `protobuf:"bytes,11,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// For custom-trained Models and AutoML Tabular Models, the container of the
	// DeployedModel instances will send `stderr` and `stdout` streams to
	// Cloud Logging by default. Please note that the logs incur cost,
	// which are subject to [Cloud Logging
	// pricing](https://cloud.google.com/logging/pricing).
	//
	// User can disable container logging by setting this flag to true.
	DisableContainerLogging bool `` /* 134-byte string literal not displayed */
	// If true, online prediction access logs are sent to Cloud
	// Logging.
	// These logs are like standard server access logs, containing
	// information like timestamp and latency for each prediction request.
	//
	// Note that logs may incur a cost, especially if your project
	// receives prediction requests at a high queries per second rate (QPS).
	// Estimate your costs before enabling this option.
	EnableAccessLogging bool `protobuf:"varint,13,opt,name=enable_access_logging,json=enableAccessLogging,proto3" json:"enable_access_logging,omitempty"`
	// Output only. Provide paths for users to send predict/explain/health
	// requests directly to the deployed model services running on Cloud via
	// private services access. This field is populated if
	// [network][google.cloud.aiplatform.v1.Endpoint.network] is configured.
	PrivateEndpoints *PrivateEndpoints `protobuf:"bytes,14,opt,name=private_endpoints,json=privateEndpoints,proto3" json:"private_endpoints,omitempty"`
	// contains filtered or unexported fields
}

A deployment of a Model. Endpoints contain one or more DeployedModels.

func (*DeployedModel) Descriptor deprecated

func (*DeployedModel) Descriptor() ([]byte, []int)

Deprecated: Use DeployedModel.ProtoReflect.Descriptor instead.

func (*DeployedModel) GetAutomaticResources

func (x *DeployedModel) GetAutomaticResources() *AutomaticResources

func (*DeployedModel) GetCreateTime

func (x *DeployedModel) GetCreateTime() *timestamppb.Timestamp

func (*DeployedModel) GetDedicatedResources

func (x *DeployedModel) GetDedicatedResources() *DedicatedResources

func (*DeployedModel) GetDisableContainerLogging

func (x *DeployedModel) GetDisableContainerLogging() bool

func (*DeployedModel) GetDisableExplanations added in v1.67.0

func (x *DeployedModel) GetDisableExplanations() bool

func (*DeployedModel) GetDisplayName

func (x *DeployedModel) GetDisplayName() string

func (*DeployedModel) GetEnableAccessLogging

func (x *DeployedModel) GetEnableAccessLogging() bool

func (*DeployedModel) GetExplanationSpec

func (x *DeployedModel) GetExplanationSpec() *ExplanationSpec

func (*DeployedModel) GetId

func (x *DeployedModel) GetId() string

func (*DeployedModel) GetModel

func (x *DeployedModel) GetModel() string

func (*DeployedModel) GetModelVersionId

func (x *DeployedModel) GetModelVersionId() string

func (*DeployedModel) GetPredictionResources

func (m *DeployedModel) GetPredictionResources() isDeployedModel_PredictionResources

func (*DeployedModel) GetPrivateEndpoints

func (x *DeployedModel) GetPrivateEndpoints() *PrivateEndpoints

func (*DeployedModel) GetServiceAccount

func (x *DeployedModel) GetServiceAccount() string

func (*DeployedModel) GetSharedResources added in v1.57.0

func (x *DeployedModel) GetSharedResources() string

func (*DeployedModel) ProtoMessage

func (*DeployedModel) ProtoMessage()

func (*DeployedModel) ProtoReflect

func (x *DeployedModel) ProtoReflect() protoreflect.Message

func (*DeployedModel) Reset

func (x *DeployedModel) Reset()

func (*DeployedModel) String

func (x *DeployedModel) String() string

type DeployedModelRef

type DeployedModelRef struct {

	// Immutable. A resource name of an Endpoint.
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Immutable. An ID of a DeployedModel in the above Endpoint.
	DeployedModelId string `protobuf:"bytes,2,opt,name=deployed_model_id,json=deployedModelId,proto3" json:"deployed_model_id,omitempty"`
	// contains filtered or unexported fields
}

Points to a DeployedModel.

func (*DeployedModelRef) Descriptor deprecated

func (*DeployedModelRef) Descriptor() ([]byte, []int)

Deprecated: Use DeployedModelRef.ProtoReflect.Descriptor instead.

func (*DeployedModelRef) GetDeployedModelId

func (x *DeployedModelRef) GetDeployedModelId() string

func (*DeployedModelRef) GetEndpoint

func (x *DeployedModelRef) GetEndpoint() string

func (*DeployedModelRef) ProtoMessage

func (*DeployedModelRef) ProtoMessage()

func (*DeployedModelRef) ProtoReflect

func (x *DeployedModelRef) ProtoReflect() protoreflect.Message

func (*DeployedModelRef) Reset

func (x *DeployedModelRef) Reset()

func (*DeployedModelRef) String

func (x *DeployedModelRef) String() string

type DeployedModel_AutomaticResources

type DeployedModel_AutomaticResources struct {
	// A description of resources that to large degree are decided by Vertex
	// AI, and require only a modest additional configuration.
	AutomaticResources *AutomaticResources `protobuf:"bytes,8,opt,name=automatic_resources,json=automaticResources,proto3,oneof"`
}

type DeployedModel_DedicatedResources

type DeployedModel_DedicatedResources struct {
	// A description of resources that are dedicated to the DeployedModel, and
	// that need a higher degree of manual configuration.
	DedicatedResources *DedicatedResources `protobuf:"bytes,7,opt,name=dedicated_resources,json=dedicatedResources,proto3,oneof"`
}

type DeployedModel_SharedResources added in v1.57.0

type DeployedModel_SharedResources struct {
	// The resource name of the shared DeploymentResourcePool to deploy on.
	// Format:
	// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
	SharedResources string `protobuf:"bytes,17,opt,name=shared_resources,json=sharedResources,proto3,oneof"`
}

type DeploymentResourcePool added in v1.57.0

type DeploymentResourcePool struct {

	// Immutable. The resource name of the DeploymentResourcePool.
	// Format:
	// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The underlying DedicatedResources that the DeploymentResourcePool
	// uses.
	DedicatedResources *DedicatedResources `protobuf:"bytes,2,opt,name=dedicated_resources,json=dedicatedResources,proto3" json:"dedicated_resources,omitempty"`
	// Output only. Timestamp when this DeploymentResourcePool was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources.

func (*DeploymentResourcePool) Descriptor deprecated added in v1.57.0

func (*DeploymentResourcePool) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentResourcePool.ProtoReflect.Descriptor instead.

func (*DeploymentResourcePool) GetCreateTime added in v1.57.0

func (x *DeploymentResourcePool) GetCreateTime() *timestamppb.Timestamp

func (*DeploymentResourcePool) GetDedicatedResources added in v1.57.0

func (x *DeploymentResourcePool) GetDedicatedResources() *DedicatedResources

func (*DeploymentResourcePool) GetName added in v1.57.0

func (x *DeploymentResourcePool) GetName() string

func (*DeploymentResourcePool) ProtoMessage added in v1.57.0

func (*DeploymentResourcePool) ProtoMessage()

func (*DeploymentResourcePool) ProtoReflect added in v1.57.0

func (x *DeploymentResourcePool) ProtoReflect() protoreflect.Message

func (*DeploymentResourcePool) Reset added in v1.57.0

func (x *DeploymentResourcePool) Reset()

func (*DeploymentResourcePool) String added in v1.57.0

func (x *DeploymentResourcePool) String() string

type DeploymentResourcePoolServiceClient added in v1.57.0

type DeploymentResourcePoolServiceClient interface {
	// Create a DeploymentResourcePool.
	CreateDeploymentResourcePool(ctx context.Context, in *CreateDeploymentResourcePoolRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Get a DeploymentResourcePool.
	GetDeploymentResourcePool(ctx context.Context, in *GetDeploymentResourcePoolRequest, opts ...grpc.CallOption) (*DeploymentResourcePool, error)
	// List DeploymentResourcePools in a location.
	ListDeploymentResourcePools(ctx context.Context, in *ListDeploymentResourcePoolsRequest, opts ...grpc.CallOption) (*ListDeploymentResourcePoolsResponse, error)
	// Delete a DeploymentResourcePool.
	DeleteDeploymentResourcePool(ctx context.Context, in *DeleteDeploymentResourcePoolRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// List DeployedModels that have been deployed on this DeploymentResourcePool.
	QueryDeployedModels(ctx context.Context, in *QueryDeployedModelsRequest, opts ...grpc.CallOption) (*QueryDeployedModelsResponse, error)
}

DeploymentResourcePoolServiceClient is the client API for DeploymentResourcePoolService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewDeploymentResourcePoolServiceClient added in v1.57.0

func NewDeploymentResourcePoolServiceClient(cc grpc.ClientConnInterface) DeploymentResourcePoolServiceClient

type DeploymentResourcePoolServiceServer added in v1.57.0

type DeploymentResourcePoolServiceServer interface {
	// Create a DeploymentResourcePool.
	CreateDeploymentResourcePool(context.Context, *CreateDeploymentResourcePoolRequest) (*longrunningpb.Operation, error)
	// Get a DeploymentResourcePool.
	GetDeploymentResourcePool(context.Context, *GetDeploymentResourcePoolRequest) (*DeploymentResourcePool, error)
	// List DeploymentResourcePools in a location.
	ListDeploymentResourcePools(context.Context, *ListDeploymentResourcePoolsRequest) (*ListDeploymentResourcePoolsResponse, error)
	// Delete a DeploymentResourcePool.
	DeleteDeploymentResourcePool(context.Context, *DeleteDeploymentResourcePoolRequest) (*longrunningpb.Operation, error)
	// List DeployedModels that have been deployed on this DeploymentResourcePool.
	QueryDeployedModels(context.Context, *QueryDeployedModelsRequest) (*QueryDeployedModelsResponse, error)
}

DeploymentResourcePoolServiceServer is the server API for DeploymentResourcePoolService service.

type DestinationFeatureSetting

type DestinationFeatureSetting struct {

	// Required. The ID of the Feature to apply the setting to.
	FeatureId string `protobuf:"bytes,1,opt,name=feature_id,json=featureId,proto3" json:"feature_id,omitempty"`
	// Specify the field name in the export destination. If not specified,
	// Feature ID is used.
	DestinationField string `protobuf:"bytes,2,opt,name=destination_field,json=destinationField,proto3" json:"destination_field,omitempty"`
	// contains filtered or unexported fields
}

func (*DestinationFeatureSetting) Descriptor deprecated

func (*DestinationFeatureSetting) Descriptor() ([]byte, []int)

Deprecated: Use DestinationFeatureSetting.ProtoReflect.Descriptor instead.

func (*DestinationFeatureSetting) GetDestinationField

func (x *DestinationFeatureSetting) GetDestinationField() string

func (*DestinationFeatureSetting) GetFeatureId

func (x *DestinationFeatureSetting) GetFeatureId() string

func (*DestinationFeatureSetting) ProtoMessage

func (*DestinationFeatureSetting) ProtoMessage()

func (*DestinationFeatureSetting) ProtoReflect

func (*DestinationFeatureSetting) Reset

func (x *DestinationFeatureSetting) Reset()

func (*DestinationFeatureSetting) String

func (x *DestinationFeatureSetting) String() string

type DirectPredictRequest added in v1.55.0

type DirectPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// The prediction input.
	Inputs []*Tensor `protobuf:"bytes,2,rep,name=inputs,proto3" json:"inputs,omitempty"`
	// The parameters that govern the prediction.
	Parameters *Tensor `protobuf:"bytes,3,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.DirectPredict][google.cloud.aiplatform.v1.PredictionService.DirectPredict].

func (*DirectPredictRequest) Descriptor deprecated added in v1.55.0

func (*DirectPredictRequest) Descriptor() ([]byte, []int)

Deprecated: Use DirectPredictRequest.ProtoReflect.Descriptor instead.

func (*DirectPredictRequest) GetEndpoint added in v1.55.0

func (x *DirectPredictRequest) GetEndpoint() string

func (*DirectPredictRequest) GetInputs added in v1.55.0

func (x *DirectPredictRequest) GetInputs() []*Tensor

func (*DirectPredictRequest) GetParameters added in v1.55.0

func (x *DirectPredictRequest) GetParameters() *Tensor

func (*DirectPredictRequest) ProtoMessage added in v1.55.0

func (*DirectPredictRequest) ProtoMessage()

func (*DirectPredictRequest) ProtoReflect added in v1.55.0

func (x *DirectPredictRequest) ProtoReflect() protoreflect.Message

func (*DirectPredictRequest) Reset added in v1.55.0

func (x *DirectPredictRequest) Reset()

func (*DirectPredictRequest) String added in v1.55.0

func (x *DirectPredictRequest) String() string

type DirectPredictResponse added in v1.55.0

type DirectPredictResponse struct {

	// The prediction output.
	Outputs []*Tensor `protobuf:"bytes,1,rep,name=outputs,proto3" json:"outputs,omitempty"`
	// The parameters that govern the prediction.
	Parameters *Tensor `protobuf:"bytes,2,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.DirectPredict][google.cloud.aiplatform.v1.PredictionService.DirectPredict].

func (*DirectPredictResponse) Descriptor deprecated added in v1.55.0

func (*DirectPredictResponse) Descriptor() ([]byte, []int)

Deprecated: Use DirectPredictResponse.ProtoReflect.Descriptor instead.

func (*DirectPredictResponse) GetOutputs added in v1.55.0

func (x *DirectPredictResponse) GetOutputs() []*Tensor

func (*DirectPredictResponse) GetParameters added in v1.55.0

func (x *DirectPredictResponse) GetParameters() *Tensor

func (*DirectPredictResponse) ProtoMessage added in v1.55.0

func (*DirectPredictResponse) ProtoMessage()

func (*DirectPredictResponse) ProtoReflect added in v1.55.0

func (x *DirectPredictResponse) ProtoReflect() protoreflect.Message

func (*DirectPredictResponse) Reset added in v1.55.0

func (x *DirectPredictResponse) Reset()

func (*DirectPredictResponse) String added in v1.55.0

func (x *DirectPredictResponse) String() string

type DirectRawPredictRequest added in v1.55.0

type DirectRawPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Fully qualified name of the API method being invoked to perform
	// predictions.
	//
	// Format:
	// `/namespace.Service/Method/`
	// Example:
	// `/tensorflow.serving.PredictionService/Predict`
	MethodName string `protobuf:"bytes,2,opt,name=method_name,json=methodName,proto3" json:"method_name,omitempty"`
	// The prediction input.
	Input []byte `protobuf:"bytes,3,opt,name=input,proto3" json:"input,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.DirectRawPredict][google.cloud.aiplatform.v1.PredictionService.DirectRawPredict].

func (*DirectRawPredictRequest) Descriptor deprecated added in v1.55.0

func (*DirectRawPredictRequest) Descriptor() ([]byte, []int)

Deprecated: Use DirectRawPredictRequest.ProtoReflect.Descriptor instead.

func (*DirectRawPredictRequest) GetEndpoint added in v1.55.0

func (x *DirectRawPredictRequest) GetEndpoint() string

func (*DirectRawPredictRequest) GetInput added in v1.55.0

func (x *DirectRawPredictRequest) GetInput() []byte

func (*DirectRawPredictRequest) GetMethodName added in v1.55.0

func (x *DirectRawPredictRequest) GetMethodName() string

func (*DirectRawPredictRequest) ProtoMessage added in v1.55.0

func (*DirectRawPredictRequest) ProtoMessage()

func (*DirectRawPredictRequest) ProtoReflect added in v1.55.0

func (x *DirectRawPredictRequest) ProtoReflect() protoreflect.Message

func (*DirectRawPredictRequest) Reset added in v1.55.0

func (x *DirectRawPredictRequest) Reset()

func (*DirectRawPredictRequest) String added in v1.55.0

func (x *DirectRawPredictRequest) String() string

type DirectRawPredictResponse added in v1.55.0

type DirectRawPredictResponse struct {

	// The prediction output.
	Output []byte `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.DirectRawPredict][google.cloud.aiplatform.v1.PredictionService.DirectRawPredict].

func (*DirectRawPredictResponse) Descriptor deprecated added in v1.55.0

func (*DirectRawPredictResponse) Descriptor() ([]byte, []int)

Deprecated: Use DirectRawPredictResponse.ProtoReflect.Descriptor instead.

func (*DirectRawPredictResponse) GetOutput added in v1.55.0

func (x *DirectRawPredictResponse) GetOutput() []byte

func (*DirectRawPredictResponse) ProtoMessage added in v1.55.0

func (*DirectRawPredictResponse) ProtoMessage()

func (*DirectRawPredictResponse) ProtoReflect added in v1.55.0

func (x *DirectRawPredictResponse) ProtoReflect() protoreflect.Message

func (*DirectRawPredictResponse) Reset added in v1.55.0

func (x *DirectRawPredictResponse) Reset()

func (*DirectRawPredictResponse) String added in v1.55.0

func (x *DirectRawPredictResponse) String() string

type DiskSpec

type DiskSpec struct {

	// Type of the boot disk (default is "pd-ssd").
	// Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or
	// "pd-standard" (Persistent Disk Hard Disk Drive).
	BootDiskType string `protobuf:"bytes,1,opt,name=boot_disk_type,json=bootDiskType,proto3" json:"boot_disk_type,omitempty"`
	// Size in GB of the boot disk (default is 100GB).
	BootDiskSizeGb int32 `protobuf:"varint,2,opt,name=boot_disk_size_gb,json=bootDiskSizeGb,proto3" json:"boot_disk_size_gb,omitempty"`
	// contains filtered or unexported fields
}

Represents the spec of disk options.

func (*DiskSpec) Descriptor deprecated

func (*DiskSpec) Descriptor() ([]byte, []int)

Deprecated: Use DiskSpec.ProtoReflect.Descriptor instead.

func (*DiskSpec) GetBootDiskSizeGb

func (x *DiskSpec) GetBootDiskSizeGb() int32

func (*DiskSpec) GetBootDiskType

func (x *DiskSpec) GetBootDiskType() string

func (*DiskSpec) ProtoMessage

func (*DiskSpec) ProtoMessage()

func (*DiskSpec) ProtoReflect

func (x *DiskSpec) ProtoReflect() protoreflect.Message

func (*DiskSpec) Reset

func (x *DiskSpec) Reset()

func (*DiskSpec) String

func (x *DiskSpec) String() string

type DoubleArray

type DoubleArray struct {

	// A list of double values.
	Values []float64 `protobuf:"fixed64,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

A list of double values.

func (*DoubleArray) Descriptor deprecated

func (*DoubleArray) Descriptor() ([]byte, []int)

Deprecated: Use DoubleArray.ProtoReflect.Descriptor instead.

func (*DoubleArray) GetValues

func (x *DoubleArray) GetValues() []float64

func (*DoubleArray) ProtoMessage

func (*DoubleArray) ProtoMessage()

func (*DoubleArray) ProtoReflect

func (x *DoubleArray) ProtoReflect() protoreflect.Message

func (*DoubleArray) Reset

func (x *DoubleArray) Reset()

func (*DoubleArray) String

func (x *DoubleArray) String() string

type EncryptionSpec

type EncryptionSpec struct {

	// Required. The Cloud KMS resource identifier of the customer managed
	// encryption key used to protect a resource. Has the form:
	// `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`.
	// The key needs to be in the same region as where the compute resource is
	// created.
	KmsKeyName string `protobuf:"bytes,1,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
	// contains filtered or unexported fields
}

Represents a customer-managed encryption key spec that can be applied to a top-level resource.

func (*EncryptionSpec) Descriptor deprecated

func (*EncryptionSpec) Descriptor() ([]byte, []int)

Deprecated: Use EncryptionSpec.ProtoReflect.Descriptor instead.

func (*EncryptionSpec) GetKmsKeyName

func (x *EncryptionSpec) GetKmsKeyName() string

func (*EncryptionSpec) ProtoMessage

func (*EncryptionSpec) ProtoMessage()

func (*EncryptionSpec) ProtoReflect

func (x *EncryptionSpec) ProtoReflect() protoreflect.Message

func (*EncryptionSpec) Reset

func (x *EncryptionSpec) Reset()

func (*EncryptionSpec) String

func (x *EncryptionSpec) String() string

type Endpoint

type Endpoint struct {

	// Output only. The resource name of the Endpoint.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The display name of the Endpoint.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The description of the Endpoint.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. The models deployed in this Endpoint.
	// To add or remove DeployedModels use
	// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]
	// and
	// [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]
	// respectively.
	DeployedModels []*DeployedModel `protobuf:"bytes,4,rep,name=deployed_models,json=deployedModels,proto3" json:"deployed_models,omitempty"`
	// A map from a DeployedModel's ID to the percentage of this Endpoint's
	// traffic that should be forwarded to that DeployedModel.
	//
	// If a DeployedModel's ID is not listed in this map, then it receives no
	// traffic.
	//
	// The traffic percentage values must add up to 100, or map must be empty if
	// the Endpoint is to not accept any traffic at a moment.
	TrafficSplit map[string]int32 `` /* 186-byte string literal not displayed */
	// Used to perform consistent read-modify-write updates. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,6,opt,name=etag,proto3" json:"etag,omitempty"`
	// The labels with user-defined metadata to organize your Endpoints.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Output only. Timestamp when this Endpoint was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Endpoint was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Customer-managed encryption key spec for an Endpoint. If set, this
	// Endpoint and all sub-resources of this Endpoint will be secured by
	// this key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,10,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// Optional. The full name of the Google Compute Engine
	// [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
	// to which the Endpoint should be peered.
	//
	// Private services access must already be configured for the network. If left
	// unspecified, the Endpoint is not peered with any network.
	//
	// Only one of the fields,
	// [network][google.cloud.aiplatform.v1.Endpoint.network] or
	// [enable_private_service_connect][google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect],
	// can be set.
	//
	// [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert):
	// `projects/{project}/global/networks/{network}`.
	// Where `{project}` is a project number, as in `12345`, and `{network}` is
	// network name.
	Network string `protobuf:"bytes,13,opt,name=network,proto3" json:"network,omitempty"`
	// Deprecated: If true, expose the Endpoint via private service connect.
	//
	// Only one of the fields,
	// [network][google.cloud.aiplatform.v1.Endpoint.network] or
	// [enable_private_service_connect][google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect],
	// can be set.
	//
	// Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/endpoint.proto.
	EnablePrivateServiceConnect bool `` /* 148-byte string literal not displayed */
	// Output only. Resource name of the Model Monitoring job associated with this
	// Endpoint if monitoring is enabled by
	// [JobService.CreateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.CreateModelDeploymentMonitoringJob].
	// Format:
	// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
	ModelDeploymentMonitoringJob string `` /* 150-byte string literal not displayed */
	// Configures the request-response logging for online prediction.
	PredictRequestResponseLoggingConfig *PredictRequestResponseLoggingConfig `` /* 173-byte string literal not displayed */
	// contains filtered or unexported fields
}

Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.

func (*Endpoint) Descriptor deprecated

func (*Endpoint) Descriptor() ([]byte, []int)

Deprecated: Use Endpoint.ProtoReflect.Descriptor instead.

func (*Endpoint) GetCreateTime

func (x *Endpoint) GetCreateTime() *timestamppb.Timestamp

func (*Endpoint) GetDeployedModels

func (x *Endpoint) GetDeployedModels() []*DeployedModel

func (*Endpoint) GetDescription

func (x *Endpoint) GetDescription() string

func (*Endpoint) GetDisplayName

func (x *Endpoint) GetDisplayName() string

func (*Endpoint) GetEnablePrivateServiceConnect deprecated

func (x *Endpoint) GetEnablePrivateServiceConnect() bool

Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/endpoint.proto.

func (*Endpoint) GetEncryptionSpec

func (x *Endpoint) GetEncryptionSpec() *EncryptionSpec

func (*Endpoint) GetEtag

func (x *Endpoint) GetEtag() string

func (*Endpoint) GetLabels

func (x *Endpoint) GetLabels() map[string]string

func (*Endpoint) GetModelDeploymentMonitoringJob

func (x *Endpoint) GetModelDeploymentMonitoringJob() string

func (*Endpoint) GetName

func (x *Endpoint) GetName() string

func (*Endpoint) GetNetwork

func (x *Endpoint) GetNetwork() string

func (*Endpoint) GetPredictRequestResponseLoggingConfig

func (x *Endpoint) GetPredictRequestResponseLoggingConfig() *PredictRequestResponseLoggingConfig

func (*Endpoint) GetTrafficSplit

func (x *Endpoint) GetTrafficSplit() map[string]int32

func (*Endpoint) GetUpdateTime

func (x *Endpoint) GetUpdateTime() *timestamppb.Timestamp

func (*Endpoint) ProtoMessage

func (*Endpoint) ProtoMessage()

func (*Endpoint) ProtoReflect

func (x *Endpoint) ProtoReflect() protoreflect.Message

func (*Endpoint) Reset

func (x *Endpoint) Reset()

func (*Endpoint) String

func (x *Endpoint) String() string

type EndpointServiceClient

type EndpointServiceClient interface {
	// Creates an Endpoint.
	CreateEndpoint(ctx context.Context, in *CreateEndpointRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets an Endpoint.
	GetEndpoint(ctx context.Context, in *GetEndpointRequest, opts ...grpc.CallOption) (*Endpoint, error)
	// Lists Endpoints in a Location.
	ListEndpoints(ctx context.Context, in *ListEndpointsRequest, opts ...grpc.CallOption) (*ListEndpointsResponse, error)
	// Updates an Endpoint.
	UpdateEndpoint(ctx context.Context, in *UpdateEndpointRequest, opts ...grpc.CallOption) (*Endpoint, error)
	// Deletes an Endpoint.
	DeleteEndpoint(ctx context.Context, in *DeleteEndpointRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deploys a Model into this Endpoint, creating a DeployedModel within it.
	DeployModel(ctx context.Context, in *DeployModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Undeploys a Model from an Endpoint, removing a DeployedModel from it, and
	// freeing all resources it's using.
	UndeployModel(ctx context.Context, in *UndeployModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates an existing deployed model. Updatable fields include
	// `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`,
	// `disable_container_logging` (v1 only), and `enable_container_logging`
	// (v1beta1 only).
	MutateDeployedModel(ctx context.Context, in *MutateDeployedModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

EndpointServiceClient is the client API for EndpointService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type EndpointServiceServer

type EndpointServiceServer interface {
	// Creates an Endpoint.
	CreateEndpoint(context.Context, *CreateEndpointRequest) (*longrunningpb.Operation, error)
	// Gets an Endpoint.
	GetEndpoint(context.Context, *GetEndpointRequest) (*Endpoint, error)
	// Lists Endpoints in a Location.
	ListEndpoints(context.Context, *ListEndpointsRequest) (*ListEndpointsResponse, error)
	// Updates an Endpoint.
	UpdateEndpoint(context.Context, *UpdateEndpointRequest) (*Endpoint, error)
	// Deletes an Endpoint.
	DeleteEndpoint(context.Context, *DeleteEndpointRequest) (*longrunningpb.Operation, error)
	// Deploys a Model into this Endpoint, creating a DeployedModel within it.
	DeployModel(context.Context, *DeployModelRequest) (*longrunningpb.Operation, error)
	// Undeploys a Model from an Endpoint, removing a DeployedModel from it, and
	// freeing all resources it's using.
	UndeployModel(context.Context, *UndeployModelRequest) (*longrunningpb.Operation, error)
	// Updates an existing deployed model. Updatable fields include
	// `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`,
	// `disable_container_logging` (v1 only), and `enable_container_logging`
	// (v1beta1 only).
	MutateDeployedModel(context.Context, *MutateDeployedModelRequest) (*longrunningpb.Operation, error)
}

EndpointServiceServer is the server API for EndpointService service.

type EntityIdSelector added in v1.36.0

type EntityIdSelector struct {

	// Details about the source data, including the location of the storage and
	// the format.
	//
	// Types that are assignable to EntityIdsSource:
	//
	//	*EntityIdSelector_CsvSource
	EntityIdsSource isEntityIdSelector_EntityIdsSource `protobuf_oneof:"EntityIdsSource"`
	// Source column that holds entity IDs. If not provided, entity IDs are
	// extracted from the column named entity_id.
	EntityIdField string `protobuf:"bytes,5,opt,name=entity_id_field,json=entityIdField,proto3" json:"entity_id_field,omitempty"`
	// contains filtered or unexported fields
}

Selector for entityId. Getting ids from the given source.

func (*EntityIdSelector) Descriptor deprecated added in v1.36.0

func (*EntityIdSelector) Descriptor() ([]byte, []int)

Deprecated: Use EntityIdSelector.ProtoReflect.Descriptor instead.

func (*EntityIdSelector) GetCsvSource added in v1.36.0

func (x *EntityIdSelector) GetCsvSource() *CsvSource

func (*EntityIdSelector) GetEntityIdField added in v1.36.0

func (x *EntityIdSelector) GetEntityIdField() string

func (*EntityIdSelector) GetEntityIdsSource added in v1.36.0

func (m *EntityIdSelector) GetEntityIdsSource() isEntityIdSelector_EntityIdsSource

func (*EntityIdSelector) ProtoMessage added in v1.36.0

func (*EntityIdSelector) ProtoMessage()

func (*EntityIdSelector) ProtoReflect added in v1.36.0

func (x *EntityIdSelector) ProtoReflect() protoreflect.Message

func (*EntityIdSelector) Reset added in v1.36.0

func (x *EntityIdSelector) Reset()

func (*EntityIdSelector) String added in v1.36.0

func (x *EntityIdSelector) String() string

type EntityIdSelector_CsvSource added in v1.36.0

type EntityIdSelector_CsvSource struct {
	// Source of Csv
	CsvSource *CsvSource `protobuf:"bytes,3,opt,name=csv_source,json=csvSource,proto3,oneof"`
}

type EntityType

type EntityType struct {

	// Immutable. Name of the EntityType.
	// Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
	//
	// The last part entity_type is assigned by the client. The entity_type can be
	// up to 64 characters long and can consist only of ASCII Latin letters A-Z
	// and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The
	// value will be unique given a featurestore.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Description of the EntityType.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. Timestamp when this EntityType was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this EntityType was most recently updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. The labels with user-defined metadata to organize your
	// EntityTypes.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information on and examples of labels.
	// No more than 64 user labels can be associated with one EntityType (System
	// labels are excluded)."
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Optional. Used to perform a consistent read-modify-write updates. If not
	// set, a blind "overwrite" update happens.
	Etag string `protobuf:"bytes,7,opt,name=etag,proto3" json:"etag,omitempty"`
	// Optional. The default monitoring configuration for all Features with value
	// type
	// ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL,
	// STRING, DOUBLE or INT64 under this EntityType.
	//
	// If this is populated with
	// [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot
	// analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is
	// disabled.
	MonitoringConfig *FeaturestoreMonitoringConfig `protobuf:"bytes,8,opt,name=monitoring_config,json=monitoringConfig,proto3" json:"monitoring_config,omitempty"`
	// Optional. Config for data retention policy in offline storage.
	// TTL in days for feature values that will be stored in offline storage.
	// The Feature Store offline storage periodically removes obsolete feature
	// values older than `offline_storage_ttl_days` since the feature generation
	// time. If unset (or explicitly set to 0), default to 4000 days TTL.
	OfflineStorageTtlDays int32 `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

An entity type is a type of object in a system that needs to be modeled and have stored information about. For example, driver is an entity type, and driver0 is an instance of an entity type driver.

func (*EntityType) Descriptor deprecated

func (*EntityType) Descriptor() ([]byte, []int)

Deprecated: Use EntityType.ProtoReflect.Descriptor instead.

func (*EntityType) GetCreateTime

func (x *EntityType) GetCreateTime() *timestamppb.Timestamp

func (*EntityType) GetDescription

func (x *EntityType) GetDescription() string

func (*EntityType) GetEtag

func (x *EntityType) GetEtag() string

func (*EntityType) GetLabels

func (x *EntityType) GetLabels() map[string]string

func (*EntityType) GetMonitoringConfig

func (x *EntityType) GetMonitoringConfig() *FeaturestoreMonitoringConfig

func (*EntityType) GetName

func (x *EntityType) GetName() string

func (*EntityType) GetOfflineStorageTtlDays added in v1.40.0

func (x *EntityType) GetOfflineStorageTtlDays() int32

func (*EntityType) GetUpdateTime

func (x *EntityType) GetUpdateTime() *timestamppb.Timestamp

func (*EntityType) ProtoMessage

func (*EntityType) ProtoMessage()

func (*EntityType) ProtoReflect

func (x *EntityType) ProtoReflect() protoreflect.Message

func (*EntityType) Reset

func (x *EntityType) Reset()

func (*EntityType) String

func (x *EntityType) String() string

type EnvVar

type EnvVar struct {

	// Required. Name of the environment variable. Must be a valid C identifier.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Variables that reference a $(VAR_NAME) are expanded
	// using the previous defined environment variables in the container and
	// any service environment variables. If a variable cannot be resolved,
	// the reference in the input string will be unchanged. The $(VAR_NAME)
	// syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped
	// references will never be expanded, regardless of whether the variable
	// exists or not.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Represents an environment variable present in a Container or Python Module.

func (*EnvVar) Descriptor deprecated

func (*EnvVar) Descriptor() ([]byte, []int)

Deprecated: Use EnvVar.ProtoReflect.Descriptor instead.

func (*EnvVar) GetName

func (x *EnvVar) GetName() string

func (*EnvVar) GetValue

func (x *EnvVar) GetValue() string

func (*EnvVar) ProtoMessage

func (*EnvVar) ProtoMessage()

func (*EnvVar) ProtoReflect

func (x *EnvVar) ProtoReflect() protoreflect.Message

func (*EnvVar) Reset

func (x *EnvVar) Reset()

func (*EnvVar) String

func (x *EnvVar) String() string

type ErrorAnalysisAnnotation added in v1.36.0

type ErrorAnalysisAnnotation struct {

	// Attributed items for a given annotation, typically representing neighbors
	// from the training sets constrained by the query type.
	AttributedItems []*ErrorAnalysisAnnotation_AttributedItem `protobuf:"bytes,1,rep,name=attributed_items,json=attributedItems,proto3" json:"attributed_items,omitempty"`
	// The query type used for finding the attributed items.
	QueryType ErrorAnalysisAnnotation_QueryType `` /* 155-byte string literal not displayed */
	// The outlier score of this annotated item. Usually defined as the min of all
	// distances from attributed items.
	OutlierScore float64 `protobuf:"fixed64,3,opt,name=outlier_score,json=outlierScore,proto3" json:"outlier_score,omitempty"`
	// The threshold used to determine if this annotation is an outlier or not.
	OutlierThreshold float64 `protobuf:"fixed64,4,opt,name=outlier_threshold,json=outlierThreshold,proto3" json:"outlier_threshold,omitempty"`
	// contains filtered or unexported fields
}

Model error analysis for each annotation.

func (*ErrorAnalysisAnnotation) Descriptor deprecated added in v1.36.0

func (*ErrorAnalysisAnnotation) Descriptor() ([]byte, []int)

Deprecated: Use ErrorAnalysisAnnotation.ProtoReflect.Descriptor instead.

func (*ErrorAnalysisAnnotation) GetAttributedItems added in v1.36.0

func (*ErrorAnalysisAnnotation) GetOutlierScore added in v1.36.0

func (x *ErrorAnalysisAnnotation) GetOutlierScore() float64

func (*ErrorAnalysisAnnotation) GetOutlierThreshold added in v1.36.0

func (x *ErrorAnalysisAnnotation) GetOutlierThreshold() float64

func (*ErrorAnalysisAnnotation) GetQueryType added in v1.36.0

func (*ErrorAnalysisAnnotation) ProtoMessage added in v1.36.0

func (*ErrorAnalysisAnnotation) ProtoMessage()

func (*ErrorAnalysisAnnotation) ProtoReflect added in v1.36.0

func (x *ErrorAnalysisAnnotation) ProtoReflect() protoreflect.Message

func (*ErrorAnalysisAnnotation) Reset added in v1.36.0

func (x *ErrorAnalysisAnnotation) Reset()

func (*ErrorAnalysisAnnotation) String added in v1.36.0

func (x *ErrorAnalysisAnnotation) String() string

type ErrorAnalysisAnnotation_AttributedItem added in v1.36.0

type ErrorAnalysisAnnotation_AttributedItem struct {

	// The unique ID for each annotation. Used by FE to allocate the annotation
	// in DB.
	AnnotationResourceName string `` /* 129-byte string literal not displayed */
	// The distance of this item to the annotation.
	Distance float64 `protobuf:"fixed64,2,opt,name=distance,proto3" json:"distance,omitempty"`
	// contains filtered or unexported fields
}

Attributed items for a given annotation, typically representing neighbors from the training sets constrained by the query type.

func (*ErrorAnalysisAnnotation_AttributedItem) Descriptor deprecated added in v1.36.0

func (*ErrorAnalysisAnnotation_AttributedItem) Descriptor() ([]byte, []int)

Deprecated: Use ErrorAnalysisAnnotation_AttributedItem.ProtoReflect.Descriptor instead.

func (*ErrorAnalysisAnnotation_AttributedItem) GetAnnotationResourceName added in v1.36.0

func (x *ErrorAnalysisAnnotation_AttributedItem) GetAnnotationResourceName() string

func (*ErrorAnalysisAnnotation_AttributedItem) GetDistance added in v1.36.0

func (*ErrorAnalysisAnnotation_AttributedItem) ProtoMessage added in v1.36.0

func (*ErrorAnalysisAnnotation_AttributedItem) ProtoReflect added in v1.36.0

func (*ErrorAnalysisAnnotation_AttributedItem) Reset added in v1.36.0

func (*ErrorAnalysisAnnotation_AttributedItem) String added in v1.36.0

type ErrorAnalysisAnnotation_QueryType added in v1.36.0

type ErrorAnalysisAnnotation_QueryType int32

The query type used for finding the attributed items.

const (
	// Unspecified query type for model error analysis.
	ErrorAnalysisAnnotation_QUERY_TYPE_UNSPECIFIED ErrorAnalysisAnnotation_QueryType = 0
	// Query similar samples across all classes in the dataset.
	ErrorAnalysisAnnotation_ALL_SIMILAR ErrorAnalysisAnnotation_QueryType = 1
	// Query similar samples from the same class of the input sample.
	ErrorAnalysisAnnotation_SAME_CLASS_SIMILAR ErrorAnalysisAnnotation_QueryType = 2
	// Query dissimilar samples from the same class of the input sample.
	ErrorAnalysisAnnotation_SAME_CLASS_DISSIMILAR ErrorAnalysisAnnotation_QueryType = 3
)

func (ErrorAnalysisAnnotation_QueryType) Descriptor added in v1.36.0

func (ErrorAnalysisAnnotation_QueryType) Enum added in v1.36.0

func (ErrorAnalysisAnnotation_QueryType) EnumDescriptor deprecated added in v1.36.0

func (ErrorAnalysisAnnotation_QueryType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ErrorAnalysisAnnotation_QueryType.Descriptor instead.

func (ErrorAnalysisAnnotation_QueryType) Number added in v1.36.0

func (ErrorAnalysisAnnotation_QueryType) String added in v1.36.0

func (ErrorAnalysisAnnotation_QueryType) Type added in v1.36.0

type EvaluatedAnnotation added in v1.36.0

type EvaluatedAnnotation struct {

	// Output only. Type of the EvaluatedAnnotation.
	Type EvaluatedAnnotation_EvaluatedAnnotationType `` /* 138-byte string literal not displayed */
	// Output only. The model predicted annotations.
	//
	// For true positive, there is one and only one prediction, which matches the
	// only one ground truth annotation in
	// [ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths].
	//
	// For false positive, there is one and only one prediction, which doesn't
	// match any ground truth annotation of the corresponding
	// [data_item_view_id][EvaluatedAnnotation.data_item_view_id].
	//
	// For false negative, there are zero or more predictions which are similar to
	// the only ground truth annotation in
	// [ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths]
	// but not enough for a match.
	//
	// The schema of the prediction is stored in
	// [ModelEvaluation.annotation_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.annotation_schema_uri]
	Predictions []*structpb.Value `protobuf:"bytes,2,rep,name=predictions,proto3" json:"predictions,omitempty"`
	// Output only. The ground truth Annotations, i.e. the Annotations that exist
	// in the test data the Model is evaluated on.
	//
	// For true positive, there is one and only one ground truth annotation, which
	// matches the only prediction in
	// [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions].
	//
	// For false positive, there are zero or more ground truth annotations that
	// are similar to the only prediction in
	// [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions],
	// but not enough for a match.
	//
	// For false negative, there is one and only one ground truth annotation,
	// which doesn't match any predictions created by the model.
	//
	// The schema of the ground truth is stored in
	// [ModelEvaluation.annotation_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.annotation_schema_uri]
	GroundTruths []*structpb.Value `protobuf:"bytes,3,rep,name=ground_truths,json=groundTruths,proto3" json:"ground_truths,omitempty"`
	// Output only. The data item payload that the Model predicted this
	// EvaluatedAnnotation on.
	DataItemPayload *structpb.Value `protobuf:"bytes,5,opt,name=data_item_payload,json=dataItemPayload,proto3" json:"data_item_payload,omitempty"`
	// Output only. ID of the EvaluatedDataItemView under the same ancestor
	// ModelEvaluation. The EvaluatedDataItemView consists of all ground truths
	// and predictions on
	// [data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].
	EvaluatedDataItemViewId string `` /* 136-byte string literal not displayed */
	// Explanations of
	// [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions].
	// Each element of the explanations indicates the explanation for one
	// explanation Method.
	//
	// The attributions list in the
	// [EvaluatedAnnotationExplanation.explanation][google.cloud.aiplatform.v1.EvaluatedAnnotationExplanation.explanation]
	// object corresponds to the
	// [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions]
	// list. For example, the second element in the attributions list explains the
	// second element in the predictions list.
	Explanations []*EvaluatedAnnotationExplanation `protobuf:"bytes,8,rep,name=explanations,proto3" json:"explanations,omitempty"`
	// Annotations of model error analysis results.
	ErrorAnalysisAnnotations []*ErrorAnalysisAnnotation `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

True positive, false positive, or false negative.

EvaluatedAnnotation is only available under ModelEvaluationSlice with slice of `annotationSpec` dimension.

func (*EvaluatedAnnotation) Descriptor deprecated added in v1.36.0

func (*EvaluatedAnnotation) Descriptor() ([]byte, []int)

Deprecated: Use EvaluatedAnnotation.ProtoReflect.Descriptor instead.

func (*EvaluatedAnnotation) GetDataItemPayload added in v1.36.0

func (x *EvaluatedAnnotation) GetDataItemPayload() *structpb.Value

func (*EvaluatedAnnotation) GetErrorAnalysisAnnotations added in v1.36.0

func (x *EvaluatedAnnotation) GetErrorAnalysisAnnotations() []*ErrorAnalysisAnnotation

func (*EvaluatedAnnotation) GetEvaluatedDataItemViewId added in v1.36.0

func (x *EvaluatedAnnotation) GetEvaluatedDataItemViewId() string

func (*EvaluatedAnnotation) GetExplanations added in v1.36.0

func (x *EvaluatedAnnotation) GetExplanations() []*EvaluatedAnnotationExplanation

func (*EvaluatedAnnotation) GetGroundTruths added in v1.36.0

func (x *EvaluatedAnnotation) GetGroundTruths() []*structpb.Value

func (*EvaluatedAnnotation) GetPredictions added in v1.36.0

func (x *EvaluatedAnnotation) GetPredictions() []*structpb.Value

func (*EvaluatedAnnotation) GetType added in v1.36.0

func (*EvaluatedAnnotation) ProtoMessage added in v1.36.0

func (*EvaluatedAnnotation) ProtoMessage()

func (*EvaluatedAnnotation) ProtoReflect added in v1.36.0

func (x *EvaluatedAnnotation) ProtoReflect() protoreflect.Message

func (*EvaluatedAnnotation) Reset added in v1.36.0

func (x *EvaluatedAnnotation) Reset()

func (*EvaluatedAnnotation) String added in v1.36.0

func (x *EvaluatedAnnotation) String() string

type EvaluatedAnnotationExplanation added in v1.36.0

type EvaluatedAnnotationExplanation struct {

	// Explanation type.
	//
	// For AutoML Image Classification models, possible values are:
	//
	//   - `image-integrated-gradients`
	//   - `image-xrai`
	ExplanationType string `protobuf:"bytes,1,opt,name=explanation_type,json=explanationType,proto3" json:"explanation_type,omitempty"`
	// Explanation attribution response details.
	Explanation *Explanation `protobuf:"bytes,2,opt,name=explanation,proto3" json:"explanation,omitempty"`
	// contains filtered or unexported fields
}

Explanation result of the prediction produced by the Model.

func (*EvaluatedAnnotationExplanation) Descriptor deprecated added in v1.36.0

func (*EvaluatedAnnotationExplanation) Descriptor() ([]byte, []int)

Deprecated: Use EvaluatedAnnotationExplanation.ProtoReflect.Descriptor instead.

func (*EvaluatedAnnotationExplanation) GetExplanation added in v1.36.0

func (x *EvaluatedAnnotationExplanation) GetExplanation() *Explanation

func (*EvaluatedAnnotationExplanation) GetExplanationType added in v1.36.0

func (x *EvaluatedAnnotationExplanation) GetExplanationType() string

func (*EvaluatedAnnotationExplanation) ProtoMessage added in v1.36.0

func (*EvaluatedAnnotationExplanation) ProtoMessage()

func (*EvaluatedAnnotationExplanation) ProtoReflect added in v1.36.0

func (*EvaluatedAnnotationExplanation) Reset added in v1.36.0

func (x *EvaluatedAnnotationExplanation) Reset()

func (*EvaluatedAnnotationExplanation) String added in v1.36.0

type EvaluatedAnnotation_EvaluatedAnnotationType added in v1.36.0

type EvaluatedAnnotation_EvaluatedAnnotationType int32

Describes the type of the EvaluatedAnnotation. The type is determined

const (
	// Invalid value.
	EvaluatedAnnotation_EVALUATED_ANNOTATION_TYPE_UNSPECIFIED EvaluatedAnnotation_EvaluatedAnnotationType = 0
	// The EvaluatedAnnotation is a true positive. It has a prediction created
	// by the Model and a ground truth Annotation which the prediction matches.
	EvaluatedAnnotation_TRUE_POSITIVE EvaluatedAnnotation_EvaluatedAnnotationType = 1
	// The EvaluatedAnnotation is false positive. It has a prediction created by
	// the Model which does not match any ground truth annotation.
	EvaluatedAnnotation_FALSE_POSITIVE EvaluatedAnnotation_EvaluatedAnnotationType = 2
	// The EvaluatedAnnotation is false negative. It has a ground truth
	// annotation which is not matched by any of the model created predictions.
	EvaluatedAnnotation_FALSE_NEGATIVE EvaluatedAnnotation_EvaluatedAnnotationType = 3
)

func (EvaluatedAnnotation_EvaluatedAnnotationType) Descriptor added in v1.36.0

func (EvaluatedAnnotation_EvaluatedAnnotationType) Enum added in v1.36.0

func (EvaluatedAnnotation_EvaluatedAnnotationType) EnumDescriptor deprecated added in v1.36.0

func (EvaluatedAnnotation_EvaluatedAnnotationType) EnumDescriptor() ([]byte, []int)

Deprecated: Use EvaluatedAnnotation_EvaluatedAnnotationType.Descriptor instead.

func (EvaluatedAnnotation_EvaluatedAnnotationType) Number added in v1.36.0

func (EvaluatedAnnotation_EvaluatedAnnotationType) String added in v1.36.0

func (EvaluatedAnnotation_EvaluatedAnnotationType) Type added in v1.36.0

type Event

type Event struct {

	// Required. The relative resource name of the Artifact in the Event.
	Artifact string `protobuf:"bytes,1,opt,name=artifact,proto3" json:"artifact,omitempty"`
	// Output only. The relative resource name of the Execution in the Event.
	Execution string `protobuf:"bytes,2,opt,name=execution,proto3" json:"execution,omitempty"`
	// Output only. Time the Event occurred.
	EventTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
	// Required. The type of the Event.
	Type Event_Type `protobuf:"varint,4,opt,name=type,proto3,enum=google.cloud.aiplatform.v1.Event_Type" json:"type,omitempty"`
	// The labels with user-defined metadata to annotate Events.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one Event (System
	// labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

An edge describing the relationship between an Artifact and an Execution in a lineage graph.

func (*Event) Descriptor deprecated

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetArtifact

func (x *Event) GetArtifact() string

func (*Event) GetEventTime

func (x *Event) GetEventTime() *timestamppb.Timestamp

func (*Event) GetExecution

func (x *Event) GetExecution() string

func (*Event) GetLabels

func (x *Event) GetLabels() map[string]string

func (*Event) GetType

func (x *Event) GetType() Event_Type

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect

func (x *Event) ProtoReflect() protoreflect.Message

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

type Event_Type

type Event_Type int32

Describes whether an Event's Artifact is the Execution's input or output.

const (
	// Unspecified whether input or output of the Execution.
	Event_TYPE_UNSPECIFIED Event_Type = 0
	// An input of the Execution.
	Event_INPUT Event_Type = 1
	// An output of the Execution.
	Event_OUTPUT Event_Type = 2
)

func (Event_Type) Descriptor

func (Event_Type) Descriptor() protoreflect.EnumDescriptor

func (Event_Type) Enum

func (x Event_Type) Enum() *Event_Type

func (Event_Type) EnumDescriptor deprecated

func (Event_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Event_Type.Descriptor instead.

func (Event_Type) Number

func (x Event_Type) Number() protoreflect.EnumNumber

func (Event_Type) String

func (x Event_Type) String() string

func (Event_Type) Type

type Examples added in v1.42.0

type Examples struct {

	// Types that are assignable to Source:
	//
	//	*Examples_ExampleGcsSource_
	Source isExamples_Source `protobuf_oneof:"source"`
	// Types that are assignable to Config:
	//
	//	*Examples_NearestNeighborSearchConfig
	//	*Examples_Presets
	Config isExamples_Config `protobuf_oneof:"config"`
	// The number of neighbors to return when querying for examples.
	NeighborCount int32 `protobuf:"varint,3,opt,name=neighbor_count,json=neighborCount,proto3" json:"neighbor_count,omitempty"`
	// contains filtered or unexported fields
}

Example-based explainability that returns the nearest neighbors from the provided dataset.

func (*Examples) Descriptor deprecated added in v1.42.0

func (*Examples) Descriptor() ([]byte, []int)

Deprecated: Use Examples.ProtoReflect.Descriptor instead.

func (*Examples) GetConfig added in v1.42.0

func (m *Examples) GetConfig() isExamples_Config

func (*Examples) GetExampleGcsSource added in v1.42.0

func (x *Examples) GetExampleGcsSource() *Examples_ExampleGcsSource

func (*Examples) GetNearestNeighborSearchConfig added in v1.42.0

func (x *Examples) GetNearestNeighborSearchConfig() *structpb.Value

func (*Examples) GetNeighborCount added in v1.42.0

func (x *Examples) GetNeighborCount() int32

func (*Examples) GetPresets added in v1.42.0

func (x *Examples) GetPresets() *Presets

func (*Examples) GetSource added in v1.42.0

func (m *Examples) GetSource() isExamples_Source

func (*Examples) ProtoMessage added in v1.42.0

func (*Examples) ProtoMessage()

func (*Examples) ProtoReflect added in v1.42.0

func (x *Examples) ProtoReflect() protoreflect.Message

func (*Examples) Reset added in v1.42.0

func (x *Examples) Reset()

func (*Examples) String added in v1.42.0

func (x *Examples) String() string

type ExamplesOverride

type ExamplesOverride struct {

	// The number of neighbors to return.
	NeighborCount int32 `protobuf:"varint,1,opt,name=neighbor_count,json=neighborCount,proto3" json:"neighbor_count,omitempty"`
	// The number of neighbors to return that have the same crowding tag.
	CrowdingCount int32 `protobuf:"varint,2,opt,name=crowding_count,json=crowdingCount,proto3" json:"crowding_count,omitempty"`
	// Restrict the resulting nearest neighbors to respect these constraints.
	Restrictions []*ExamplesRestrictionsNamespace `protobuf:"bytes,3,rep,name=restrictions,proto3" json:"restrictions,omitempty"`
	// If true, return the embeddings instead of neighbors.
	ReturnEmbeddings bool `protobuf:"varint,4,opt,name=return_embeddings,json=returnEmbeddings,proto3" json:"return_embeddings,omitempty"`
	// The format of the data being provided with each call.
	DataFormat ExamplesOverride_DataFormat `` /* 152-byte string literal not displayed */
	// contains filtered or unexported fields
}

Overrides for example-based explanations.

func (*ExamplesOverride) Descriptor deprecated

func (*ExamplesOverride) Descriptor() ([]byte, []int)

Deprecated: Use ExamplesOverride.ProtoReflect.Descriptor instead.

func (*ExamplesOverride) GetCrowdingCount

func (x *ExamplesOverride) GetCrowdingCount() int32

func (*ExamplesOverride) GetDataFormat

func (x *ExamplesOverride) GetDataFormat() ExamplesOverride_DataFormat

func (*ExamplesOverride) GetNeighborCount

func (x *ExamplesOverride) GetNeighborCount() int32

func (*ExamplesOverride) GetRestrictions

func (x *ExamplesOverride) GetRestrictions() []*ExamplesRestrictionsNamespace

func (*ExamplesOverride) GetReturnEmbeddings

func (x *ExamplesOverride) GetReturnEmbeddings() bool

func (*ExamplesOverride) ProtoMessage

func (*ExamplesOverride) ProtoMessage()

func (*ExamplesOverride) ProtoReflect

func (x *ExamplesOverride) ProtoReflect() protoreflect.Message

func (*ExamplesOverride) Reset

func (x *ExamplesOverride) Reset()

func (*ExamplesOverride) String

func (x *ExamplesOverride) String() string

type ExamplesOverride_DataFormat

type ExamplesOverride_DataFormat int32

Data format enum.

const (
	// Unspecified format. Must not be used.
	ExamplesOverride_DATA_FORMAT_UNSPECIFIED ExamplesOverride_DataFormat = 0
	// Provided data is a set of model inputs.
	ExamplesOverride_INSTANCES ExamplesOverride_DataFormat = 1
	// Provided data is a set of embeddings.
	ExamplesOverride_EMBEDDINGS ExamplesOverride_DataFormat = 2
)

func (ExamplesOverride_DataFormat) Descriptor

func (ExamplesOverride_DataFormat) Enum

func (ExamplesOverride_DataFormat) EnumDescriptor deprecated

func (ExamplesOverride_DataFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use ExamplesOverride_DataFormat.Descriptor instead.

func (ExamplesOverride_DataFormat) Number

func (ExamplesOverride_DataFormat) String

func (ExamplesOverride_DataFormat) Type

type ExamplesRestrictionsNamespace

type ExamplesRestrictionsNamespace struct {

	// The namespace name.
	NamespaceName string `protobuf:"bytes,1,opt,name=namespace_name,json=namespaceName,proto3" json:"namespace_name,omitempty"`
	// The list of allowed tags.
	Allow []string `protobuf:"bytes,2,rep,name=allow,proto3" json:"allow,omitempty"`
	// The list of deny tags.
	Deny []string `protobuf:"bytes,3,rep,name=deny,proto3" json:"deny,omitempty"`
	// contains filtered or unexported fields
}

Restrictions namespace for example-based explanations overrides.

func (*ExamplesRestrictionsNamespace) Descriptor deprecated

func (*ExamplesRestrictionsNamespace) Descriptor() ([]byte, []int)

Deprecated: Use ExamplesRestrictionsNamespace.ProtoReflect.Descriptor instead.

func (*ExamplesRestrictionsNamespace) GetAllow

func (x *ExamplesRestrictionsNamespace) GetAllow() []string

func (*ExamplesRestrictionsNamespace) GetDeny

func (x *ExamplesRestrictionsNamespace) GetDeny() []string

func (*ExamplesRestrictionsNamespace) GetNamespaceName

func (x *ExamplesRestrictionsNamespace) GetNamespaceName() string

func (*ExamplesRestrictionsNamespace) ProtoMessage

func (*ExamplesRestrictionsNamespace) ProtoMessage()

func (*ExamplesRestrictionsNamespace) ProtoReflect

func (*ExamplesRestrictionsNamespace) Reset

func (x *ExamplesRestrictionsNamespace) Reset()

func (*ExamplesRestrictionsNamespace) String

type Examples_ExampleGcsSource added in v1.42.0

type Examples_ExampleGcsSource struct {

	// The format in which instances are given, if not specified, assume it's
	// JSONL format. Currently only JSONL format is supported.
	DataFormat Examples_ExampleGcsSource_DataFormat `` /* 161-byte string literal not displayed */
	// The Cloud Storage location for the input instances.
	GcsSource *GcsSource `protobuf:"bytes,2,opt,name=gcs_source,json=gcsSource,proto3" json:"gcs_source,omitempty"`
	// contains filtered or unexported fields
}

The Cloud Storage input instances.

func (*Examples_ExampleGcsSource) Descriptor deprecated added in v1.42.0

func (*Examples_ExampleGcsSource) Descriptor() ([]byte, []int)

Deprecated: Use Examples_ExampleGcsSource.ProtoReflect.Descriptor instead.

func (*Examples_ExampleGcsSource) GetDataFormat added in v1.42.0

func (*Examples_ExampleGcsSource) GetGcsSource added in v1.42.0

func (x *Examples_ExampleGcsSource) GetGcsSource() *GcsSource

func (*Examples_ExampleGcsSource) ProtoMessage added in v1.42.0

func (*Examples_ExampleGcsSource) ProtoMessage()

func (*Examples_ExampleGcsSource) ProtoReflect added in v1.42.0

func (*Examples_ExampleGcsSource) Reset added in v1.42.0

func (x *Examples_ExampleGcsSource) Reset()

func (*Examples_ExampleGcsSource) String added in v1.42.0

func (x *Examples_ExampleGcsSource) String() string

type Examples_ExampleGcsSource_ added in v1.42.0

type Examples_ExampleGcsSource_ struct {
	// The Cloud Storage input instances.
	ExampleGcsSource *Examples_ExampleGcsSource `protobuf:"bytes,5,opt,name=example_gcs_source,json=exampleGcsSource,proto3,oneof"`
}

type Examples_ExampleGcsSource_DataFormat added in v1.42.0

type Examples_ExampleGcsSource_DataFormat int32

The format of the input example instances.

const (
	// Format unspecified, used when unset.
	Examples_ExampleGcsSource_DATA_FORMAT_UNSPECIFIED Examples_ExampleGcsSource_DataFormat = 0
	// Examples are stored in JSONL files.
	Examples_ExampleGcsSource_JSONL Examples_ExampleGcsSource_DataFormat = 1
)

func (Examples_ExampleGcsSource_DataFormat) Descriptor added in v1.42.0

func (Examples_ExampleGcsSource_DataFormat) Enum added in v1.42.0

func (Examples_ExampleGcsSource_DataFormat) EnumDescriptor deprecated added in v1.42.0

func (Examples_ExampleGcsSource_DataFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use Examples_ExampleGcsSource_DataFormat.Descriptor instead.

func (Examples_ExampleGcsSource_DataFormat) Number added in v1.42.0

func (Examples_ExampleGcsSource_DataFormat) String added in v1.42.0

func (Examples_ExampleGcsSource_DataFormat) Type added in v1.42.0

type Examples_NearestNeighborSearchConfig added in v1.42.0

type Examples_NearestNeighborSearchConfig struct {
	// The full configuration for the generated index, the semantics are the
	// same as [metadata][google.cloud.aiplatform.v1.Index.metadata] and should
	// match
	// [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
	NearestNeighborSearchConfig *structpb.Value `protobuf:"bytes,2,opt,name=nearest_neighbor_search_config,json=nearestNeighborSearchConfig,proto3,oneof"`
}

type Examples_Presets added in v1.42.0

type Examples_Presets struct {
	// Simplified preset configuration, which automatically sets configuration
	// values based on the desired query speed-precision trade-off and modality.
	Presets *Presets `protobuf:"bytes,4,opt,name=presets,proto3,oneof"`
}

type Execution

type Execution struct {

	// Output only. The resource name of the Execution.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// User provided display name of the Execution.
	// May be up to 128 Unicode characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The state of this Execution. This is a property of the Execution, and does
	// not imply or capture any ongoing process. This property is managed by
	// clients (such as Vertex AI Pipelines) and the system does not prescribe
	// or check the validity of state transitions.
	State Execution_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.Execution_State" json:"state,omitempty"`
	// An eTag used to perform consistent read-modify-write updates. If not set, a
	// blind "overwrite" update happens.
	Etag string `protobuf:"bytes,9,opt,name=etag,proto3" json:"etag,omitempty"`
	// The labels with user-defined metadata to organize your Executions.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one Execution (System
	// labels are excluded).
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Output only. Timestamp when this Execution was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Execution was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The title of the schema describing the metadata.
	//
	// Schema title and version is expected to be registered in earlier Create
	// Schema calls. And both are used together as unique identifiers to identify
	// schemas within the local metadata store.
	SchemaTitle string `protobuf:"bytes,13,opt,name=schema_title,json=schemaTitle,proto3" json:"schema_title,omitempty"`
	// The version of the schema in `schema_title` to use.
	//
	// Schema title and version is expected to be registered in earlier Create
	// Schema calls. And both are used together as unique identifiers to identify
	// schemas within the local metadata store.
	SchemaVersion string `protobuf:"bytes,14,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`
	// Properties of the Execution.
	// Top level metadata keys' heading and trailing spaces will be trimmed.
	// The size of this field should not exceed 200KB.
	Metadata *structpb.Struct `protobuf:"bytes,15,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Description of the Execution
	Description string `protobuf:"bytes,16,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Instance of a general execution.

func (*Execution) Descriptor deprecated

func (*Execution) Descriptor() ([]byte, []int)

Deprecated: Use Execution.ProtoReflect.Descriptor instead.

func (*Execution) GetCreateTime

func (x *Execution) GetCreateTime() *timestamppb.Timestamp

func (*Execution) GetDescription

func (x *Execution) GetDescription() string

func (*Execution) GetDisplayName

func (x *Execution) GetDisplayName() string

func (*Execution) GetEtag

func (x *Execution) GetEtag() string

func (*Execution) GetLabels

func (x *Execution) GetLabels() map[string]string

func (*Execution) GetMetadata

func (x *Execution) GetMetadata() *structpb.Struct

func (*Execution) GetName

func (x *Execution) GetName() string

func (*Execution) GetSchemaTitle

func (x *Execution) GetSchemaTitle() string

func (*Execution) GetSchemaVersion

func (x *Execution) GetSchemaVersion() string

func (*Execution) GetState

func (x *Execution) GetState() Execution_State

func (*Execution) GetUpdateTime

func (x *Execution) GetUpdateTime() *timestamppb.Timestamp

func (*Execution) ProtoMessage

func (*Execution) ProtoMessage()

func (*Execution) ProtoReflect

func (x *Execution) ProtoReflect() protoreflect.Message

func (*Execution) Reset

func (x *Execution) Reset()

func (*Execution) String

func (x *Execution) String() string

type Execution_State

type Execution_State int32

Describes the state of the Execution.

const (
	// Unspecified Execution state
	Execution_STATE_UNSPECIFIED Execution_State = 0
	// The Execution is new
	Execution_NEW Execution_State = 1
	// The Execution is running
	Execution_RUNNING Execution_State = 2
	// The Execution has finished running
	Execution_COMPLETE Execution_State = 3
	// The Execution has failed
	Execution_FAILED Execution_State = 4
	// The Execution completed through Cache hit.
	Execution_CACHED Execution_State = 5
	// The Execution was cancelled.
	Execution_CANCELLED Execution_State = 6
)

func (Execution_State) Descriptor

func (Execution_State) Enum

func (x Execution_State) Enum() *Execution_State

func (Execution_State) EnumDescriptor deprecated

func (Execution_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Execution_State.Descriptor instead.

func (Execution_State) Number

func (Execution_State) String

func (x Execution_State) String() string

func (Execution_State) Type

type ExplainRequest

type ExplainRequest struct {

	// Required. The name of the Endpoint requested to serve the explanation.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Required. The instances that are the input to the explanation call.
	// A DeployedModel may have an upper limit on the number of instances it
	// supports per request, and when it is exceeded the explanation call errors
	// in case of AutoML Models, or, in case of customer created Models, the
	// behaviour is as documented by that Model.
	// The schema of any single instance may be specified via Endpoint's
	// DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
	// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
	Instances []*structpb.Value `protobuf:"bytes,2,rep,name=instances,proto3" json:"instances,omitempty"`
	// The parameters that govern the prediction. The schema of the parameters may
	// be specified via Endpoint's DeployedModels' [Model's
	// ][google.cloud.aiplatform.v1.DeployedModel.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
	// [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
	Parameters *structpb.Value `protobuf:"bytes,4,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// If specified, overrides the
	// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
	// of the DeployedModel. Can be used for explaining prediction results with
	// different configurations, such as:
	//   - Explaining top-5 predictions results as opposed to top-1;
	//   - Increasing path count or step count of the attribution methods to reduce
	//     approximate errors;
	//   - Using different baselines for explaining the prediction results.
	ExplanationSpecOverride *ExplanationSpecOverride `` /* 132-byte string literal not displayed */
	// If specified, this ExplainRequest will be served by the chosen
	// DeployedModel, overriding
	// [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
	DeployedModelId string `protobuf:"bytes,3,opt,name=deployed_model_id,json=deployedModelId,proto3" json:"deployed_model_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].

func (*ExplainRequest) Descriptor deprecated

func (*ExplainRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExplainRequest.ProtoReflect.Descriptor instead.

func (*ExplainRequest) GetDeployedModelId

func (x *ExplainRequest) GetDeployedModelId() string

func (*ExplainRequest) GetEndpoint

func (x *ExplainRequest) GetEndpoint() string

func (*ExplainRequest) GetExplanationSpecOverride

func (x *ExplainRequest) GetExplanationSpecOverride() *ExplanationSpecOverride

func (*ExplainRequest) GetInstances

func (x *ExplainRequest) GetInstances() []*structpb.Value

func (*ExplainRequest) GetParameters

func (x *ExplainRequest) GetParameters() *structpb.Value

func (*ExplainRequest) ProtoMessage

func (*ExplainRequest) ProtoMessage()

func (*ExplainRequest) ProtoReflect

func (x *ExplainRequest) ProtoReflect() protoreflect.Message

func (*ExplainRequest) Reset

func (x *ExplainRequest) Reset()

func (*ExplainRequest) String

func (x *ExplainRequest) String() string

type ExplainResponse

type ExplainResponse struct {

	// The explanations of the Model's
	// [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
	//
	// It has the same number of elements as
	// [instances][google.cloud.aiplatform.v1.ExplainRequest.instances] to be
	// explained.
	Explanations []*Explanation `protobuf:"bytes,1,rep,name=explanations,proto3" json:"explanations,omitempty"`
	// ID of the Endpoint's DeployedModel that served this explanation.
	DeployedModelId string `protobuf:"bytes,2,opt,name=deployed_model_id,json=deployedModelId,proto3" json:"deployed_model_id,omitempty"`
	// The predictions that are the output of the predictions call.
	// Same as
	// [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
	Predictions []*structpb.Value `protobuf:"bytes,3,rep,name=predictions,proto3" json:"predictions,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].

func (*ExplainResponse) Descriptor deprecated

func (*ExplainResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExplainResponse.ProtoReflect.Descriptor instead.

func (*ExplainResponse) GetDeployedModelId

func (x *ExplainResponse) GetDeployedModelId() string

func (*ExplainResponse) GetExplanations

func (x *ExplainResponse) GetExplanations() []*Explanation

func (*ExplainResponse) GetPredictions

func (x *ExplainResponse) GetPredictions() []*structpb.Value

func (*ExplainResponse) ProtoMessage

func (*ExplainResponse) ProtoMessage()

func (*ExplainResponse) ProtoReflect

func (x *ExplainResponse) ProtoReflect() protoreflect.Message

func (*ExplainResponse) Reset

func (x *ExplainResponse) Reset()

func (*ExplainResponse) String

func (x *ExplainResponse) String() string

type Explanation

type Explanation struct {

	// Output only. Feature attributions grouped by predicted outputs.
	//
	// For Models that predict only one output, such as regression Models that
	// predict only one score, there is only one attibution that explains the
	// predicted output. For Models that predict multiple outputs, such as
	// multiclass Models that predict multiple classes, each element explains one
	// specific item.
	// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
	// can be used to identify which output this attribution is explaining.
	//
	// By default, we provide Shapley values for the predicted class. However,
	// you can configure the explanation request to generate Shapley values for
	// any other classes too. For example, if a model predicts a probability of
	// `0.4` for approving a loan application, the model's decision is to reject
	// the application since `p(reject) = 0.6 > p(approve) = 0.4`, and the default
	// Shapley values would be computed for rejection decision and not approval,
	// even though the latter might be the positive class.
	//
	// If users set
	// [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
	// the attributions are sorted by
	// [instance_output_value][Attributions.instance_output_value] in descending
	// order. If
	// [ExplanationParameters.output_indices][google.cloud.aiplatform.v1.ExplanationParameters.output_indices]
	// is specified, the attributions are stored by
	// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
	// in the same order as they appear in the output_indices.
	Attributions []*Attribution `protobuf:"bytes,1,rep,name=attributions,proto3" json:"attributions,omitempty"`
	// Output only. List of the nearest neighbors for example-based explanations.
	//
	// For models deployed with the examples explanations feature enabled, the
	// attributions field is empty and instead the neighbors field is populated.
	Neighbors []*Neighbor `protobuf:"bytes,2,rep,name=neighbors,proto3" json:"neighbors,omitempty"`
	// contains filtered or unexported fields
}

Explanation of a prediction (provided in [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions]) produced by the Model on a given [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].

func (*Explanation) Descriptor deprecated

func (*Explanation) Descriptor() ([]byte, []int)

Deprecated: Use Explanation.ProtoReflect.Descriptor instead.

func (*Explanation) GetAttributions

func (x *Explanation) GetAttributions() []*Attribution

func (*Explanation) GetNeighbors

func (x *Explanation) GetNeighbors() []*Neighbor

func (*Explanation) ProtoMessage

func (*Explanation) ProtoMessage()

func (*Explanation) ProtoReflect

func (x *Explanation) ProtoReflect() protoreflect.Message

func (*Explanation) Reset

func (x *Explanation) Reset()

func (*Explanation) String

func (x *Explanation) String() string

type ExplanationMetadata

type ExplanationMetadata struct {

	// Required. Map from feature names to feature input metadata. Keys are the
	// name of the features. Values are the specification of the feature.
	//
	// An empty InputMetadata is valid. It describes a text feature which has the
	// name specified as the key in
	// [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
	// The baseline of the empty feature is chosen by Vertex AI.
	//
	// For Vertex AI-provided Tensorflow images, the key can be any friendly
	// name of the feature. Once specified,
	// [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
	// are keyed by this key (if not grouped with another feature).
	//
	// For custom images, the key must match with the key in
	// [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
	Inputs map[string]*ExplanationMetadata_InputMetadata `` /* 153-byte string literal not displayed */
	// Required. Map from output names to output metadata.
	//
	// For Vertex AI-provided Tensorflow images, keys can be any user defined
	// string that consists of any UTF-8 characters.
	//
	// For custom images, keys are the name of the output field in the prediction
	// to be explained.
	//
	// Currently only one key is allowed.
	Outputs map[string]*ExplanationMetadata_OutputMetadata `` /* 155-byte string literal not displayed */
	// Points to a YAML file stored on Google Cloud Storage describing the format
	// of the [feature
	// attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
	// The schema is defined as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	// AutoML tabular Models always have this field populated by Vertex AI.
	// Note: The URI given on output may be different, including the URI scheme,
	// than the one given on input. The output URI will point to a location where
	// the user only has a read access.
	FeatureAttributionsSchemaUri string `` /* 149-byte string literal not displayed */
	// Name of the source to generate embeddings for example based explanations.
	LatentSpaceSource string `protobuf:"bytes,5,opt,name=latent_space_source,json=latentSpaceSource,proto3" json:"latent_space_source,omitempty"`
	// contains filtered or unexported fields
}

Metadata describing the Model's input and output for explanation.

func (*ExplanationMetadata) Descriptor deprecated

func (*ExplanationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ExplanationMetadata.ProtoReflect.Descriptor instead.

func (*ExplanationMetadata) GetFeatureAttributionsSchemaUri

func (x *ExplanationMetadata) GetFeatureAttributionsSchemaUri() string

func (*ExplanationMetadata) GetInputs

func (*ExplanationMetadata) GetLatentSpaceSource

func (x *ExplanationMetadata) GetLatentSpaceSource() string

func (*ExplanationMetadata) GetOutputs

func (*ExplanationMetadata) ProtoMessage

func (*ExplanationMetadata) ProtoMessage()

func (*ExplanationMetadata) ProtoReflect

func (x *ExplanationMetadata) ProtoReflect() protoreflect.Message

func (*ExplanationMetadata) Reset

func (x *ExplanationMetadata) Reset()

func (*ExplanationMetadata) String

func (x *ExplanationMetadata) String() string

type ExplanationMetadataOverride

type ExplanationMetadataOverride struct {

	// Required. Overrides the [input
	// metadata][google.cloud.aiplatform.v1.ExplanationMetadata.inputs] of the
	// features. The key is the name of the feature to be overridden. The keys
	// specified here must exist in the input metadata to be overridden. If a
	// feature is not specified here, the corresponding feature's input metadata
	// is not overridden.
	Inputs map[string]*ExplanationMetadataOverride_InputMetadataOverride `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

The ExplanationMetadata[google.cloud.aiplatform.v1.ExplanationMetadata] entries that can be overridden at [online explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.

func (*ExplanationMetadataOverride) Descriptor deprecated

func (*ExplanationMetadataOverride) Descriptor() ([]byte, []int)

Deprecated: Use ExplanationMetadataOverride.ProtoReflect.Descriptor instead.

func (*ExplanationMetadataOverride) GetInputs

func (*ExplanationMetadataOverride) ProtoMessage

func (*ExplanationMetadataOverride) ProtoMessage()

func (*ExplanationMetadataOverride) ProtoReflect

func (*ExplanationMetadataOverride) Reset

func (x *ExplanationMetadataOverride) Reset()

func (*ExplanationMetadataOverride) String

func (x *ExplanationMetadataOverride) String() string

type ExplanationMetadataOverride_InputMetadataOverride

type ExplanationMetadataOverride_InputMetadataOverride struct {

	// Baseline inputs for this feature.
	//
	// This overrides the `input_baseline` field of the
	// [ExplanationMetadata.InputMetadata][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata]
	// object of the corresponding feature's input metadata. If it's not
	// specified, the original baselines are not overridden.
	InputBaselines []*structpb.Value `protobuf:"bytes,1,rep,name=input_baselines,json=inputBaselines,proto3" json:"input_baselines,omitempty"`
	// contains filtered or unexported fields
}

The [input metadata][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata] entries to be overridden.

func (*ExplanationMetadataOverride_InputMetadataOverride) Descriptor deprecated

Deprecated: Use ExplanationMetadataOverride_InputMetadataOverride.ProtoReflect.Descriptor instead.

func (*ExplanationMetadataOverride_InputMetadataOverride) GetInputBaselines

func (*ExplanationMetadataOverride_InputMetadataOverride) ProtoMessage

func (*ExplanationMetadataOverride_InputMetadataOverride) ProtoReflect

func (*ExplanationMetadataOverride_InputMetadataOverride) Reset

func (*ExplanationMetadataOverride_InputMetadataOverride) String

type ExplanationMetadata_InputMetadata

type ExplanationMetadata_InputMetadata struct {

	// Baseline inputs for this feature.
	//
	// If no baseline is specified, Vertex AI chooses the baseline for this
	// feature. If multiple baselines are specified, Vertex AI returns the
	// average attributions across them in
	// [Attribution.feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
	//
	// For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape
	// of each baseline must match the shape of the input tensor. If a scalar is
	// provided, we broadcast to the same shape as the input tensor.
	//
	// For custom images, the element of the baselines must be in the same
	// format as the feature's input in the
	// [instance][google.cloud.aiplatform.v1.ExplainRequest.instances][]. The
	// schema of any single instance may be specified via Endpoint's
	// DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
	// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
	InputBaselines []*structpb.Value `protobuf:"bytes,1,rep,name=input_baselines,json=inputBaselines,proto3" json:"input_baselines,omitempty"`
	// Name of the input tensor for this feature. Required and is only
	// applicable to Vertex AI-provided images for Tensorflow.
	InputTensorName string `protobuf:"bytes,2,opt,name=input_tensor_name,json=inputTensorName,proto3" json:"input_tensor_name,omitempty"`
	// Defines how the feature is encoded into the input tensor. Defaults to
	// IDENTITY.
	Encoding ExplanationMetadata_InputMetadata_Encoding `` /* 145-byte string literal not displayed */
	// Modality of the feature. Valid values are: numeric, image. Defaults to
	// numeric.
	Modality string `protobuf:"bytes,4,opt,name=modality,proto3" json:"modality,omitempty"`
	// The domain details of the input feature value. Like min/max, original
	// mean or standard deviation if normalized.
	FeatureValueDomain *ExplanationMetadata_InputMetadata_FeatureValueDomain `protobuf:"bytes,5,opt,name=feature_value_domain,json=featureValueDomain,proto3" json:"feature_value_domain,omitempty"`
	// Specifies the index of the values of the input tensor.
	// Required when the input tensor is a sparse representation. Refer to
	// Tensorflow documentation for more details:
	// https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
	IndicesTensorName string `protobuf:"bytes,6,opt,name=indices_tensor_name,json=indicesTensorName,proto3" json:"indices_tensor_name,omitempty"`
	// Specifies the shape of the values of the input if the input is a sparse
	// representation. Refer to Tensorflow documentation for more details:
	// https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
	DenseShapeTensorName string `protobuf:"bytes,7,opt,name=dense_shape_tensor_name,json=denseShapeTensorName,proto3" json:"dense_shape_tensor_name,omitempty"`
	// A list of feature names for each index in the input tensor.
	// Required when the input
	// [InputMetadata.encoding][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoding]
	// is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
	IndexFeatureMapping []string `protobuf:"bytes,8,rep,name=index_feature_mapping,json=indexFeatureMapping,proto3" json:"index_feature_mapping,omitempty"`
	// Encoded tensor is a transformation of the input tensor. Must be provided
	// if choosing
	// [Integrated Gradients
	// attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution]
	// or [XRAI
	// attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution]
	// and the input tensor is not differentiable.
	//
	// An encoded tensor is generated if the input tensor is encoded by a lookup
	// table.
	EncodedTensorName string `protobuf:"bytes,9,opt,name=encoded_tensor_name,json=encodedTensorName,proto3" json:"encoded_tensor_name,omitempty"`
	// A list of baselines for the encoded tensor.
	//
	// The shape of each baseline should match the shape of the encoded tensor.
	// If a scalar is provided, Vertex AI broadcasts to the same shape as the
	// encoded tensor.
	EncodedBaselines []*structpb.Value `protobuf:"bytes,10,rep,name=encoded_baselines,json=encodedBaselines,proto3" json:"encoded_baselines,omitempty"`
	// Visualization configurations for image explanation.
	Visualization *ExplanationMetadata_InputMetadata_Visualization `protobuf:"bytes,11,opt,name=visualization,proto3" json:"visualization,omitempty"`
	// Name of the group that the input belongs to. Features with the same group
	// name will be treated as one feature when computing attributions. Features
	// grouped together can have different shapes in value. If provided, there
	// will be one single attribution generated in
	// [Attribution.feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions],
	// keyed by the group name.
	GroupName string `protobuf:"bytes,12,opt,name=group_name,json=groupName,proto3" json:"group_name,omitempty"`
	// contains filtered or unexported fields
}

Metadata of the input of a feature.

Fields other than [InputMetadata.input_baselines][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.input_baselines] are applicable only for Models that are using Vertex AI-provided images for Tensorflow.

func (*ExplanationMetadata_InputMetadata) Descriptor deprecated

func (*ExplanationMetadata_InputMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ExplanationMetadata_InputMetadata.ProtoReflect.Descriptor instead.

func (*ExplanationMetadata_InputMetadata) GetDenseShapeTensorName

func (x *ExplanationMetadata_InputMetadata) GetDenseShapeTensorName() string

func (*ExplanationMetadata_InputMetadata) GetEncodedBaselines

func (x *ExplanationMetadata_InputMetadata) GetEncodedBaselines() []*structpb.Value

func (*ExplanationMetadata_InputMetadata) GetEncodedTensorName

func (x *ExplanationMetadata_InputMetadata) GetEncodedTensorName() string

func (*ExplanationMetadata_InputMetadata) GetEncoding

func (*ExplanationMetadata_InputMetadata) GetFeatureValueDomain

func (*ExplanationMetadata_InputMetadata) GetGroupName

func (x *ExplanationMetadata_InputMetadata) GetGroupName() string

func (*ExplanationMetadata_InputMetadata) GetIndexFeatureMapping

func (x *ExplanationMetadata_InputMetadata) GetIndexFeatureMapping() []string

func (*ExplanationMetadata_InputMetadata) GetIndicesTensorName

func (x *ExplanationMetadata_InputMetadata) GetIndicesTensorName() string

func (*ExplanationMetadata_InputMetadata) GetInputBaselines

func (x *ExplanationMetadata_InputMetadata) GetInputBaselines() []*structpb.Value

func (*ExplanationMetadata_InputMetadata) GetInputTensorName

func (x *ExplanationMetadata_InputMetadata) GetInputTensorName() string

func (*ExplanationMetadata_InputMetadata) GetModality

func (x *ExplanationMetadata_InputMetadata) GetModality() string

func (*ExplanationMetadata_InputMetadata) GetVisualization

func (*ExplanationMetadata_InputMetadata) ProtoMessage

func (*ExplanationMetadata_InputMetadata) ProtoMessage()

func (*ExplanationMetadata_InputMetadata) ProtoReflect

func (*ExplanationMetadata_InputMetadata) Reset

func (*ExplanationMetadata_InputMetadata) String

type ExplanationMetadata_InputMetadata_Encoding

type ExplanationMetadata_InputMetadata_Encoding int32

Defines how a feature is encoded. Defaults to IDENTITY.

const (
	// Default value. This is the same as IDENTITY.
	ExplanationMetadata_InputMetadata_ENCODING_UNSPECIFIED ExplanationMetadata_InputMetadata_Encoding = 0
	// The tensor represents one feature.
	ExplanationMetadata_InputMetadata_IDENTITY ExplanationMetadata_InputMetadata_Encoding = 1
	// The tensor represents a bag of features where each index maps to
	// a feature.
	// [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping]
	// must be provided for this encoding. For example:
	// “`
	// input = [27, 6.0, 150]
	// index_feature_mapping = ["age", "height", "weight"]
	// “`
	ExplanationMetadata_InputMetadata_BAG_OF_FEATURES ExplanationMetadata_InputMetadata_Encoding = 2
	// The tensor represents a bag of features where each index maps to a
	// feature. Zero values in the tensor indicates feature being
	// non-existent.
	// [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping]
	// must be provided for this encoding. For example:
	// “`
	// input = [2, 0, 5, 0, 1]
	// index_feature_mapping = ["a", "b", "c", "d", "e"]
	// “`
	ExplanationMetadata_InputMetadata_BAG_OF_FEATURES_SPARSE ExplanationMetadata_InputMetadata_Encoding = 3
	// The tensor is a list of binaries representing whether a feature exists
	// or not (1 indicates existence).
	// [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping]
	// must be provided for this encoding. For example:
	// “`
	// input = [1, 0, 1, 0, 1]
	// index_feature_mapping = ["a", "b", "c", "d", "e"]
	// “`
	ExplanationMetadata_InputMetadata_INDICATOR ExplanationMetadata_InputMetadata_Encoding = 4
	// The tensor is encoded into a 1-dimensional array represented by an
	// encoded tensor.
	// [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoded_tensor_name]
	// must be provided for this encoding. For example:
	// “`
	// input = ["This", "is", "a", "test", "."]
	// encoded = [0.1, 0.2, 0.3, 0.4, 0.5]
	// “`
	ExplanationMetadata_InputMetadata_COMBINED_EMBEDDING ExplanationMetadata_InputMetadata_Encoding = 5
	// Select this encoding when the input tensor is encoded into a
	// 2-dimensional array represented by an encoded tensor.
	// [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoded_tensor_name]
	// must be provided for this encoding. The first dimension of the encoded
	// tensor's shape is the same as the input tensor's shape. For example:
	// “`
	// input = ["This", "is", "a", "test", "."]
	// encoded = [[0.1, 0.2, 0.3, 0.4, 0.5],
	//
	//	[0.2, 0.1, 0.4, 0.3, 0.5],
	//	[0.5, 0.1, 0.3, 0.5, 0.4],
	//	[0.5, 0.3, 0.1, 0.2, 0.4],
	//	[0.4, 0.3, 0.2, 0.5, 0.1]]
	//
	// “`
	ExplanationMetadata_InputMetadata_CONCAT_EMBEDDING ExplanationMetadata_InputMetadata_Encoding = 6
)

func (ExplanationMetadata_InputMetadata_Encoding) Descriptor

func (ExplanationMetadata_InputMetadata_Encoding) Enum

func (ExplanationMetadata_InputMetadata_Encoding) EnumDescriptor deprecated

func (ExplanationMetadata_InputMetadata_Encoding) EnumDescriptor() ([]byte, []int)

Deprecated: Use ExplanationMetadata_InputMetadata_Encoding.Descriptor instead.

func (ExplanationMetadata_InputMetadata_Encoding) Number

func (ExplanationMetadata_InputMetadata_Encoding) String

func (ExplanationMetadata_InputMetadata_Encoding) Type

type ExplanationMetadata_InputMetadata_FeatureValueDomain

type ExplanationMetadata_InputMetadata_FeatureValueDomain struct {

	// The minimum permissible value for this feature.
	MinValue float32 `protobuf:"fixed32,1,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
	// The maximum permissible value for this feature.
	MaxValue float32 `protobuf:"fixed32,2,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
	// If this input feature has been normalized to a mean value of 0,
	// the original_mean specifies the mean value of the domain prior to
	// normalization.
	OriginalMean float32 `protobuf:"fixed32,3,opt,name=original_mean,json=originalMean,proto3" json:"original_mean,omitempty"`
	// If this input feature has been normalized to a standard deviation of
	// 1.0, the original_stddev specifies the standard deviation of the domain
	// prior to normalization.
	OriginalStddev float32 `protobuf:"fixed32,4,opt,name=original_stddev,json=originalStddev,proto3" json:"original_stddev,omitempty"`
	// contains filtered or unexported fields
}

Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained.

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) Descriptor deprecated

Deprecated: Use ExplanationMetadata_InputMetadata_FeatureValueDomain.ProtoReflect.Descriptor instead.

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) GetMaxValue

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) GetMinValue

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) GetOriginalMean

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) GetOriginalStddev

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) ProtoMessage

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) ProtoReflect

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) Reset

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) String

type ExplanationMetadata_InputMetadata_Visualization

type ExplanationMetadata_InputMetadata_Visualization struct {

	// Type of the image visualization. Only applicable to
	// [Integrated Gradients
	// attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].
	// OUTLINES shows regions of attribution, while PIXELS shows per-pixel
	// attribution. Defaults to OUTLINES.
	Type ExplanationMetadata_InputMetadata_Visualization_Type `` /* 147-byte string literal not displayed */
	// Whether to only highlight pixels with positive contributions, negative
	// or both. Defaults to POSITIVE.
	Polarity ExplanationMetadata_InputMetadata_Visualization_Polarity `` /* 159-byte string literal not displayed */
	// The color scheme used for the highlighted areas.
	//
	// Defaults to PINK_GREEN for
	// [Integrated Gradients
	// attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution],
	// which shows positive attributions in green and negative in pink.
	//
	// Defaults to VIRIDIS for
	// [XRAI
	// attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
	// which highlights the most influential regions in yellow and the least
	// influential in blue.
	ColorMap ExplanationMetadata_InputMetadata_Visualization_ColorMap `` /* 175-byte string literal not displayed */
	// Excludes attributions above the specified percentile from the
	// highlighted areas. Using the clip_percent_upperbound and
	// clip_percent_lowerbound together can be useful for filtering out noise
	// and making it easier to see areas of strong attribution. Defaults to
	// 99.9.
	ClipPercentUpperbound float32 `` /* 128-byte string literal not displayed */
	// Excludes attributions below the specified percentile, from the
	// highlighted areas. Defaults to 62.
	ClipPercentLowerbound float32 `` /* 128-byte string literal not displayed */
	// How the original image is displayed in the visualization.
	// Adjusting the overlay can help increase visual clarity if the original
	// image makes it difficult to view the visualization. Defaults to NONE.
	OverlayType ExplanationMetadata_InputMetadata_Visualization_OverlayType `` /* 187-byte string literal not displayed */
	// contains filtered or unexported fields
}

Visualization configurations for image explanation.

func (*ExplanationMetadata_InputMetadata_Visualization) Descriptor deprecated

Deprecated: Use ExplanationMetadata_InputMetadata_Visualization.ProtoReflect.Descriptor instead.

func (*ExplanationMetadata_InputMetadata_Visualization) GetClipPercentLowerbound

func (x *ExplanationMetadata_InputMetadata_Visualization) GetClipPercentLowerbound() float32

func (*ExplanationMetadata_InputMetadata_Visualization) GetClipPercentUpperbound

func (x *ExplanationMetadata_InputMetadata_Visualization) GetClipPercentUpperbound() float32

func (*ExplanationMetadata_InputMetadata_Visualization) GetColorMap

func (*ExplanationMetadata_InputMetadata_Visualization) GetOverlayType

func (*ExplanationMetadata_InputMetadata_Visualization) GetPolarity

func (*ExplanationMetadata_InputMetadata_Visualization) GetType

func (*ExplanationMetadata_InputMetadata_Visualization) ProtoMessage

func (*ExplanationMetadata_InputMetadata_Visualization) ProtoReflect

func (*ExplanationMetadata_InputMetadata_Visualization) Reset

func (*ExplanationMetadata_InputMetadata_Visualization) String

type ExplanationMetadata_InputMetadata_Visualization_ColorMap

type ExplanationMetadata_InputMetadata_Visualization_ColorMap int32

The color scheme used for highlighting areas.

const (
	// Should not be used.
	ExplanationMetadata_InputMetadata_Visualization_COLOR_MAP_UNSPECIFIED ExplanationMetadata_InputMetadata_Visualization_ColorMap = 0
	// Positive: green. Negative: pink.
	ExplanationMetadata_InputMetadata_Visualization_PINK_GREEN ExplanationMetadata_InputMetadata_Visualization_ColorMap = 1
	// Viridis color map: A perceptually uniform color mapping which is
	// easier to see by those with colorblindness and progresses from yellow
	// to green to blue. Positive: yellow. Negative: blue.
	ExplanationMetadata_InputMetadata_Visualization_VIRIDIS ExplanationMetadata_InputMetadata_Visualization_ColorMap = 2
	// Positive: red. Negative: red.
	ExplanationMetadata_InputMetadata_Visualization_RED ExplanationMetadata_InputMetadata_Visualization_ColorMap = 3
	// Positive: green. Negative: green.
	ExplanationMetadata_InputMetadata_Visualization_GREEN ExplanationMetadata_InputMetadata_Visualization_ColorMap = 4
	// Positive: green. Negative: red.
	ExplanationMetadata_InputMetadata_Visualization_RED_GREEN ExplanationMetadata_InputMetadata_Visualization_ColorMap = 6
	// PiYG palette.
	ExplanationMetadata_InputMetadata_Visualization_PINK_WHITE_GREEN ExplanationMetadata_InputMetadata_Visualization_ColorMap = 5
)

func (ExplanationMetadata_InputMetadata_Visualization_ColorMap) Descriptor

func (ExplanationMetadata_InputMetadata_Visualization_ColorMap) Enum

func (ExplanationMetadata_InputMetadata_Visualization_ColorMap) EnumDescriptor deprecated

Deprecated: Use ExplanationMetadata_InputMetadata_Visualization_ColorMap.Descriptor instead.

func (ExplanationMetadata_InputMetadata_Visualization_ColorMap) Number

func (ExplanationMetadata_InputMetadata_Visualization_ColorMap) String

func (ExplanationMetadata_InputMetadata_Visualization_ColorMap) Type

type ExplanationMetadata_InputMetadata_Visualization_OverlayType

type ExplanationMetadata_InputMetadata_Visualization_OverlayType int32

How the original image is displayed in the visualization.

const (
	// Default value. This is the same as NONE.
	ExplanationMetadata_InputMetadata_Visualization_OVERLAY_TYPE_UNSPECIFIED ExplanationMetadata_InputMetadata_Visualization_OverlayType = 0
	// No overlay.
	ExplanationMetadata_InputMetadata_Visualization_NONE ExplanationMetadata_InputMetadata_Visualization_OverlayType = 1
	// The attributions are shown on top of the original image.
	ExplanationMetadata_InputMetadata_Visualization_ORIGINAL ExplanationMetadata_InputMetadata_Visualization_OverlayType = 2
	// The attributions are shown on top of grayscaled version of the
	// original image.
	ExplanationMetadata_InputMetadata_Visualization_GRAYSCALE ExplanationMetadata_InputMetadata_Visualization_OverlayType = 3
	// The attributions are used as a mask to reveal predictive parts of
	// the image and hide the un-predictive parts.
	ExplanationMetadata_InputMetadata_Visualization_MASK_BLACK ExplanationMetadata_InputMetadata_Visualization_OverlayType = 4
)

func (ExplanationMetadata_InputMetadata_Visualization_OverlayType) Descriptor

func (ExplanationMetadata_InputMetadata_Visualization_OverlayType) Enum

func (ExplanationMetadata_InputMetadata_Visualization_OverlayType) EnumDescriptor deprecated

Deprecated: Use ExplanationMetadata_InputMetadata_Visualization_OverlayType.Descriptor instead.

func (ExplanationMetadata_InputMetadata_Visualization_OverlayType) Number

func (ExplanationMetadata_InputMetadata_Visualization_OverlayType) String

func (ExplanationMetadata_InputMetadata_Visualization_OverlayType) Type

type ExplanationMetadata_InputMetadata_Visualization_Polarity

type ExplanationMetadata_InputMetadata_Visualization_Polarity int32

Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.

const (
	// Default value. This is the same as POSITIVE.
	ExplanationMetadata_InputMetadata_Visualization_POLARITY_UNSPECIFIED ExplanationMetadata_InputMetadata_Visualization_Polarity = 0
	// Highlights the pixels/outlines that were most influential to the
	// model's prediction.
	ExplanationMetadata_InputMetadata_Visualization_POSITIVE ExplanationMetadata_InputMetadata_Visualization_Polarity = 1
	// Setting polarity to negative highlights areas that does not lead to
	// the models's current prediction.
	ExplanationMetadata_InputMetadata_Visualization_NEGATIVE ExplanationMetadata_InputMetadata_Visualization_Polarity = 2
	// Shows both positive and negative attributions.
	ExplanationMetadata_InputMetadata_Visualization_BOTH ExplanationMetadata_InputMetadata_Visualization_Polarity = 3
)

func (ExplanationMetadata_InputMetadata_Visualization_Polarity) Descriptor

func (ExplanationMetadata_InputMetadata_Visualization_Polarity) Enum

func (ExplanationMetadata_InputMetadata_Visualization_Polarity) EnumDescriptor deprecated

Deprecated: Use ExplanationMetadata_InputMetadata_Visualization_Polarity.Descriptor instead.

func (ExplanationMetadata_InputMetadata_Visualization_Polarity) Number

func (ExplanationMetadata_InputMetadata_Visualization_Polarity) String

func (ExplanationMetadata_InputMetadata_Visualization_Polarity) Type

type ExplanationMetadata_InputMetadata_Visualization_Type

type ExplanationMetadata_InputMetadata_Visualization_Type int32

Type of the image visualization. Only applicable to [Integrated Gradients attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].

const (
	// Should not be used.
	ExplanationMetadata_InputMetadata_Visualization_TYPE_UNSPECIFIED ExplanationMetadata_InputMetadata_Visualization_Type = 0
	// Shows which pixel contributed to the image prediction.
	ExplanationMetadata_InputMetadata_Visualization_PIXELS ExplanationMetadata_InputMetadata_Visualization_Type = 1
	// Shows which region contributed to the image prediction by outlining
	// the region.
	ExplanationMetadata_InputMetadata_Visualization_OUTLINES ExplanationMetadata_InputMetadata_Visualization_Type = 2
)

func (ExplanationMetadata_InputMetadata_Visualization_Type) Descriptor

func (ExplanationMetadata_InputMetadata_Visualization_Type) Enum

func (ExplanationMetadata_InputMetadata_Visualization_Type) EnumDescriptor deprecated

Deprecated: Use ExplanationMetadata_InputMetadata_Visualization_Type.Descriptor instead.

func (ExplanationMetadata_InputMetadata_Visualization_Type) Number

func (ExplanationMetadata_InputMetadata_Visualization_Type) String

func (ExplanationMetadata_InputMetadata_Visualization_Type) Type

type ExplanationMetadata_OutputMetadata

type ExplanationMetadata_OutputMetadata struct {

	// Defines how to map
	// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
	// to
	// [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name].
	//
	// If neither of the fields are specified,
	// [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name]
	// will not be populated.
	//
	// Types that are assignable to DisplayNameMapping:
	//
	//	*ExplanationMetadata_OutputMetadata_IndexDisplayNameMapping
	//	*ExplanationMetadata_OutputMetadata_DisplayNameMappingKey
	DisplayNameMapping isExplanationMetadata_OutputMetadata_DisplayNameMapping `protobuf_oneof:"display_name_mapping"`
	// Name of the output tensor. Required and is only applicable to Vertex
	// AI provided images for Tensorflow.
	OutputTensorName string `protobuf:"bytes,3,opt,name=output_tensor_name,json=outputTensorName,proto3" json:"output_tensor_name,omitempty"`
	// contains filtered or unexported fields
}

Metadata of the prediction output to be explained.

func (*ExplanationMetadata_OutputMetadata) Descriptor deprecated

func (*ExplanationMetadata_OutputMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ExplanationMetadata_OutputMetadata.ProtoReflect.Descriptor instead.

func (*ExplanationMetadata_OutputMetadata) GetDisplayNameMapping

func (m *ExplanationMetadata_OutputMetadata) GetDisplayNameMapping() isExplanationMetadata_OutputMetadata_DisplayNameMapping

func (*ExplanationMetadata_OutputMetadata) GetDisplayNameMappingKey

func (x *ExplanationMetadata_OutputMetadata) GetDisplayNameMappingKey() string

func (*ExplanationMetadata_OutputMetadata) GetIndexDisplayNameMapping

func (x *ExplanationMetadata_OutputMetadata) GetIndexDisplayNameMapping() *structpb.Value

func (*ExplanationMetadata_OutputMetadata) GetOutputTensorName

func (x *ExplanationMetadata_OutputMetadata) GetOutputTensorName() string

func (*ExplanationMetadata_OutputMetadata) ProtoMessage

func (*ExplanationMetadata_OutputMetadata) ProtoMessage()

func (*ExplanationMetadata_OutputMetadata) ProtoReflect

func (*ExplanationMetadata_OutputMetadata) Reset

func (*ExplanationMetadata_OutputMetadata) String

type ExplanationMetadata_OutputMetadata_DisplayNameMappingKey

type ExplanationMetadata_OutputMetadata_DisplayNameMappingKey struct {
	// Specify a field name in the prediction to look for the display name.
	//
	// Use this if the prediction contains the display names for the outputs.
	//
	// The display names in the prediction must have the same shape of the
	// outputs, so that it can be located by
	// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
	// for a specific output.
	DisplayNameMappingKey string `protobuf:"bytes,2,opt,name=display_name_mapping_key,json=displayNameMappingKey,proto3,oneof"`
}

type ExplanationMetadata_OutputMetadata_IndexDisplayNameMapping

type ExplanationMetadata_OutputMetadata_IndexDisplayNameMapping struct {
	// Static mapping between the index and display name.
	//
	// Use this if the outputs are a deterministic n-dimensional array, e.g. a
	// list of scores of all the classes in a pre-defined order for a
	// multi-classification Model. It's not feasible if the outputs are
	// non-deterministic, e.g. the Model produces top-k classes or sort the
	// outputs by their values.
	//
	// The shape of the value must be an n-dimensional array of strings. The
	// number of dimensions must match that of the outputs to be explained.
	// The
	// [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name]
	// is populated by locating in the mapping with
	// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index].
	IndexDisplayNameMapping *structpb.Value `protobuf:"bytes,1,opt,name=index_display_name_mapping,json=indexDisplayNameMapping,proto3,oneof"`
}

type ExplanationParameters

type ExplanationParameters struct {

	// Types that are assignable to Method:
	//
	//	*ExplanationParameters_SampledShapleyAttribution
	//	*ExplanationParameters_IntegratedGradientsAttribution
	//	*ExplanationParameters_XraiAttribution
	//	*ExplanationParameters_Examples
	Method isExplanationParameters_Method `protobuf_oneof:"method"`
	// If populated, returns attributions for top K indices of outputs
	// (defaults to 1). Only applies to Models that predicts more than one outputs
	// (e,g, multi-class Models). When set to -1, returns explanations for all
	// outputs.
	TopK int32 `protobuf:"varint,4,opt,name=top_k,json=topK,proto3" json:"top_k,omitempty"`
	// If populated, only returns attributions that have
	// [output_index][google.cloud.aiplatform.v1.Attribution.output_index]
	// contained in output_indices. It must be an ndarray of integers, with the
	// same shape of the output it's explaining.
	//
	// If not populated, returns attributions for
	// [top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k] indices of
	// outputs. If neither top_k nor output_indices is populated, returns the
	// argmax index of the outputs.
	//
	// Only applicable to Models that predict multiple outputs (e,g, multi-class
	// Models that predict multiple classes).
	OutputIndices *structpb.ListValue `protobuf:"bytes,5,opt,name=output_indices,json=outputIndices,proto3" json:"output_indices,omitempty"`
	// contains filtered or unexported fields
}

Parameters to configure explaining for Model's predictions.

func (*ExplanationParameters) Descriptor deprecated

func (*ExplanationParameters) Descriptor() ([]byte, []int)

Deprecated: Use ExplanationParameters.ProtoReflect.Descriptor instead.

func (*ExplanationParameters) GetExamples added in v1.42.0

func (x *ExplanationParameters) GetExamples() *Examples

func (*ExplanationParameters) GetIntegratedGradientsAttribution

func (x *ExplanationParameters) GetIntegratedGradientsAttribution() *IntegratedGradientsAttribution

func (*ExplanationParameters) GetMethod

func (m *ExplanationParameters) GetMethod() isExplanationParameters_Method

func (*ExplanationParameters) GetOutputIndices

func (x *ExplanationParameters) GetOutputIndices() *structpb.ListValue

func (*ExplanationParameters) GetSampledShapleyAttribution

func (x *ExplanationParameters) GetSampledShapleyAttribution() *SampledShapleyAttribution

func (*ExplanationParameters) GetTopK

func (x *ExplanationParameters) GetTopK() int32

func (*ExplanationParameters) GetXraiAttribution

func (x *ExplanationParameters) GetXraiAttribution() *XraiAttribution

func (*ExplanationParameters) ProtoMessage

func (*ExplanationParameters) ProtoMessage()

func (*ExplanationParameters) ProtoReflect

func (x *ExplanationParameters) ProtoReflect() protoreflect.Message

func (*ExplanationParameters) Reset

func (x *ExplanationParameters) Reset()

func (*ExplanationParameters) String

func (x *ExplanationParameters) String() string

type ExplanationParameters_Examples added in v1.42.0

type ExplanationParameters_Examples struct {
	// Example-based explanations that returns the nearest neighbors from the
	// provided dataset.
	Examples *Examples `protobuf:"bytes,7,opt,name=examples,proto3,oneof"`
}

type ExplanationParameters_IntegratedGradientsAttribution

type ExplanationParameters_IntegratedGradientsAttribution struct {
	// An attribution method that computes Aumann-Shapley values taking
	// advantage of the model's fully differentiable structure. Refer to this
	// paper for more details: https://arxiv.org/abs/1703.01365
	IntegratedGradientsAttribution *IntegratedGradientsAttribution `protobuf:"bytes,2,opt,name=integrated_gradients_attribution,json=integratedGradientsAttribution,proto3,oneof"`
}

type ExplanationParameters_SampledShapleyAttribution

type ExplanationParameters_SampledShapleyAttribution struct {
	// An attribution method that approximates Shapley values for features that
	// contribute to the label being predicted. A sampling strategy is used to
	// approximate the value rather than considering all subsets of features.
	// Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
	SampledShapleyAttribution *SampledShapleyAttribution `protobuf:"bytes,1,opt,name=sampled_shapley_attribution,json=sampledShapleyAttribution,proto3,oneof"`
}

type ExplanationParameters_XraiAttribution

type ExplanationParameters_XraiAttribution struct {
	// An attribution method that redistributes Integrated Gradients
	// attribution to segmented regions, taking advantage of the model's fully
	// differentiable structure. Refer to this paper for
	// more details: https://arxiv.org/abs/1906.02825
	//
	// XRAI currently performs better on natural images, like a picture of a
	// house or an animal. If the images are taken in artificial environments,
	// like a lab or manufacturing line, or from diagnostic equipment, like
	// x-rays or quality-control cameras, use Integrated Gradients instead.
	XraiAttribution *XraiAttribution `protobuf:"bytes,3,opt,name=xrai_attribution,json=xraiAttribution,proto3,oneof"`
}

type ExplanationSpec

type ExplanationSpec struct {

	// Required. Parameters that configure explaining of the Model's predictions.
	Parameters *ExplanationParameters `protobuf:"bytes,1,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// Optional. Metadata describing the Model's input and output for explanation.
	Metadata *ExplanationMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

Specification of Model explanation.

func (*ExplanationSpec) Descriptor deprecated

func (*ExplanationSpec) Descriptor() ([]byte, []int)

Deprecated: Use ExplanationSpec.ProtoReflect.Descriptor instead.

func (*ExplanationSpec) GetMetadata

func (x *ExplanationSpec) GetMetadata() *ExplanationMetadata

func (*ExplanationSpec) GetParameters

func (x *ExplanationSpec) GetParameters() *ExplanationParameters

func (*ExplanationSpec) ProtoMessage

func (*ExplanationSpec) ProtoMessage()

func (*ExplanationSpec) ProtoReflect

func (x *ExplanationSpec) ProtoReflect() protoreflect.Message

func (*ExplanationSpec) Reset

func (x *ExplanationSpec) Reset()

func (*ExplanationSpec) String

func (x *ExplanationSpec) String() string

type ExplanationSpecOverride

type ExplanationSpecOverride struct {

	// The parameters to be overridden. Note that the
	// attribution method cannot be changed. If not specified,
	// no parameter is overridden.
	Parameters *ExplanationParameters `protobuf:"bytes,1,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// The metadata to be overridden. If not specified, no metadata is overridden.
	Metadata *ExplanationMetadataOverride `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// The example-based explanations parameter overrides.
	ExamplesOverride *ExamplesOverride `protobuf:"bytes,3,opt,name=examples_override,json=examplesOverride,proto3" json:"examples_override,omitempty"`
	// contains filtered or unexported fields
}

The ExplanationSpec[google.cloud.aiplatform.v1.ExplanationSpec] entries that can be overridden at [online explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.

func (*ExplanationSpecOverride) Descriptor deprecated

func (*ExplanationSpecOverride) Descriptor() ([]byte, []int)

Deprecated: Use ExplanationSpecOverride.ProtoReflect.Descriptor instead.

func (*ExplanationSpecOverride) GetExamplesOverride

func (x *ExplanationSpecOverride) GetExamplesOverride() *ExamplesOverride

func (*ExplanationSpecOverride) GetMetadata

func (*ExplanationSpecOverride) GetParameters

func (x *ExplanationSpecOverride) GetParameters() *ExplanationParameters

func (*ExplanationSpecOverride) ProtoMessage

func (*ExplanationSpecOverride) ProtoMessage()

func (*ExplanationSpecOverride) ProtoReflect

func (x *ExplanationSpecOverride) ProtoReflect() protoreflect.Message

func (*ExplanationSpecOverride) Reset

func (x *ExplanationSpecOverride) Reset()

func (*ExplanationSpecOverride) String

func (x *ExplanationSpecOverride) String() string

type ExportDataConfig

type ExportDataConfig struct {

	// The destination of the output.
	//
	// Types that are assignable to Destination:
	//
	//	*ExportDataConfig_GcsDestination
	Destination isExportDataConfig_Destination `protobuf_oneof:"destination"`
	// The instructions how the export data should be split between the
	// training, validation and test sets.
	//
	// Types that are assignable to Split:
	//
	//	*ExportDataConfig_FractionSplit
	//	*ExportDataConfig_FilterSplit
	Split isExportDataConfig_Split `protobuf_oneof:"split"`
	// An expression for filtering what part of the Dataset is to be exported.
	// Only Annotations that match this filter will be exported. The filter syntax
	// is the same as in
	// [ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].
	AnnotationsFilter string `protobuf:"bytes,2,opt,name=annotations_filter,json=annotationsFilter,proto3" json:"annotations_filter,omitempty"`
	// The ID of a SavedQuery (annotation set) under the Dataset specified by
	// [dataset_id][] used for filtering Annotations for training.
	//
	// Only used for custom training data export use cases.
	// Only applicable to Datasets that have SavedQueries.
	//
	// Only Annotations that are associated with this SavedQuery are used in
	// respectively training. When used in conjunction with
	// [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter],
	// the Annotations used for training are filtered by both
	// [saved_query_id][google.cloud.aiplatform.v1.ExportDataConfig.saved_query_id]
	// and
	// [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter].
	//
	// Only one of
	// [saved_query_id][google.cloud.aiplatform.v1.ExportDataConfig.saved_query_id]
	// and
	// [annotation_schema_uri][google.cloud.aiplatform.v1.ExportDataConfig.annotation_schema_uri]
	// should be specified as both of them represent the same thing: problem type.
	SavedQueryId string `protobuf:"bytes,11,opt,name=saved_query_id,json=savedQueryId,proto3" json:"saved_query_id,omitempty"`
	// The Cloud Storage URI that points to a YAML file describing the annotation
	// schema. The schema is defined as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	// The schema files that can be used here are found in
	// gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the
	// chosen schema must be consistent with
	// [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] of the
	// Dataset specified by [dataset_id][].
	//
	// Only used for custom training data export use cases.
	// Only applicable to Datasets that have DataItems and Annotations.
	//
	// Only Annotations that both match this schema and belong to DataItems not
	// ignored by the split method are used in respectively training, validation
	// or test role, depending on the role of the DataItem they are on.
	//
	// When used in conjunction with
	// [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter],
	// the Annotations used for training are filtered by both
	// [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter]
	// and
	// [annotation_schema_uri][google.cloud.aiplatform.v1.ExportDataConfig.annotation_schema_uri].
	AnnotationSchemaUri string `protobuf:"bytes,12,opt,name=annotation_schema_uri,json=annotationSchemaUri,proto3" json:"annotation_schema_uri,omitempty"`
	// Indicates the usage of the exported files.
	ExportUse ExportDataConfig_ExportUse `` /* 148-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes what part of the Dataset is to be exported, the destination of the export and how to export.

func (*ExportDataConfig) Descriptor deprecated

func (*ExportDataConfig) Descriptor() ([]byte, []int)

Deprecated: Use ExportDataConfig.ProtoReflect.Descriptor instead.

func (*ExportDataConfig) GetAnnotationSchemaUri added in v1.56.0

func (x *ExportDataConfig) GetAnnotationSchemaUri() string

func (*ExportDataConfig) GetAnnotationsFilter

func (x *ExportDataConfig) GetAnnotationsFilter() string

func (*ExportDataConfig) GetDestination

func (m *ExportDataConfig) GetDestination() isExportDataConfig_Destination

func (*ExportDataConfig) GetExportUse added in v1.56.0

func (x *ExportDataConfig) GetExportUse() ExportDataConfig_ExportUse

func (*ExportDataConfig) GetFilterSplit added in v1.56.0

func (x *ExportDataConfig) GetFilterSplit() *ExportFilterSplit

func (*ExportDataConfig) GetFractionSplit added in v1.36.0

func (x *ExportDataConfig) GetFractionSplit() *ExportFractionSplit

func (*ExportDataConfig) GetGcsDestination

func (x *ExportDataConfig) GetGcsDestination() *GcsDestination

func (*ExportDataConfig) GetSavedQueryId added in v1.56.0

func (x *ExportDataConfig) GetSavedQueryId() string

func (*ExportDataConfig) GetSplit added in v1.36.0

func (m *ExportDataConfig) GetSplit() isExportDataConfig_Split

func (*ExportDataConfig) ProtoMessage

func (*ExportDataConfig) ProtoMessage()

func (*ExportDataConfig) ProtoReflect

func (x *ExportDataConfig) ProtoReflect() protoreflect.Message

func (*ExportDataConfig) Reset

func (x *ExportDataConfig) Reset()

func (*ExportDataConfig) String

func (x *ExportDataConfig) String() string

type ExportDataConfig_ExportUse added in v1.56.0

type ExportDataConfig_ExportUse int32

ExportUse indicates the usage of the exported files. It restricts file destination, format, annotations to be exported, whether to allow unannotated data to be exported and whether to clone files to temp Cloud Storage bucket.

const (
	// Regular user export.
	ExportDataConfig_EXPORT_USE_UNSPECIFIED ExportDataConfig_ExportUse = 0
	// Export for custom code training.
	ExportDataConfig_CUSTOM_CODE_TRAINING ExportDataConfig_ExportUse = 6
)

func (ExportDataConfig_ExportUse) Descriptor added in v1.56.0

func (ExportDataConfig_ExportUse) Enum added in v1.56.0

func (ExportDataConfig_ExportUse) EnumDescriptor deprecated added in v1.56.0

func (ExportDataConfig_ExportUse) EnumDescriptor() ([]byte, []int)

Deprecated: Use ExportDataConfig_ExportUse.Descriptor instead.

func (ExportDataConfig_ExportUse) Number added in v1.56.0

func (ExportDataConfig_ExportUse) String added in v1.56.0

func (ExportDataConfig_ExportUse) Type added in v1.56.0

type ExportDataConfig_FilterSplit added in v1.56.0

type ExportDataConfig_FilterSplit struct {
	// Split based on the provided filters for each set.
	FilterSplit *ExportFilterSplit `protobuf:"bytes,7,opt,name=filter_split,json=filterSplit,proto3,oneof"`
}

type ExportDataConfig_FractionSplit added in v1.36.0

type ExportDataConfig_FractionSplit struct {
	// Split based on fractions defining the size of each set.
	FractionSplit *ExportFractionSplit `protobuf:"bytes,5,opt,name=fraction_split,json=fractionSplit,proto3,oneof"`
}

type ExportDataConfig_GcsDestination

type ExportDataConfig_GcsDestination struct {
	// The Google Cloud Storage location where the output is to be written to.
	// In the given directory a new directory will be created with name:
	// `export-data-<dataset-display-name>-<timestamp-of-export-call>` where
	// timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export
	// output will be written into that directory. Inside that directory,
	// annotations with the same schema will be grouped into sub directories
	// which are named with the corresponding annotations' schema title. Inside
	// these sub directories, a schema.yaml will be created to describe the
	// output format.
	GcsDestination *GcsDestination `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3,oneof"`
}

type ExportDataOperationMetadata

type ExportDataOperationMetadata struct {

	// The common part of the operation metadata.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// A Google Cloud Storage directory which path ends with '/'. The exported
	// data is stored in the directory.
	GcsOutputDirectory string `protobuf:"bytes,2,opt,name=gcs_output_directory,json=gcsOutputDirectory,proto3" json:"gcs_output_directory,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData].

func (*ExportDataOperationMetadata) Descriptor deprecated

func (*ExportDataOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ExportDataOperationMetadata.ProtoReflect.Descriptor instead.

func (*ExportDataOperationMetadata) GetGcsOutputDirectory

func (x *ExportDataOperationMetadata) GetGcsOutputDirectory() string

func (*ExportDataOperationMetadata) GetGenericMetadata

func (x *ExportDataOperationMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*ExportDataOperationMetadata) ProtoMessage

func (*ExportDataOperationMetadata) ProtoMessage()

func (*ExportDataOperationMetadata) ProtoReflect

func (*ExportDataOperationMetadata) Reset

func (x *ExportDataOperationMetadata) Reset()

func (*ExportDataOperationMetadata) String

func (x *ExportDataOperationMetadata) String() string

type ExportDataRequest

type ExportDataRequest struct {

	// Required. The name of the Dataset resource.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The desired output location.
	ExportConfig *ExportDataConfig `protobuf:"bytes,2,opt,name=export_config,json=exportConfig,proto3" json:"export_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData].

func (*ExportDataRequest) Descriptor deprecated

func (*ExportDataRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExportDataRequest.ProtoReflect.Descriptor instead.

func (*ExportDataRequest) GetExportConfig

func (x *ExportDataRequest) GetExportConfig() *ExportDataConfig

func (*ExportDataRequest) GetName

func (x *ExportDataRequest) GetName() string

func (*ExportDataRequest) ProtoMessage

func (*ExportDataRequest) ProtoMessage()

func (*ExportDataRequest) ProtoReflect

func (x *ExportDataRequest) ProtoReflect() protoreflect.Message

func (*ExportDataRequest) Reset

func (x *ExportDataRequest) Reset()

func (*ExportDataRequest) String

func (x *ExportDataRequest) String() string

type ExportDataResponse

type ExportDataResponse struct {

	// All of the files that are exported in this export operation. For custom
	// code training export, only three (training, validation and test)
	// Cloud Storage paths in wildcard format are populated
	// (for example, gs://.../training-*).
	ExportedFiles []string `protobuf:"bytes,1,rep,name=exported_files,json=exportedFiles,proto3" json:"exported_files,omitempty"`
	// Only present for custom code training export use case. Records data stats,
	// i.e., train/validation/test item/annotation counts calculated during
	// the export operation.
	DataStats *Model_DataStats `protobuf:"bytes,2,opt,name=data_stats,json=dataStats,proto3" json:"data_stats,omitempty"`
	// contains filtered or unexported fields
}

Response message for [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData].

func (*ExportDataResponse) Descriptor deprecated

func (*ExportDataResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportDataResponse.ProtoReflect.Descriptor instead.

func (*ExportDataResponse) GetDataStats added in v1.56.0

func (x *ExportDataResponse) GetDataStats() *Model_DataStats

func (*ExportDataResponse) GetExportedFiles

func (x *ExportDataResponse) GetExportedFiles() []string

func (*ExportDataResponse) ProtoMessage

func (*ExportDataResponse) ProtoMessage()

func (*ExportDataResponse) ProtoReflect

func (x *ExportDataResponse) ProtoReflect() protoreflect.Message

func (*ExportDataResponse) Reset

func (x *ExportDataResponse) Reset()

func (*ExportDataResponse) String

func (x *ExportDataResponse) String() string

type ExportFeatureValuesOperationMetadata

type ExportFeatureValuesOperationMetadata struct {

	// Operation metadata for Featurestore export Feature values.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that exports Features values.

func (*ExportFeatureValuesOperationMetadata) Descriptor deprecated

func (*ExportFeatureValuesOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ExportFeatureValuesOperationMetadata.ProtoReflect.Descriptor instead.

func (*ExportFeatureValuesOperationMetadata) GetGenericMetadata

func (*ExportFeatureValuesOperationMetadata) ProtoMessage

func (*ExportFeatureValuesOperationMetadata) ProtoMessage()

func (*ExportFeatureValuesOperationMetadata) ProtoReflect

func (*ExportFeatureValuesOperationMetadata) Reset

func (*ExportFeatureValuesOperationMetadata) String

type ExportFeatureValuesRequest

type ExportFeatureValuesRequest struct {

	// Required. The mode in which Feature values are exported.
	//
	// Types that are assignable to Mode:
	//
	//	*ExportFeatureValuesRequest_SnapshotExport_
	//	*ExportFeatureValuesRequest_FullExport_
	Mode isExportFeatureValuesRequest_Mode `protobuf_oneof:"mode"`
	// Required. The resource name of the EntityType from which to export Feature
	// values. Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
	EntityType string `protobuf:"bytes,1,opt,name=entity_type,json=entityType,proto3" json:"entity_type,omitempty"`
	// Required. Specifies destination location and format.
	Destination *FeatureValueDestination `protobuf:"bytes,4,opt,name=destination,proto3" json:"destination,omitempty"`
	// Required. Selects Features to export values of.
	FeatureSelector *FeatureSelector `protobuf:"bytes,5,opt,name=feature_selector,json=featureSelector,proto3" json:"feature_selector,omitempty"`
	// Per-Feature export settings.
	Settings []*DestinationFeatureSetting `protobuf:"bytes,6,rep,name=settings,proto3" json:"settings,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues].

func (*ExportFeatureValuesRequest) Descriptor deprecated

func (*ExportFeatureValuesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExportFeatureValuesRequest.ProtoReflect.Descriptor instead.

func (*ExportFeatureValuesRequest) GetDestination

func (*ExportFeatureValuesRequest) GetEntityType

func (x *ExportFeatureValuesRequest) GetEntityType() string

func (*ExportFeatureValuesRequest) GetFeatureSelector

func (x *ExportFeatureValuesRequest) GetFeatureSelector() *FeatureSelector

func (*ExportFeatureValuesRequest) GetFullExport

func (*ExportFeatureValuesRequest) GetMode

func (m *ExportFeatureValuesRequest) GetMode() isExportFeatureValuesRequest_Mode

func (*ExportFeatureValuesRequest) GetSettings

func (*ExportFeatureValuesRequest) GetSnapshotExport

func (*ExportFeatureValuesRequest) ProtoMessage

func (*ExportFeatureValuesRequest) ProtoMessage()

func (*ExportFeatureValuesRequest) ProtoReflect

func (*ExportFeatureValuesRequest) Reset

func (x *ExportFeatureValuesRequest) Reset()

func (*ExportFeatureValuesRequest) String

func (x *ExportFeatureValuesRequest) String() string

type ExportFeatureValuesRequest_FullExport

type ExportFeatureValuesRequest_FullExport struct {

	// Excludes Feature values with feature generation timestamp before this
	// timestamp. If not set, retrieve oldest values kept in Feature Store.
	// Timestamp, if present, must not have higher than millisecond precision.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Exports Feature values as of this timestamp. If not set,
	// retrieve values as of now. Timestamp, if present, must not have higher
	// than millisecond precision.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Describes exporting all historical Feature values of all entities of the EntityType between [start_time, end_time].

func (*ExportFeatureValuesRequest_FullExport) Descriptor deprecated

func (*ExportFeatureValuesRequest_FullExport) Descriptor() ([]byte, []int)

Deprecated: Use ExportFeatureValuesRequest_FullExport.ProtoReflect.Descriptor instead.

func (*ExportFeatureValuesRequest_FullExport) GetEndTime

func (*ExportFeatureValuesRequest_FullExport) GetStartTime

func (*ExportFeatureValuesRequest_FullExport) ProtoMessage

func (*ExportFeatureValuesRequest_FullExport) ProtoMessage()

func (*ExportFeatureValuesRequest_FullExport) ProtoReflect

func (*ExportFeatureValuesRequest_FullExport) Reset

func (*ExportFeatureValuesRequest_FullExport) String

type ExportFeatureValuesRequest_FullExport_

type ExportFeatureValuesRequest_FullExport_ struct {
	// Exports all historical values of all entities of the EntityType within a
	// time range
	FullExport *ExportFeatureValuesRequest_FullExport `protobuf:"bytes,7,opt,name=full_export,json=fullExport,proto3,oneof"`
}

type ExportFeatureValuesRequest_SnapshotExport

type ExportFeatureValuesRequest_SnapshotExport struct {

	// Exports Feature values as of this timestamp. If not set,
	// retrieve values as of now. Timestamp, if present, must not have higher
	// than millisecond precision.
	SnapshotTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=snapshot_time,json=snapshotTime,proto3" json:"snapshot_time,omitempty"`
	// Excludes Feature values with feature generation timestamp before this
	// timestamp. If not set, retrieve oldest values kept in Feature Store.
	// Timestamp, if present, must not have higher than millisecond precision.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// contains filtered or unexported fields
}

Describes exporting the latest Feature values of all entities of the EntityType between [start_time, snapshot_time].

func (*ExportFeatureValuesRequest_SnapshotExport) Descriptor deprecated

func (*ExportFeatureValuesRequest_SnapshotExport) Descriptor() ([]byte, []int)

Deprecated: Use ExportFeatureValuesRequest_SnapshotExport.ProtoReflect.Descriptor instead.

func (*ExportFeatureValuesRequest_SnapshotExport) GetSnapshotTime

func (*ExportFeatureValuesRequest_SnapshotExport) GetStartTime

func (*ExportFeatureValuesRequest_SnapshotExport) ProtoMessage

func (*ExportFeatureValuesRequest_SnapshotExport) ProtoReflect

func (*ExportFeatureValuesRequest_SnapshotExport) Reset

func (*ExportFeatureValuesRequest_SnapshotExport) String

type ExportFeatureValuesRequest_SnapshotExport_

type ExportFeatureValuesRequest_SnapshotExport_ struct {
	// Exports the latest Feature values of all entities of the EntityType
	// within a time range.
	SnapshotExport *ExportFeatureValuesRequest_SnapshotExport `protobuf:"bytes,3,opt,name=snapshot_export,json=snapshotExport,proto3,oneof"`
}

type ExportFeatureValuesResponse

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

Response message for [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues].

func (*ExportFeatureValuesResponse) Descriptor deprecated

func (*ExportFeatureValuesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportFeatureValuesResponse.ProtoReflect.Descriptor instead.

func (*ExportFeatureValuesResponse) ProtoMessage

func (*ExportFeatureValuesResponse) ProtoMessage()

func (*ExportFeatureValuesResponse) ProtoReflect

func (*ExportFeatureValuesResponse) Reset

func (x *ExportFeatureValuesResponse) Reset()

func (*ExportFeatureValuesResponse) String

func (x *ExportFeatureValuesResponse) String() string

type ExportFilterSplit added in v1.56.0

type ExportFilterSplit struct {

	// Required. A filter on DataItems of the Dataset. DataItems that match
	// this filter are used to train the Model. A filter with same syntax
	// as the one used in
	// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
	// may be used. If a single DataItem is matched by more than one of the
	// FilterSplit filters, then it is assigned to the first set that applies to
	// it in the training, validation, test order.
	TrainingFilter string `protobuf:"bytes,1,opt,name=training_filter,json=trainingFilter,proto3" json:"training_filter,omitempty"`
	// Required. A filter on DataItems of the Dataset. DataItems that match
	// this filter are used to validate the Model. A filter with same syntax
	// as the one used in
	// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
	// may be used. If a single DataItem is matched by more than one of the
	// FilterSplit filters, then it is assigned to the first set that applies to
	// it in the training, validation, test order.
	ValidationFilter string `protobuf:"bytes,2,opt,name=validation_filter,json=validationFilter,proto3" json:"validation_filter,omitempty"`
	// Required. A filter on DataItems of the Dataset. DataItems that match
	// this filter are used to test the Model. A filter with same syntax
	// as the one used in
	// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
	// may be used. If a single DataItem is matched by more than one of the
	// FilterSplit filters, then it is assigned to the first set that applies to
	// it in the training, validation, test order.
	TestFilter string `protobuf:"bytes,3,opt,name=test_filter,json=testFilter,proto3" json:"test_filter,omitempty"`
	// contains filtered or unexported fields
}

Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as '-' (the minus sign).

Supported only for unstructured Datasets.

func (*ExportFilterSplit) Descriptor deprecated added in v1.56.0

func (*ExportFilterSplit) Descriptor() ([]byte, []int)

Deprecated: Use ExportFilterSplit.ProtoReflect.Descriptor instead.

func (*ExportFilterSplit) GetTestFilter added in v1.56.0

func (x *ExportFilterSplit) GetTestFilter() string

func (*ExportFilterSplit) GetTrainingFilter added in v1.56.0

func (x *ExportFilterSplit) GetTrainingFilter() string

func (*ExportFilterSplit) GetValidationFilter added in v1.56.0

func (x *ExportFilterSplit) GetValidationFilter() string

func (*ExportFilterSplit) ProtoMessage added in v1.56.0

func (*ExportFilterSplit) ProtoMessage()

func (*ExportFilterSplit) ProtoReflect added in v1.56.0

func (x *ExportFilterSplit) ProtoReflect() protoreflect.Message

func (*ExportFilterSplit) Reset added in v1.56.0

func (x *ExportFilterSplit) Reset()

func (*ExportFilterSplit) String added in v1.56.0

func (x *ExportFilterSplit) String() string

type ExportFractionSplit added in v1.36.0

type ExportFractionSplit struct {

	// The fraction of the input data that is to be used to train the Model.
	TrainingFraction float64 `protobuf:"fixed64,1,opt,name=training_fraction,json=trainingFraction,proto3" json:"training_fraction,omitempty"`
	// The fraction of the input data that is to be used to validate the Model.
	ValidationFraction float64 `protobuf:"fixed64,2,opt,name=validation_fraction,json=validationFraction,proto3" json:"validation_fraction,omitempty"`
	// The fraction of the input data that is to be used to evaluate the Model.
	TestFraction float64 `protobuf:"fixed64,3,opt,name=test_fraction,json=testFraction,proto3" json:"test_fraction,omitempty"`
	// contains filtered or unexported fields
}

Assigns the input data to training, validation, and test sets as per the given fractions. Any of `training_fraction`, `validation_fraction` and `test_fraction` may optionally be provided, they must sum to up to 1. If the provided ones sum to less than 1, the remainder is assigned to sets as decided by Vertex AI. If none of the fractions are set, by default roughly 80% of data is used for training, 10% for validation, and 10% for test.

func (*ExportFractionSplit) Descriptor deprecated added in v1.36.0

func (*ExportFractionSplit) Descriptor() ([]byte, []int)

Deprecated: Use ExportFractionSplit.ProtoReflect.Descriptor instead.

func (*ExportFractionSplit) GetTestFraction added in v1.36.0

func (x *ExportFractionSplit) GetTestFraction() float64

func (*ExportFractionSplit) GetTrainingFraction added in v1.36.0

func (x *ExportFractionSplit) GetTrainingFraction() float64

func (*ExportFractionSplit) GetValidationFraction added in v1.36.0

func (x *ExportFractionSplit) GetValidationFraction() float64

func (*ExportFractionSplit) ProtoMessage added in v1.36.0

func (*ExportFractionSplit) ProtoMessage()

func (*ExportFractionSplit) ProtoReflect added in v1.36.0

func (x *ExportFractionSplit) ProtoReflect() protoreflect.Message

func (*ExportFractionSplit) Reset added in v1.36.0

func (x *ExportFractionSplit) Reset()

func (*ExportFractionSplit) String added in v1.36.0

func (x *ExportFractionSplit) String() string

type ExportModelOperationMetadata

type ExportModelOperationMetadata struct {

	// The common part of the operation metadata.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// Output only. Information further describing the output of this Model
	// export.
	OutputInfo *ExportModelOperationMetadata_OutputInfo `protobuf:"bytes,2,opt,name=output_info,json=outputInfo,proto3" json:"output_info,omitempty"`
	// contains filtered or unexported fields
}

Details of [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel] operation.

func (*ExportModelOperationMetadata) Descriptor deprecated

func (*ExportModelOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ExportModelOperationMetadata.ProtoReflect.Descriptor instead.

func (*ExportModelOperationMetadata) GetGenericMetadata

func (x *ExportModelOperationMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*ExportModelOperationMetadata) GetOutputInfo

func (*ExportModelOperationMetadata) ProtoMessage

func (*ExportModelOperationMetadata) ProtoMessage()

func (*ExportModelOperationMetadata) ProtoReflect

func (*ExportModelOperationMetadata) Reset

func (x *ExportModelOperationMetadata) Reset()

func (*ExportModelOperationMetadata) String

type ExportModelOperationMetadata_OutputInfo

type ExportModelOperationMetadata_OutputInfo struct {

	// Output only. If the Model artifact is being exported to Google Cloud
	// Storage this is the full path of the directory created, into which the
	// Model files are being written to.
	ArtifactOutputUri string `protobuf:"bytes,2,opt,name=artifact_output_uri,json=artifactOutputUri,proto3" json:"artifact_output_uri,omitempty"`
	// Output only. If the Model image is being exported to Google Container
	// Registry or Artifact Registry this is the full path of the image created.
	ImageOutputUri string `protobuf:"bytes,3,opt,name=image_output_uri,json=imageOutputUri,proto3" json:"image_output_uri,omitempty"`
	// contains filtered or unexported fields
}

Further describes the output of the ExportModel. Supplements [ExportModelRequest.OutputConfig][google.cloud.aiplatform.v1.ExportModelRequest.OutputConfig].

func (*ExportModelOperationMetadata_OutputInfo) Descriptor deprecated

func (*ExportModelOperationMetadata_OutputInfo) Descriptor() ([]byte, []int)

Deprecated: Use ExportModelOperationMetadata_OutputInfo.ProtoReflect.Descriptor instead.

func (*ExportModelOperationMetadata_OutputInfo) GetArtifactOutputUri

func (x *ExportModelOperationMetadata_OutputInfo) GetArtifactOutputUri() string

func (*ExportModelOperationMetadata_OutputInfo) GetImageOutputUri

func (x *ExportModelOperationMetadata_OutputInfo) GetImageOutputUri() string

func (*ExportModelOperationMetadata_OutputInfo) ProtoMessage

func (*ExportModelOperationMetadata_OutputInfo) ProtoReflect

func (*ExportModelOperationMetadata_OutputInfo) Reset

func (*ExportModelOperationMetadata_OutputInfo) String

type ExportModelRequest

type ExportModelRequest struct {

	// Required. The resource name of the Model to export.
	// The resource name may contain version id or version alias to specify the
	// version, if no version is specified, the default version will be exported.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The desired output location and configuration.
	OutputConfig *ExportModelRequest_OutputConfig `protobuf:"bytes,2,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel].

func (*ExportModelRequest) Descriptor deprecated

func (*ExportModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExportModelRequest.ProtoReflect.Descriptor instead.

func (*ExportModelRequest) GetName

func (x *ExportModelRequest) GetName() string

func (*ExportModelRequest) GetOutputConfig

func (*ExportModelRequest) ProtoMessage

func (*ExportModelRequest) ProtoMessage()

func (*ExportModelRequest) ProtoReflect

func (x *ExportModelRequest) ProtoReflect() protoreflect.Message

func (*ExportModelRequest) Reset

func (x *ExportModelRequest) Reset()

func (*ExportModelRequest) String

func (x *ExportModelRequest) String() string

type ExportModelRequest_OutputConfig

type ExportModelRequest_OutputConfig struct {

	// The ID of the format in which the Model must be exported. Each Model
	// lists the [export formats it
	// supports][google.cloud.aiplatform.v1.Model.supported_export_formats]. If
	// no value is provided here, then the first from the list of the Model's
	// supported formats is used by default.
	ExportFormatId string `protobuf:"bytes,1,opt,name=export_format_id,json=exportFormatId,proto3" json:"export_format_id,omitempty"`
	// The Cloud Storage location where the Model artifact is to be
	// written to. Under the directory given as the destination a new one with
	// name "`model-export-<model-display-name>-<timestamp-of-export-call>`",
	// where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format,
	// will be created. Inside, the Model and any of its supporting files
	// will be written.
	// This field should only be set when the `exportableContent` field of the
	// [Model.supported_export_formats] object contains `ARTIFACT`.
	ArtifactDestination *GcsDestination `protobuf:"bytes,3,opt,name=artifact_destination,json=artifactDestination,proto3" json:"artifact_destination,omitempty"`
	// The Google Container Registry or Artifact Registry uri where the
	// Model container image will be copied to.
	// This field should only be set when the `exportableContent` field of the
	// [Model.supported_export_formats] object contains `IMAGE`.
	ImageDestination *ContainerRegistryDestination `protobuf:"bytes,4,opt,name=image_destination,json=imageDestination,proto3" json:"image_destination,omitempty"`
	// contains filtered or unexported fields
}

Output configuration for the Model export.

func (*ExportModelRequest_OutputConfig) Descriptor deprecated

func (*ExportModelRequest_OutputConfig) Descriptor() ([]byte, []int)

Deprecated: Use ExportModelRequest_OutputConfig.ProtoReflect.Descriptor instead.

func (*ExportModelRequest_OutputConfig) GetArtifactDestination

func (x *ExportModelRequest_OutputConfig) GetArtifactDestination() *GcsDestination

func (*ExportModelRequest_OutputConfig) GetExportFormatId

func (x *ExportModelRequest_OutputConfig) GetExportFormatId() string

func (*ExportModelRequest_OutputConfig) GetImageDestination

func (*ExportModelRequest_OutputConfig) ProtoMessage

func (*ExportModelRequest_OutputConfig) ProtoMessage()

func (*ExportModelRequest_OutputConfig) ProtoReflect

func (*ExportModelRequest_OutputConfig) Reset

func (*ExportModelRequest_OutputConfig) String

type ExportModelResponse

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

Response message of [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel] operation.

func (*ExportModelResponse) Descriptor deprecated

func (*ExportModelResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportModelResponse.ProtoReflect.Descriptor instead.

func (*ExportModelResponse) ProtoMessage

func (*ExportModelResponse) ProtoMessage()

func (*ExportModelResponse) ProtoReflect

func (x *ExportModelResponse) ProtoReflect() protoreflect.Message

func (*ExportModelResponse) Reset

func (x *ExportModelResponse) Reset()

func (*ExportModelResponse) String

func (x *ExportModelResponse) String() string

type ExportTensorboardTimeSeriesDataRequest

type ExportTensorboardTimeSeriesDataRequest struct {

	// Required. The resource name of the TensorboardTimeSeries to export data
	// from. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
	TensorboardTimeSeries string `` /* 126-byte string literal not displayed */
	// Exports the TensorboardTimeSeries' data that match the filter expression.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of data points to return per page.
	// The default page_size is 1000. Values must be between 1 and 10000.
	// Values above 10000 are coerced to 10000.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Field to use to sort the TensorboardTimeSeries' data.
	// By default, TensorboardTimeSeries' data is returned in a pseudo random
	// order.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData].

func (*ExportTensorboardTimeSeriesDataRequest) Descriptor deprecated

func (*ExportTensorboardTimeSeriesDataRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExportTensorboardTimeSeriesDataRequest.ProtoReflect.Descriptor instead.

func (*ExportTensorboardTimeSeriesDataRequest) GetFilter

func (*ExportTensorboardTimeSeriesDataRequest) GetOrderBy

func (*ExportTensorboardTimeSeriesDataRequest) GetPageSize

func (*ExportTensorboardTimeSeriesDataRequest) GetPageToken

func (*ExportTensorboardTimeSeriesDataRequest) GetTensorboardTimeSeries

func (x *ExportTensorboardTimeSeriesDataRequest) GetTensorboardTimeSeries() string

func (*ExportTensorboardTimeSeriesDataRequest) ProtoMessage

func (*ExportTensorboardTimeSeriesDataRequest) ProtoReflect

func (*ExportTensorboardTimeSeriesDataRequest) Reset

func (*ExportTensorboardTimeSeriesDataRequest) String

type ExportTensorboardTimeSeriesDataResponse

type ExportTensorboardTimeSeriesDataResponse struct {

	// The returned time series data points.
	TimeSeriesDataPoints []*TimeSeriesDataPoint `protobuf:"bytes,1,rep,name=time_series_data_points,json=timeSeriesDataPoints,proto3" json:"time_series_data_points,omitempty"`
	// A token, which can be sent as
	// [page_token][google.cloud.aiplatform.v1.ExportTensorboardTimeSeriesDataRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData].

func (*ExportTensorboardTimeSeriesDataResponse) Descriptor deprecated

func (*ExportTensorboardTimeSeriesDataResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportTensorboardTimeSeriesDataResponse.ProtoReflect.Descriptor instead.

func (*ExportTensorboardTimeSeriesDataResponse) GetNextPageToken

func (x *ExportTensorboardTimeSeriesDataResponse) GetNextPageToken() string

func (*ExportTensorboardTimeSeriesDataResponse) GetTimeSeriesDataPoints

func (x *ExportTensorboardTimeSeriesDataResponse) GetTimeSeriesDataPoints() []*TimeSeriesDataPoint

func (*ExportTensorboardTimeSeriesDataResponse) ProtoMessage

func (*ExportTensorboardTimeSeriesDataResponse) ProtoReflect

func (*ExportTensorboardTimeSeriesDataResponse) Reset

func (*ExportTensorboardTimeSeriesDataResponse) String

type Feature

type Feature struct {

	// Immutable. Name of the Feature.
	// Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
	// `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
	//
	// The last part feature is assigned by the client. The feature can be up to
	// 64 characters long and can consist only of ASCII Latin letters A-Z and a-z,
	// underscore(_), and ASCII digits 0-9 starting with a letter. The value will
	// be unique given an entity type.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the Feature.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Immutable. Only applicable for Vertex AI Feature Store (Legacy).
	// Type of Feature value.
	ValueType Feature_ValueType `` /* 139-byte string literal not displayed */
	// Output only. Only applicable for Vertex AI Feature Store (Legacy).
	// Timestamp when this EntityType was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Only applicable for Vertex AI Feature Store (Legacy).
	// Timestamp when this EntityType was most recently updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. The labels with user-defined metadata to organize your Features.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information on and examples of labels.
	// No more than 64 user labels can be associated with one Feature (System
	// labels are excluded)."
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Used to perform a consistent read-modify-write updates. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,7,opt,name=etag,proto3" json:"etag,omitempty"`
	// Optional. Only applicable for Vertex AI Feature Store (Legacy).
	// If not set, use the monitoring_config defined for the EntityType this
	// Feature belongs to.
	// Only Features with type
	// ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL,
	// STRING, DOUBLE or INT64 can enable monitoring.
	//
	// If set to true, all types of data monitoring are disabled despite the
	// config on EntityType.
	DisableMonitoring bool `protobuf:"varint,12,opt,name=disable_monitoring,json=disableMonitoring,proto3" json:"disable_monitoring,omitempty"`
	// Output only. Only applicable for Vertex AI Feature Store (Legacy).
	// The list of historical stats and anomalies with specified objectives.
	MonitoringStatsAnomalies []*Feature_MonitoringStatsAnomaly `` /* 136-byte string literal not displayed */
	// Only applicable for Vertex AI Feature Store.
	// The name of the BigQuery Table/View column hosting data for this version.
	// If no value is provided, will use feature_id.
	VersionColumnName string `protobuf:"bytes,106,opt,name=version_column_name,json=versionColumnName,proto3" json:"version_column_name,omitempty"`
	// Entity responsible for maintaining this feature. Can be comma separated
	// list of email addresses or URIs.
	PointOfContact string `protobuf:"bytes,107,opt,name=point_of_contact,json=pointOfContact,proto3" json:"point_of_contact,omitempty"`
	// contains filtered or unexported fields
}

Feature Metadata information. For example, color is a feature that describes an apple.

func (*Feature) Descriptor deprecated

func (*Feature) Descriptor() ([]byte, []int)

Deprecated: Use Feature.ProtoReflect.Descriptor instead.

func (*Feature) GetCreateTime

func (x *Feature) GetCreateTime() *timestamppb.Timestamp

func (*Feature) GetDescription

func (x *Feature) GetDescription() string

func (*Feature) GetDisableMonitoring

func (x *Feature) GetDisableMonitoring() bool

func (*Feature) GetEtag

func (x *Feature) GetEtag() string

func (*Feature) GetLabels

func (x *Feature) GetLabels() map[string]string

func (*Feature) GetMonitoringStatsAnomalies

func (x *Feature) GetMonitoringStatsAnomalies() []*Feature_MonitoringStatsAnomaly

func (*Feature) GetName

func (x *Feature) GetName() string

func (*Feature) GetPointOfContact added in v1.62.0

func (x *Feature) GetPointOfContact() string

func (*Feature) GetUpdateTime

func (x *Feature) GetUpdateTime() *timestamppb.Timestamp

func (*Feature) GetValueType

func (x *Feature) GetValueType() Feature_ValueType

func (*Feature) GetVersionColumnName added in v1.54.0

func (x *Feature) GetVersionColumnName() string

func (*Feature) ProtoMessage

func (*Feature) ProtoMessage()

func (*Feature) ProtoReflect

func (x *Feature) ProtoReflect() protoreflect.Message

func (*Feature) Reset

func (x *Feature) Reset()

func (*Feature) String

func (x *Feature) String() string

type FeatureGroup added in v1.54.0

type FeatureGroup struct {

	// Types that are assignable to Source:
	//
	//	*FeatureGroup_BigQuery_
	Source isFeatureGroup_Source `protobuf_oneof:"source"`
	// Identifier. Name of the FeatureGroup. Format:
	// `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Timestamp when this FeatureGroup was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this FeatureGroup was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. Used to perform consistent read-modify-write updates. If not set,
	// a blind "overwrite" update happens.
	Etag string `protobuf:"bytes,4,opt,name=etag,proto3" json:"etag,omitempty"`
	// Optional. The labels with user-defined metadata to organize your
	// FeatureGroup.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information on and examples of labels.
	// No more than 64 user labels can be associated with one
	// FeatureGroup(System labels are excluded)." System reserved label keys
	// are prefixed with "aiplatform.googleapis.com/" and are immutable.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Optional. Description of the FeatureGroup.
	Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Vertex AI Feature Group.

func (*FeatureGroup) Descriptor deprecated added in v1.54.0

func (*FeatureGroup) Descriptor() ([]byte, []int)

Deprecated: Use FeatureGroup.ProtoReflect.Descriptor instead.

func (*FeatureGroup) GetBigQuery added in v1.54.0

func (x *FeatureGroup) GetBigQuery() *FeatureGroup_BigQuery

func (*FeatureGroup) GetCreateTime added in v1.54.0

func (x *FeatureGroup) GetCreateTime() *timestamppb.Timestamp

func (*FeatureGroup) GetDescription added in v1.54.0

func (x *FeatureGroup) GetDescription() string

func (*FeatureGroup) GetEtag added in v1.54.0

func (x *FeatureGroup) GetEtag() string

func (*FeatureGroup) GetLabels added in v1.54.0

func (x *FeatureGroup) GetLabels() map[string]string

func (*FeatureGroup) GetName added in v1.54.0

func (x *FeatureGroup) GetName() string

func (*FeatureGroup) GetSource added in v1.54.0

func (m *FeatureGroup) GetSource() isFeatureGroup_Source

func (*FeatureGroup) GetUpdateTime added in v1.54.0

func (x *FeatureGroup) GetUpdateTime() *timestamppb.Timestamp

func (*FeatureGroup) ProtoMessage added in v1.54.0

func (*FeatureGroup) ProtoMessage()

func (*FeatureGroup) ProtoReflect added in v1.54.0

func (x *FeatureGroup) ProtoReflect() protoreflect.Message

func (*FeatureGroup) Reset added in v1.54.0

func (x *FeatureGroup) Reset()

func (*FeatureGroup) String added in v1.54.0

func (x *FeatureGroup) String() string

type FeatureGroup_BigQuery added in v1.54.0

type FeatureGroup_BigQuery struct {

	// Required. Immutable. The BigQuery source URI that points to either a
	// BigQuery Table or View.
	BigQuerySource *BigQuerySource `protobuf:"bytes,1,opt,name=big_query_source,json=bigQuerySource,proto3" json:"big_query_source,omitempty"`
	// Optional. Columns to construct entity_id / row keys.
	// If not provided defaults to `entity_id`.
	EntityIdColumns []string `protobuf:"bytes,2,rep,name=entity_id_columns,json=entityIdColumns,proto3" json:"entity_id_columns,omitempty"`
	// contains filtered or unexported fields
}

Input source type for BigQuery Tables and Views.

func (*FeatureGroup_BigQuery) Descriptor deprecated added in v1.54.0

func (*FeatureGroup_BigQuery) Descriptor() ([]byte, []int)

Deprecated: Use FeatureGroup_BigQuery.ProtoReflect.Descriptor instead.

func (*FeatureGroup_BigQuery) GetBigQuerySource added in v1.54.0

func (x *FeatureGroup_BigQuery) GetBigQuerySource() *BigQuerySource

func (*FeatureGroup_BigQuery) GetEntityIdColumns added in v1.54.0

func (x *FeatureGroup_BigQuery) GetEntityIdColumns() []string

func (*FeatureGroup_BigQuery) ProtoMessage added in v1.54.0

func (*FeatureGroup_BigQuery) ProtoMessage()

func (*FeatureGroup_BigQuery) ProtoReflect added in v1.54.0

func (x *FeatureGroup_BigQuery) ProtoReflect() protoreflect.Message

func (*FeatureGroup_BigQuery) Reset added in v1.54.0

func (x *FeatureGroup_BigQuery) Reset()

func (*FeatureGroup_BigQuery) String added in v1.54.0

func (x *FeatureGroup_BigQuery) String() string

type FeatureGroup_BigQuery_ added in v1.54.0

type FeatureGroup_BigQuery_ struct {
	// Indicates that features for this group come from BigQuery Table/View.
	// By default treats the source as a sparse time series source, which is
	// required to have an entity_id and a feature_timestamp column in the
	// source.
	BigQuery *FeatureGroup_BigQuery `protobuf:"bytes,7,opt,name=big_query,json=bigQuery,proto3,oneof"`
}

type FeatureNoiseSigma

type FeatureNoiseSigma struct {

	// Noise sigma per feature. No noise is added to features that are not set.
	NoiseSigma []*FeatureNoiseSigma_NoiseSigmaForFeature `protobuf:"bytes,1,rep,name=noise_sigma,json=noiseSigma,proto3" json:"noise_sigma,omitempty"`
	// contains filtered or unexported fields
}

Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients.

func (*FeatureNoiseSigma) Descriptor deprecated

func (*FeatureNoiseSigma) Descriptor() ([]byte, []int)

Deprecated: Use FeatureNoiseSigma.ProtoReflect.Descriptor instead.

func (*FeatureNoiseSigma) GetNoiseSigma

func (*FeatureNoiseSigma) ProtoMessage

func (*FeatureNoiseSigma) ProtoMessage()

func (*FeatureNoiseSigma) ProtoReflect

func (x *FeatureNoiseSigma) ProtoReflect() protoreflect.Message

func (*FeatureNoiseSigma) Reset

func (x *FeatureNoiseSigma) Reset()

func (*FeatureNoiseSigma) String

func (x *FeatureNoiseSigma) String() string

type FeatureNoiseSigma_NoiseSigmaForFeature

type FeatureNoiseSigma_NoiseSigmaForFeature struct {

	// The name of the input feature for which noise sigma is provided. The
	// features are defined in
	// [explanation metadata
	// inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// This represents the standard deviation of the Gaussian kernel that will
	// be used to add noise to the feature prior to computing gradients. Similar
	// to [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma]
	// but represents the noise added to the current feature. Defaults to 0.1.
	Sigma float32 `protobuf:"fixed32,2,opt,name=sigma,proto3" json:"sigma,omitempty"`
	// contains filtered or unexported fields
}

Noise sigma for a single feature.

func (*FeatureNoiseSigma_NoiseSigmaForFeature) Descriptor deprecated

func (*FeatureNoiseSigma_NoiseSigmaForFeature) Descriptor() ([]byte, []int)

Deprecated: Use FeatureNoiseSigma_NoiseSigmaForFeature.ProtoReflect.Descriptor instead.

func (*FeatureNoiseSigma_NoiseSigmaForFeature) GetName

func (*FeatureNoiseSigma_NoiseSigmaForFeature) GetSigma

func (*FeatureNoiseSigma_NoiseSigmaForFeature) ProtoMessage

func (*FeatureNoiseSigma_NoiseSigmaForFeature) ProtoReflect

func (*FeatureNoiseSigma_NoiseSigmaForFeature) Reset

func (*FeatureNoiseSigma_NoiseSigmaForFeature) String

type FeatureOnlineStore added in v1.54.0

type FeatureOnlineStore struct {

	// Types that are assignable to StorageType:
	//
	//	*FeatureOnlineStore_Bigtable_
	//	*FeatureOnlineStore_Optimized_
	StorageType isFeatureOnlineStore_StorageType `protobuf_oneof:"storage_type"`
	// Identifier. Name of the FeatureOnlineStore. Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Timestamp when this FeatureOnlineStore was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this FeatureOnlineStore was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. Used to perform consistent read-modify-write updates. If not set,
	// a blind "overwrite" update happens.
	Etag string `protobuf:"bytes,5,opt,name=etag,proto3" json:"etag,omitempty"`
	// Optional. The labels with user-defined metadata to organize your
	// FeatureOnlineStore.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information on and examples of labels.
	// No more than 64 user labels can be associated with one
	// FeatureOnlineStore(System labels are excluded)." System reserved label keys
	// are prefixed with "aiplatform.googleapis.com/" and are immutable.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Output only. State of the featureOnlineStore.
	State FeatureOnlineStore_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.FeatureOnlineStore_State" json:"state,omitempty"`
	// Optional. The dedicated serving endpoint for this FeatureOnlineStore, which
	// is different from common Vertex service endpoint.
	DedicatedServingEndpoint *FeatureOnlineStore_DedicatedServingEndpoint `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

Vertex AI Feature Online Store provides a centralized repository for serving ML features and embedding indexes at low latency. The Feature Online Store is a top-level container.

func (*FeatureOnlineStore) Descriptor deprecated added in v1.54.0

func (*FeatureOnlineStore) Descriptor() ([]byte, []int)

Deprecated: Use FeatureOnlineStore.ProtoReflect.Descriptor instead.

func (*FeatureOnlineStore) GetBigtable added in v1.54.0

func (*FeatureOnlineStore) GetCreateTime added in v1.54.0

func (x *FeatureOnlineStore) GetCreateTime() *timestamppb.Timestamp

func (*FeatureOnlineStore) GetDedicatedServingEndpoint added in v1.65.0

func (x *FeatureOnlineStore) GetDedicatedServingEndpoint() *FeatureOnlineStore_DedicatedServingEndpoint

func (*FeatureOnlineStore) GetEtag added in v1.54.0

func (x *FeatureOnlineStore) GetEtag() string

func (*FeatureOnlineStore) GetLabels added in v1.54.0

func (x *FeatureOnlineStore) GetLabels() map[string]string

func (*FeatureOnlineStore) GetName added in v1.54.0

func (x *FeatureOnlineStore) GetName() string

func (*FeatureOnlineStore) GetOptimized added in v1.65.0

func (*FeatureOnlineStore) GetState added in v1.54.0

func (*FeatureOnlineStore) GetStorageType added in v1.54.0

func (m *FeatureOnlineStore) GetStorageType() isFeatureOnlineStore_StorageType

func (*FeatureOnlineStore) GetUpdateTime added in v1.54.0

func (x *FeatureOnlineStore) GetUpdateTime() *timestamppb.Timestamp

func (*FeatureOnlineStore) ProtoMessage added in v1.54.0

func (*FeatureOnlineStore) ProtoMessage()

func (*FeatureOnlineStore) ProtoReflect added in v1.54.0

func (x *FeatureOnlineStore) ProtoReflect() protoreflect.Message

func (*FeatureOnlineStore) Reset added in v1.54.0

func (x *FeatureOnlineStore) Reset()

func (*FeatureOnlineStore) String added in v1.54.0

func (x *FeatureOnlineStore) String() string

type FeatureOnlineStoreAdminServiceClient added in v1.54.0

type FeatureOnlineStoreAdminServiceClient interface {
	// Creates a new FeatureOnlineStore in a given project and location.
	CreateFeatureOnlineStore(ctx context.Context, in *CreateFeatureOnlineStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets details of a single FeatureOnlineStore.
	GetFeatureOnlineStore(ctx context.Context, in *GetFeatureOnlineStoreRequest, opts ...grpc.CallOption) (*FeatureOnlineStore, error)
	// Lists FeatureOnlineStores in a given project and location.
	ListFeatureOnlineStores(ctx context.Context, in *ListFeatureOnlineStoresRequest, opts ...grpc.CallOption) (*ListFeatureOnlineStoresResponse, error)
	// Updates the parameters of a single FeatureOnlineStore.
	UpdateFeatureOnlineStore(ctx context.Context, in *UpdateFeatureOnlineStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not
	// contain any FeatureViews.
	DeleteFeatureOnlineStore(ctx context.Context, in *DeleteFeatureOnlineStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a new FeatureView in a given FeatureOnlineStore.
	CreateFeatureView(ctx context.Context, in *CreateFeatureViewRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets details of a single FeatureView.
	GetFeatureView(ctx context.Context, in *GetFeatureViewRequest, opts ...grpc.CallOption) (*FeatureView, error)
	// Lists FeatureViews in a given FeatureOnlineStore.
	ListFeatureViews(ctx context.Context, in *ListFeatureViewsRequest, opts ...grpc.CallOption) (*ListFeatureViewsResponse, error)
	// Updates the parameters of a single FeatureView.
	UpdateFeatureView(ctx context.Context, in *UpdateFeatureViewRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single FeatureView.
	DeleteFeatureView(ctx context.Context, in *DeleteFeatureViewRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Triggers on-demand sync for the FeatureView.
	SyncFeatureView(ctx context.Context, in *SyncFeatureViewRequest, opts ...grpc.CallOption) (*SyncFeatureViewResponse, error)
	// Gets details of a single FeatureViewSync.
	GetFeatureViewSync(ctx context.Context, in *GetFeatureViewSyncRequest, opts ...grpc.CallOption) (*FeatureViewSync, error)
	// Lists FeatureViewSyncs in a given FeatureView.
	ListFeatureViewSyncs(ctx context.Context, in *ListFeatureViewSyncsRequest, opts ...grpc.CallOption) (*ListFeatureViewSyncsResponse, error)
}

FeatureOnlineStoreAdminServiceClient is the client API for FeatureOnlineStoreAdminService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewFeatureOnlineStoreAdminServiceClient added in v1.54.0

func NewFeatureOnlineStoreAdminServiceClient(cc grpc.ClientConnInterface) FeatureOnlineStoreAdminServiceClient

type FeatureOnlineStoreAdminServiceServer added in v1.54.0

type FeatureOnlineStoreAdminServiceServer interface {
	// Creates a new FeatureOnlineStore in a given project and location.
	CreateFeatureOnlineStore(context.Context, *CreateFeatureOnlineStoreRequest) (*longrunningpb.Operation, error)
	// Gets details of a single FeatureOnlineStore.
	GetFeatureOnlineStore(context.Context, *GetFeatureOnlineStoreRequest) (*FeatureOnlineStore, error)
	// Lists FeatureOnlineStores in a given project and location.
	ListFeatureOnlineStores(context.Context, *ListFeatureOnlineStoresRequest) (*ListFeatureOnlineStoresResponse, error)
	// Updates the parameters of a single FeatureOnlineStore.
	UpdateFeatureOnlineStore(context.Context, *UpdateFeatureOnlineStoreRequest) (*longrunningpb.Operation, error)
	// Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not
	// contain any FeatureViews.
	DeleteFeatureOnlineStore(context.Context, *DeleteFeatureOnlineStoreRequest) (*longrunningpb.Operation, error)
	// Creates a new FeatureView in a given FeatureOnlineStore.
	CreateFeatureView(context.Context, *CreateFeatureViewRequest) (*longrunningpb.Operation, error)
	// Gets details of a single FeatureView.
	GetFeatureView(context.Context, *GetFeatureViewRequest) (*FeatureView, error)
	// Lists FeatureViews in a given FeatureOnlineStore.
	ListFeatureViews(context.Context, *ListFeatureViewsRequest) (*ListFeatureViewsResponse, error)
	// Updates the parameters of a single FeatureView.
	UpdateFeatureView(context.Context, *UpdateFeatureViewRequest) (*longrunningpb.Operation, error)
	// Deletes a single FeatureView.
	DeleteFeatureView(context.Context, *DeleteFeatureViewRequest) (*longrunningpb.Operation, error)
	// Triggers on-demand sync for the FeatureView.
	SyncFeatureView(context.Context, *SyncFeatureViewRequest) (*SyncFeatureViewResponse, error)
	// Gets details of a single FeatureViewSync.
	GetFeatureViewSync(context.Context, *GetFeatureViewSyncRequest) (*FeatureViewSync, error)
	// Lists FeatureViewSyncs in a given FeatureView.
	ListFeatureViewSyncs(context.Context, *ListFeatureViewSyncsRequest) (*ListFeatureViewSyncsResponse, error)
}

FeatureOnlineStoreAdminServiceServer is the server API for FeatureOnlineStoreAdminService service.

type FeatureOnlineStoreServiceClient added in v1.54.0

type FeatureOnlineStoreServiceClient interface {
	// Fetch feature values under a FeatureView.
	FetchFeatureValues(ctx context.Context, in *FetchFeatureValuesRequest, opts ...grpc.CallOption) (*FetchFeatureValuesResponse, error)
	// Search the nearest entities under a FeatureView.
	// Search only works for indexable feature view; if a feature view isn't
	// indexable, returns Invalid argument response.
	SearchNearestEntities(ctx context.Context, in *SearchNearestEntitiesRequest, opts ...grpc.CallOption) (*SearchNearestEntitiesResponse, error)
}

FeatureOnlineStoreServiceClient is the client API for FeatureOnlineStoreService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewFeatureOnlineStoreServiceClient added in v1.54.0

func NewFeatureOnlineStoreServiceClient(cc grpc.ClientConnInterface) FeatureOnlineStoreServiceClient

type FeatureOnlineStoreServiceServer added in v1.54.0

type FeatureOnlineStoreServiceServer interface {
	// Fetch feature values under a FeatureView.
	FetchFeatureValues(context.Context, *FetchFeatureValuesRequest) (*FetchFeatureValuesResponse, error)
	// Search the nearest entities under a FeatureView.
	// Search only works for indexable feature view; if a feature view isn't
	// indexable, returns Invalid argument response.
	SearchNearestEntities(context.Context, *SearchNearestEntitiesRequest) (*SearchNearestEntitiesResponse, error)
}

FeatureOnlineStoreServiceServer is the server API for FeatureOnlineStoreService service.

type FeatureOnlineStore_Bigtable added in v1.54.0

type FeatureOnlineStore_Bigtable struct {

	// Required. Autoscaling config applied to Bigtable Instance.
	AutoScaling *FeatureOnlineStore_Bigtable_AutoScaling `protobuf:"bytes,1,opt,name=auto_scaling,json=autoScaling,proto3" json:"auto_scaling,omitempty"`
	// contains filtered or unexported fields
}

func (*FeatureOnlineStore_Bigtable) Descriptor deprecated added in v1.54.0

func (*FeatureOnlineStore_Bigtable) Descriptor() ([]byte, []int)

Deprecated: Use FeatureOnlineStore_Bigtable.ProtoReflect.Descriptor instead.

func (*FeatureOnlineStore_Bigtable) GetAutoScaling added in v1.54.0

func (*FeatureOnlineStore_Bigtable) ProtoMessage added in v1.54.0

func (*FeatureOnlineStore_Bigtable) ProtoMessage()

func (*FeatureOnlineStore_Bigtable) ProtoReflect added in v1.54.0

func (*FeatureOnlineStore_Bigtable) Reset added in v1.54.0

func (x *FeatureOnlineStore_Bigtable) Reset()

func (*FeatureOnlineStore_Bigtable) String added in v1.54.0

func (x *FeatureOnlineStore_Bigtable) String() string

type FeatureOnlineStore_Bigtable_ added in v1.54.0

type FeatureOnlineStore_Bigtable_ struct {
	// Contains settings for the Cloud Bigtable instance that will be created
	// to serve featureValues for all FeatureViews under this
	// FeatureOnlineStore.
	Bigtable *FeatureOnlineStore_Bigtable `protobuf:"bytes,8,opt,name=bigtable,proto3,oneof"`
}

type FeatureOnlineStore_Bigtable_AutoScaling added in v1.54.0

type FeatureOnlineStore_Bigtable_AutoScaling struct {

	// Required. The minimum number of nodes to scale down to. Must be greater
	// than or equal to 1.
	MinNodeCount int32 `protobuf:"varint,1,opt,name=min_node_count,json=minNodeCount,proto3" json:"min_node_count,omitempty"`
	// Required. The maximum number of nodes to scale up to. Must be greater
	// than or equal to min_node_count, and less than or equal to 10 times of
	// 'min_node_count'.
	MaxNodeCount int32 `protobuf:"varint,2,opt,name=max_node_count,json=maxNodeCount,proto3" json:"max_node_count,omitempty"`
	// Optional. A percentage of the cluster's CPU capacity. Can be from 10%
	// to 80%. When a cluster's CPU utilization exceeds the target that you
	// have set, Bigtable immediately adds nodes to the cluster. When CPU
	// utilization is substantially lower than the target, Bigtable removes
	// nodes. If not set will default to 50%.
	CpuUtilizationTarget int32 `protobuf:"varint,3,opt,name=cpu_utilization_target,json=cpuUtilizationTarget,proto3" json:"cpu_utilization_target,omitempty"`
	// contains filtered or unexported fields
}

func (*FeatureOnlineStore_Bigtable_AutoScaling) Descriptor deprecated added in v1.54.0

func (*FeatureOnlineStore_Bigtable_AutoScaling) Descriptor() ([]byte, []int)

Deprecated: Use FeatureOnlineStore_Bigtable_AutoScaling.ProtoReflect.Descriptor instead.

func (*FeatureOnlineStore_Bigtable_AutoScaling) GetCpuUtilizationTarget added in v1.54.0

func (x *FeatureOnlineStore_Bigtable_AutoScaling) GetCpuUtilizationTarget() int32

func (*FeatureOnlineStore_Bigtable_AutoScaling) GetMaxNodeCount added in v1.54.0

func (x *FeatureOnlineStore_Bigtable_AutoScaling) GetMaxNodeCount() int32

func (*FeatureOnlineStore_Bigtable_AutoScaling) GetMinNodeCount added in v1.54.0

func (x *FeatureOnlineStore_Bigtable_AutoScaling) GetMinNodeCount() int32

func (*FeatureOnlineStore_Bigtable_AutoScaling) ProtoMessage added in v1.54.0

func (*FeatureOnlineStore_Bigtable_AutoScaling) ProtoReflect added in v1.54.0

func (*FeatureOnlineStore_Bigtable_AutoScaling) Reset added in v1.54.0

func (*FeatureOnlineStore_Bigtable_AutoScaling) String added in v1.54.0

type FeatureOnlineStore_DedicatedServingEndpoint added in v1.65.0

type FeatureOnlineStore_DedicatedServingEndpoint struct {

	// Output only. This field will be populated with the domain name to use for
	// this FeatureOnlineStore
	PublicEndpointDomainName string `` /* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default.

func (*FeatureOnlineStore_DedicatedServingEndpoint) Descriptor deprecated added in v1.65.0

Deprecated: Use FeatureOnlineStore_DedicatedServingEndpoint.ProtoReflect.Descriptor instead.

func (*FeatureOnlineStore_DedicatedServingEndpoint) GetPublicEndpointDomainName added in v1.65.0

func (x *FeatureOnlineStore_DedicatedServingEndpoint) GetPublicEndpointDomainName() string

func (*FeatureOnlineStore_DedicatedServingEndpoint) ProtoMessage added in v1.65.0

func (*FeatureOnlineStore_DedicatedServingEndpoint) ProtoReflect added in v1.65.0

func (*FeatureOnlineStore_DedicatedServingEndpoint) Reset added in v1.65.0

func (*FeatureOnlineStore_DedicatedServingEndpoint) String added in v1.65.0

type FeatureOnlineStore_Optimized added in v1.65.0

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

Optimized storage type

func (*FeatureOnlineStore_Optimized) Descriptor deprecated added in v1.65.0

func (*FeatureOnlineStore_Optimized) Descriptor() ([]byte, []int)

Deprecated: Use FeatureOnlineStore_Optimized.ProtoReflect.Descriptor instead.

func (*FeatureOnlineStore_Optimized) ProtoMessage added in v1.65.0

func (*FeatureOnlineStore_Optimized) ProtoMessage()

func (*FeatureOnlineStore_Optimized) ProtoReflect added in v1.65.0

func (*FeatureOnlineStore_Optimized) Reset added in v1.65.0

func (x *FeatureOnlineStore_Optimized) Reset()

func (*FeatureOnlineStore_Optimized) String added in v1.65.0

type FeatureOnlineStore_Optimized_ added in v1.65.0

type FeatureOnlineStore_Optimized_ struct {
	// Contains settings for the Optimized store that will be created
	// to serve featureValues for all FeatureViews under this
	// FeatureOnlineStore. When choose Optimized storage type, need to set
	// [PrivateServiceConnectConfig.enable_private_service_connect][google.cloud.aiplatform.v1.PrivateServiceConnectConfig.enable_private_service_connect]
	// to use private endpoint. Otherwise will use public endpoint by default.
	Optimized *FeatureOnlineStore_Optimized `protobuf:"bytes,12,opt,name=optimized,proto3,oneof"`
}

type FeatureOnlineStore_State added in v1.54.0

type FeatureOnlineStore_State int32

Possible states a featureOnlineStore can have.

const (
	// Default value. This value is unused.
	FeatureOnlineStore_STATE_UNSPECIFIED FeatureOnlineStore_State = 0
	// State when the featureOnlineStore configuration is not being updated and
	// the fields reflect the current configuration of the featureOnlineStore.
	// The featureOnlineStore is usable in this state.
	FeatureOnlineStore_STABLE FeatureOnlineStore_State = 1
	// The state of the featureOnlineStore configuration when it is being
	// updated. During an update, the fields reflect either the original
	// configuration or the updated configuration of the featureOnlineStore. The
	// featureOnlineStore is still usable in this state.
	FeatureOnlineStore_UPDATING FeatureOnlineStore_State = 2
)

func (FeatureOnlineStore_State) Descriptor added in v1.54.0

func (FeatureOnlineStore_State) Enum added in v1.54.0

func (FeatureOnlineStore_State) EnumDescriptor deprecated added in v1.54.0

func (FeatureOnlineStore_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use FeatureOnlineStore_State.Descriptor instead.

func (FeatureOnlineStore_State) Number added in v1.54.0

func (FeatureOnlineStore_State) String added in v1.54.0

func (x FeatureOnlineStore_State) String() string

func (FeatureOnlineStore_State) Type added in v1.54.0

type FeatureRegistryServiceClient added in v1.54.0

type FeatureRegistryServiceClient interface {
	// Creates a new FeatureGroup in a given project and location.
	CreateFeatureGroup(ctx context.Context, in *CreateFeatureGroupRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets details of a single FeatureGroup.
	GetFeatureGroup(ctx context.Context, in *GetFeatureGroupRequest, opts ...grpc.CallOption) (*FeatureGroup, error)
	// Lists FeatureGroups in a given project and location.
	ListFeatureGroups(ctx context.Context, in *ListFeatureGroupsRequest, opts ...grpc.CallOption) (*ListFeatureGroupsResponse, error)
	// Updates the parameters of a single FeatureGroup.
	UpdateFeatureGroup(ctx context.Context, in *UpdateFeatureGroupRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single FeatureGroup.
	DeleteFeatureGroup(ctx context.Context, in *DeleteFeatureGroupRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a new Feature in a given FeatureGroup.
	CreateFeature(ctx context.Context, in *CreateFeatureRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets details of a single Feature.
	GetFeature(ctx context.Context, in *GetFeatureRequest, opts ...grpc.CallOption) (*Feature, error)
	// Lists Features in a given FeatureGroup.
	ListFeatures(ctx context.Context, in *ListFeaturesRequest, opts ...grpc.CallOption) (*ListFeaturesResponse, error)
	// Updates the parameters of a single Feature.
	UpdateFeature(ctx context.Context, in *UpdateFeatureRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single Feature.
	DeleteFeature(ctx context.Context, in *DeleteFeatureRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

FeatureRegistryServiceClient is the client API for FeatureRegistryService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewFeatureRegistryServiceClient added in v1.54.0

func NewFeatureRegistryServiceClient(cc grpc.ClientConnInterface) FeatureRegistryServiceClient

type FeatureRegistryServiceServer added in v1.54.0

type FeatureRegistryServiceServer interface {
	// Creates a new FeatureGroup in a given project and location.
	CreateFeatureGroup(context.Context, *CreateFeatureGroupRequest) (*longrunningpb.Operation, error)
	// Gets details of a single FeatureGroup.
	GetFeatureGroup(context.Context, *GetFeatureGroupRequest) (*FeatureGroup, error)
	// Lists FeatureGroups in a given project and location.
	ListFeatureGroups(context.Context, *ListFeatureGroupsRequest) (*ListFeatureGroupsResponse, error)
	// Updates the parameters of a single FeatureGroup.
	UpdateFeatureGroup(context.Context, *UpdateFeatureGroupRequest) (*longrunningpb.Operation, error)
	// Deletes a single FeatureGroup.
	DeleteFeatureGroup(context.Context, *DeleteFeatureGroupRequest) (*longrunningpb.Operation, error)
	// Creates a new Feature in a given FeatureGroup.
	CreateFeature(context.Context, *CreateFeatureRequest) (*longrunningpb.Operation, error)
	// Gets details of a single Feature.
	GetFeature(context.Context, *GetFeatureRequest) (*Feature, error)
	// Lists Features in a given FeatureGroup.
	ListFeatures(context.Context, *ListFeaturesRequest) (*ListFeaturesResponse, error)
	// Updates the parameters of a single Feature.
	UpdateFeature(context.Context, *UpdateFeatureRequest) (*longrunningpb.Operation, error)
	// Deletes a single Feature.
	DeleteFeature(context.Context, *DeleteFeatureRequest) (*longrunningpb.Operation, error)
}

FeatureRegistryServiceServer is the server API for FeatureRegistryService service.

type FeatureSelector

type FeatureSelector struct {

	// Required. Matches Features based on ID.
	IdMatcher *IdMatcher `protobuf:"bytes,1,opt,name=id_matcher,json=idMatcher,proto3" json:"id_matcher,omitempty"`
	// contains filtered or unexported fields
}

Selector for Features of an EntityType.

func (*FeatureSelector) Descriptor deprecated

func (*FeatureSelector) Descriptor() ([]byte, []int)

Deprecated: Use FeatureSelector.ProtoReflect.Descriptor instead.

func (*FeatureSelector) GetIdMatcher

func (x *FeatureSelector) GetIdMatcher() *IdMatcher

func (*FeatureSelector) ProtoMessage

func (*FeatureSelector) ProtoMessage()

func (*FeatureSelector) ProtoReflect

func (x *FeatureSelector) ProtoReflect() protoreflect.Message

func (*FeatureSelector) Reset

func (x *FeatureSelector) Reset()

func (*FeatureSelector) String

func (x *FeatureSelector) String() string

type FeatureStatsAnomaly

type FeatureStatsAnomaly struct {

	// Feature importance score, only populated when cross-feature monitoring is
	// enabled. For now only used to represent feature attribution score within
	// range [0, 1] for
	// [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW][google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW]
	// and
	// [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT][google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT].
	Score float64 `protobuf:"fixed64,1,opt,name=score,proto3" json:"score,omitempty"`
	// Path of the stats file for current feature values in Cloud Storage bucket.
	// Format: gs://<bucket_name>/<object_name>/stats.
	// Example: gs://monitoring_bucket/feature_name/stats.
	// Stats are stored as binary format with Protobuf message
	// [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).
	StatsUri string `protobuf:"bytes,3,opt,name=stats_uri,json=statsUri,proto3" json:"stats_uri,omitempty"`
	// Path of the anomaly file for current feature values in Cloud Storage
	// bucket.
	// Format: gs://<bucket_name>/<object_name>/anomalies.
	// Example: gs://monitoring_bucket/feature_name/anomalies.
	// Stats are stored as binary format with Protobuf message
	// Anoamlies are stored as binary format with Protobuf message
	// [tensorflow.metadata.v0.AnomalyInfo]
	// (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto).
	AnomalyUri string `protobuf:"bytes,4,opt,name=anomaly_uri,json=anomalyUri,proto3" json:"anomaly_uri,omitempty"`
	// Deviation from the current stats to baseline stats.
	//  1. For categorical feature, the distribution distance is calculated by
	//     L-inifinity norm.
	//  2. For numerical feature, the distribution distance is calculated by
	//     Jensen–Shannon divergence.
	DistributionDeviation float64 `` /* 126-byte string literal not displayed */
	// This is the threshold used when detecting anomalies.
	// The threshold can be changed by user, so this one might be different from
	// [ThresholdConfig.value][google.cloud.aiplatform.v1.ThresholdConfig.value].
	AnomalyDetectionThreshold float64 `` /* 140-byte string literal not displayed */
	// The start timestamp of window where stats were generated.
	// For objectives where time window doesn't make sense (e.g. Featurestore
	// Snapshot Monitoring), start_time is only used to indicate the monitoring
	// intervals, so it always equals to (end_time - monitoring_interval).
	StartTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The end timestamp of window where stats were generated.
	// For objectives where time window doesn't make sense (e.g. Featurestore
	// Snapshot Monitoring), end_time indicates the timestamp of the data used to
	// generate stats (e.g. timestamp we take snapshots for feature values).
	EndTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Stats and Anomaly generated at specific timestamp for specific Feature. The start_time and end_time are used to define the time range of the dataset that current stats belongs to, e.g. prediction traffic is bucketed into prediction datasets by time window. If the Dataset is not defined by time window, start_time = end_time. Timestamp of the stats and anomalies always refers to end_time. Raw stats and anomalies are stored in stats_uri or anomaly_uri in the tensorflow defined protos. Field data_stats contains almost identical information with the raw stats in Vertex AI defined proto, for UI to display.

func (*FeatureStatsAnomaly) Descriptor deprecated

func (*FeatureStatsAnomaly) Descriptor() ([]byte, []int)

Deprecated: Use FeatureStatsAnomaly.ProtoReflect.Descriptor instead.

func (*FeatureStatsAnomaly) GetAnomalyDetectionThreshold

func (x *FeatureStatsAnomaly) GetAnomalyDetectionThreshold() float64

func (*FeatureStatsAnomaly) GetAnomalyUri

func (x *FeatureStatsAnomaly) GetAnomalyUri() string

func (*FeatureStatsAnomaly) GetDistributionDeviation

func (x *FeatureStatsAnomaly) GetDistributionDeviation() float64

func (*FeatureStatsAnomaly) GetEndTime

func (x *FeatureStatsAnomaly) GetEndTime() *timestamppb.Timestamp

func (*FeatureStatsAnomaly) GetScore

func (x *FeatureStatsAnomaly) GetScore() float64

func (*FeatureStatsAnomaly) GetStartTime

func (x *FeatureStatsAnomaly) GetStartTime() *timestamppb.Timestamp

func (*FeatureStatsAnomaly) GetStatsUri

func (x *FeatureStatsAnomaly) GetStatsUri() string

func (*FeatureStatsAnomaly) ProtoMessage

func (*FeatureStatsAnomaly) ProtoMessage()

func (*FeatureStatsAnomaly) ProtoReflect

func (x *FeatureStatsAnomaly) ProtoReflect() protoreflect.Message

func (*FeatureStatsAnomaly) Reset

func (x *FeatureStatsAnomaly) Reset()

func (*FeatureStatsAnomaly) String

func (x *FeatureStatsAnomaly) String() string

type FeatureValue

type FeatureValue struct {

	// Value for the feature.
	//
	// Types that are assignable to Value:
	//
	//	*FeatureValue_BoolValue
	//	*FeatureValue_DoubleValue
	//	*FeatureValue_Int64Value
	//	*FeatureValue_StringValue
	//	*FeatureValue_BoolArrayValue
	//	*FeatureValue_DoubleArrayValue
	//	*FeatureValue_Int64ArrayValue
	//	*FeatureValue_StringArrayValue
	//	*FeatureValue_BytesValue
	Value isFeatureValue_Value `protobuf_oneof:"value"`
	// Metadata of feature value.
	Metadata *FeatureValue_Metadata `protobuf:"bytes,14,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

Value for a feature.

func (*FeatureValue) Descriptor deprecated

func (*FeatureValue) Descriptor() ([]byte, []int)

Deprecated: Use FeatureValue.ProtoReflect.Descriptor instead.

func (*FeatureValue) GetBoolArrayValue

func (x *FeatureValue) GetBoolArrayValue() *BoolArray

func (*FeatureValue) GetBoolValue

func (x *FeatureValue) GetBoolValue() bool

func (*FeatureValue) GetBytesValue

func (x *FeatureValue) GetBytesValue() []byte

func (*FeatureValue) GetDoubleArrayValue

func (x *FeatureValue) GetDoubleArrayValue() *DoubleArray

func (*FeatureValue) GetDoubleValue

func (x *FeatureValue) GetDoubleValue() float64

func (*FeatureValue) GetInt64ArrayValue

func (x *FeatureValue) GetInt64ArrayValue() *Int64Array

func (*FeatureValue) GetInt64Value

func (x *FeatureValue) GetInt64Value() int64

func (*FeatureValue) GetMetadata

func (x *FeatureValue) GetMetadata() *FeatureValue_Metadata

func (*FeatureValue) GetStringArrayValue

func (x *FeatureValue) GetStringArrayValue() *StringArray

func (*FeatureValue) GetStringValue

func (x *FeatureValue) GetStringValue() string

func (*FeatureValue) GetValue

func (m *FeatureValue) GetValue() isFeatureValue_Value

func (*FeatureValue) ProtoMessage

func (*FeatureValue) ProtoMessage()

func (*FeatureValue) ProtoReflect

func (x *FeatureValue) ProtoReflect() protoreflect.Message

func (*FeatureValue) Reset

func (x *FeatureValue) Reset()

func (*FeatureValue) String

func (x *FeatureValue) String() string

type FeatureValueDestination

type FeatureValueDestination struct {

	// Types that are assignable to Destination:
	//
	//	*FeatureValueDestination_BigqueryDestination
	//	*FeatureValueDestination_TfrecordDestination
	//	*FeatureValueDestination_CsvDestination
	Destination isFeatureValueDestination_Destination `protobuf_oneof:"destination"`
	// contains filtered or unexported fields
}

A destination location for Feature values and format.

func (*FeatureValueDestination) Descriptor deprecated

func (*FeatureValueDestination) Descriptor() ([]byte, []int)

Deprecated: Use FeatureValueDestination.ProtoReflect.Descriptor instead.

func (*FeatureValueDestination) GetBigqueryDestination

func (x *FeatureValueDestination) GetBigqueryDestination() *BigQueryDestination

func (*FeatureValueDestination) GetCsvDestination

func (x *FeatureValueDestination) GetCsvDestination() *CsvDestination

func (*FeatureValueDestination) GetDestination

func (m *FeatureValueDestination) GetDestination() isFeatureValueDestination_Destination

func (*FeatureValueDestination) GetTfrecordDestination

func (x *FeatureValueDestination) GetTfrecordDestination() *TFRecordDestination

func (*FeatureValueDestination) ProtoMessage

func (*FeatureValueDestination) ProtoMessage()

func (*FeatureValueDestination) ProtoReflect

func (x *FeatureValueDestination) ProtoReflect() protoreflect.Message

func (*FeatureValueDestination) Reset

func (x *FeatureValueDestination) Reset()

func (*FeatureValueDestination) String

func (x *FeatureValueDestination) String() string

type FeatureValueDestination_BigqueryDestination

type FeatureValueDestination_BigqueryDestination struct {
	// Output in BigQuery format.
	// [BigQueryDestination.output_uri][google.cloud.aiplatform.v1.BigQueryDestination.output_uri]
	// in
	// [FeatureValueDestination.bigquery_destination][google.cloud.aiplatform.v1.FeatureValueDestination.bigquery_destination]
	// must refer to a table.
	BigqueryDestination *BigQueryDestination `protobuf:"bytes,1,opt,name=bigquery_destination,json=bigqueryDestination,proto3,oneof"`
}

type FeatureValueDestination_CsvDestination

type FeatureValueDestination_CsvDestination struct {
	// Output in CSV format. Array Feature value types are not allowed in CSV
	// format.
	CsvDestination *CsvDestination `protobuf:"bytes,3,opt,name=csv_destination,json=csvDestination,proto3,oneof"`
}

type FeatureValueDestination_TfrecordDestination

type FeatureValueDestination_TfrecordDestination struct {
	// Output in TFRecord format.
	//
	// Below are the mapping from Feature value type
	// in Featurestore to Feature value type in TFRecord:
	//
	//	Value type in Featurestore                 | Value type in TFRecord
	//	DOUBLE, DOUBLE_ARRAY                       | FLOAT_LIST
	//	INT64, INT64_ARRAY                         | INT64_LIST
	//	STRING, STRING_ARRAY, BYTES                | BYTES_LIST
	//	true -> byte_string("true"), false -> byte_string("false")
	//	BOOL, BOOL_ARRAY (true, false)             | BYTES_LIST
	TfrecordDestination *TFRecordDestination `protobuf:"bytes,2,opt,name=tfrecord_destination,json=tfrecordDestination,proto3,oneof"`
}

type FeatureValueList

type FeatureValueList struct {

	// A list of feature values. All of them should be the same data type.
	Values []*FeatureValue `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

Container for list of values.

func (*FeatureValueList) Descriptor deprecated

func (*FeatureValueList) Descriptor() ([]byte, []int)

Deprecated: Use FeatureValueList.ProtoReflect.Descriptor instead.

func (*FeatureValueList) GetValues

func (x *FeatureValueList) GetValues() []*FeatureValue

func (*FeatureValueList) ProtoMessage

func (*FeatureValueList) ProtoMessage()

func (*FeatureValueList) ProtoReflect

func (x *FeatureValueList) ProtoReflect() protoreflect.Message

func (*FeatureValueList) Reset

func (x *FeatureValueList) Reset()

func (*FeatureValueList) String

func (x *FeatureValueList) String() string

type FeatureValue_BoolArrayValue

type FeatureValue_BoolArrayValue struct {
	// A list of bool type feature value.
	BoolArrayValue *BoolArray `protobuf:"bytes,7,opt,name=bool_array_value,json=boolArrayValue,proto3,oneof"`
}

type FeatureValue_BoolValue

type FeatureValue_BoolValue struct {
	// Bool type feature value.
	BoolValue bool `protobuf:"varint,1,opt,name=bool_value,json=boolValue,proto3,oneof"`
}

type FeatureValue_BytesValue

type FeatureValue_BytesValue struct {
	// Bytes feature value.
	BytesValue []byte `protobuf:"bytes,13,opt,name=bytes_value,json=bytesValue,proto3,oneof"`
}

type FeatureValue_DoubleArrayValue

type FeatureValue_DoubleArrayValue struct {
	// A list of double type feature value.
	DoubleArrayValue *DoubleArray `protobuf:"bytes,8,opt,name=double_array_value,json=doubleArrayValue,proto3,oneof"`
}

type FeatureValue_DoubleValue

type FeatureValue_DoubleValue struct {
	// Double type feature value.
	DoubleValue float64 `protobuf:"fixed64,2,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type FeatureValue_Int64ArrayValue

type FeatureValue_Int64ArrayValue struct {
	// A list of int64 type feature value.
	Int64ArrayValue *Int64Array `protobuf:"bytes,11,opt,name=int64_array_value,json=int64ArrayValue,proto3,oneof"`
}

type FeatureValue_Int64Value

type FeatureValue_Int64Value struct {
	// Int64 feature value.
	Int64Value int64 `protobuf:"varint,5,opt,name=int64_value,json=int64Value,proto3,oneof"`
}

type FeatureValue_Metadata

type FeatureValue_Metadata struct {

	// Feature generation timestamp. Typically, it is provided by user at
	// feature ingestion time. If not, feature store
	// will use the system timestamp when the data is ingested into feature
	// store. For streaming ingestion, the time, aligned by days, must be no
	// older than five years (1825 days) and no later than one year (366 days)
	// in the future.
	GenerateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=generate_time,json=generateTime,proto3" json:"generate_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata of feature value.

func (*FeatureValue_Metadata) Descriptor deprecated

func (*FeatureValue_Metadata) Descriptor() ([]byte, []int)

Deprecated: Use FeatureValue_Metadata.ProtoReflect.Descriptor instead.

func (*FeatureValue_Metadata) GetGenerateTime

func (x *FeatureValue_Metadata) GetGenerateTime() *timestamppb.Timestamp

func (*FeatureValue_Metadata) ProtoMessage

func (*FeatureValue_Metadata) ProtoMessage()

func (*FeatureValue_Metadata) ProtoReflect

func (x *FeatureValue_Metadata) ProtoReflect() protoreflect.Message

func (*FeatureValue_Metadata) Reset

func (x *FeatureValue_Metadata) Reset()

func (*FeatureValue_Metadata) String

func (x *FeatureValue_Metadata) String() string

type FeatureValue_StringArrayValue

type FeatureValue_StringArrayValue struct {
	// A list of string type feature value.
	StringArrayValue *StringArray `protobuf:"bytes,12,opt,name=string_array_value,json=stringArrayValue,proto3,oneof"`
}

type FeatureValue_StringValue

type FeatureValue_StringValue struct {
	// String feature value.
	StringValue string `protobuf:"bytes,6,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type FeatureView added in v1.54.0

type FeatureView struct {

	// Types that are assignable to Source:
	//
	//	*FeatureView_BigQuerySource_
	//	*FeatureView_FeatureRegistrySource_
	Source isFeatureView_Source `protobuf_oneof:"source"`
	// Identifier. Name of the FeatureView. Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Timestamp when this FeatureView was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this FeatureView was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. Used to perform consistent read-modify-write updates. If not set,
	// a blind "overwrite" update happens.
	Etag string `protobuf:"bytes,4,opt,name=etag,proto3" json:"etag,omitempty"`
	// Optional. The labels with user-defined metadata to organize your
	// FeatureViews.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information on and examples of labels.
	// No more than 64 user labels can be associated with one
	// FeatureOnlineStore(System labels are excluded)." System reserved label keys
	// are prefixed with "aiplatform.googleapis.com/" and are immutable.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Configures when data is to be synced/updated for this FeatureView. At the
	// end of the sync the latest featureValues for each entityId of this
	// FeatureView are made ready for online serving.
	SyncConfig *FeatureView_SyncConfig `protobuf:"bytes,7,opt,name=sync_config,json=syncConfig,proto3" json:"sync_config,omitempty"`
	// Optional. Configuration for index preparation for vector search. It
	// contains the required configurations to create an index from source data,
	// so that approximate nearest neighbor (a.k.a ANN) algorithms search can be
	// performed during online serving.
	IndexConfig *FeatureView_IndexConfig `protobuf:"bytes,15,opt,name=index_config,json=indexConfig,proto3" json:"index_config,omitempty"`
	// contains filtered or unexported fields
}

FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.

func (*FeatureView) Descriptor deprecated added in v1.54.0

func (*FeatureView) Descriptor() ([]byte, []int)

Deprecated: Use FeatureView.ProtoReflect.Descriptor instead.

func (*FeatureView) GetBigQuerySource added in v1.54.0

func (x *FeatureView) GetBigQuerySource() *FeatureView_BigQuerySource

func (*FeatureView) GetCreateTime added in v1.54.0

func (x *FeatureView) GetCreateTime() *timestamppb.Timestamp

func (*FeatureView) GetEtag added in v1.54.0

func (x *FeatureView) GetEtag() string

func (*FeatureView) GetFeatureRegistrySource added in v1.54.0

func (x *FeatureView) GetFeatureRegistrySource() *FeatureView_FeatureRegistrySource

func (*FeatureView) GetIndexConfig added in v1.65.0

func (x *FeatureView) GetIndexConfig() *FeatureView_IndexConfig

func (*FeatureView) GetLabels added in v1.54.0

func (x *FeatureView) GetLabels() map[string]string

func (*FeatureView) GetName added in v1.54.0

func (x *FeatureView) GetName() string

func (*FeatureView) GetSource added in v1.54.0

func (m *FeatureView) GetSource() isFeatureView_Source

func (*FeatureView) GetSyncConfig added in v1.54.0

func (x *FeatureView) GetSyncConfig() *FeatureView_SyncConfig

func (*FeatureView) GetUpdateTime added in v1.54.0

func (x *FeatureView) GetUpdateTime() *timestamppb.Timestamp

func (*FeatureView) ProtoMessage added in v1.54.0

func (*FeatureView) ProtoMessage()

func (*FeatureView) ProtoReflect added in v1.54.0

func (x *FeatureView) ProtoReflect() protoreflect.Message

func (*FeatureView) Reset added in v1.54.0

func (x *FeatureView) Reset()

func (*FeatureView) String added in v1.54.0

func (x *FeatureView) String() string

type FeatureViewDataFormat added in v1.54.0

type FeatureViewDataFormat int32

Format of the data in the Feature View.

const (
	// Not set. Will be treated as the KeyValue format.
	FeatureViewDataFormat_FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED FeatureViewDataFormat = 0
	// Return response data in key-value format.
	FeatureViewDataFormat_KEY_VALUE FeatureViewDataFormat = 1
	// Return response data in proto Struct format.
	FeatureViewDataFormat_PROTO_STRUCT FeatureViewDataFormat = 2
)

func (FeatureViewDataFormat) Descriptor added in v1.54.0

func (FeatureViewDataFormat) Enum added in v1.54.0

func (FeatureViewDataFormat) EnumDescriptor deprecated added in v1.54.0

func (FeatureViewDataFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use FeatureViewDataFormat.Descriptor instead.

func (FeatureViewDataFormat) Number added in v1.54.0

func (FeatureViewDataFormat) String added in v1.54.0

func (x FeatureViewDataFormat) String() string

func (FeatureViewDataFormat) Type added in v1.54.0

type FeatureViewDataKey added in v1.54.0

type FeatureViewDataKey struct {

	// Types that are assignable to KeyOneof:
	//
	//	*FeatureViewDataKey_Key
	//	*FeatureViewDataKey_CompositeKey_
	KeyOneof isFeatureViewDataKey_KeyOneof `protobuf_oneof:"key_oneof"`
	// contains filtered or unexported fields
}

Lookup key for a feature view.

func (*FeatureViewDataKey) Descriptor deprecated added in v1.54.0

func (*FeatureViewDataKey) Descriptor() ([]byte, []int)

Deprecated: Use FeatureViewDataKey.ProtoReflect.Descriptor instead.

func (*FeatureViewDataKey) GetCompositeKey added in v1.62.0

func (*FeatureViewDataKey) GetKey added in v1.54.0

func (x *FeatureViewDataKey) GetKey() string

func (*FeatureViewDataKey) GetKeyOneof added in v1.54.0

func (m *FeatureViewDataKey) GetKeyOneof() isFeatureViewDataKey_KeyOneof

func (*FeatureViewDataKey) ProtoMessage added in v1.54.0

func (*FeatureViewDataKey) ProtoMessage()

func (*FeatureViewDataKey) ProtoReflect added in v1.54.0

func (x *FeatureViewDataKey) ProtoReflect() protoreflect.Message

func (*FeatureViewDataKey) Reset added in v1.54.0

func (x *FeatureViewDataKey) Reset()

func (*FeatureViewDataKey) String added in v1.54.0

func (x *FeatureViewDataKey) String() string

type FeatureViewDataKey_CompositeKey added in v1.62.0

type FeatureViewDataKey_CompositeKey struct {

	// Parts to construct Entity ID. Should match with the same ID columns as
	// defined in FeatureView in the same order.
	Parts []string `protobuf:"bytes,1,rep,name=parts,proto3" json:"parts,omitempty"`
	// contains filtered or unexported fields
}

ID that is comprised from several parts (columns).

func (*FeatureViewDataKey_CompositeKey) Descriptor deprecated added in v1.62.0

func (*FeatureViewDataKey_CompositeKey) Descriptor() ([]byte, []int)

Deprecated: Use FeatureViewDataKey_CompositeKey.ProtoReflect.Descriptor instead.

func (*FeatureViewDataKey_CompositeKey) GetParts added in v1.62.0

func (x *FeatureViewDataKey_CompositeKey) GetParts() []string

func (*FeatureViewDataKey_CompositeKey) ProtoMessage added in v1.62.0

func (*FeatureViewDataKey_CompositeKey) ProtoMessage()

func (*FeatureViewDataKey_CompositeKey) ProtoReflect added in v1.62.0

func (*FeatureViewDataKey_CompositeKey) Reset added in v1.62.0

func (*FeatureViewDataKey_CompositeKey) String added in v1.62.0

type FeatureViewDataKey_CompositeKey_ added in v1.62.0

type FeatureViewDataKey_CompositeKey_ struct {
	// The actual Entity ID will be composed from this struct. This should match
	// with the way ID is defined in the FeatureView spec.
	CompositeKey *FeatureViewDataKey_CompositeKey `protobuf:"bytes,2,opt,name=composite_key,json=compositeKey,proto3,oneof"`
}

type FeatureViewDataKey_Key added in v1.54.0

type FeatureViewDataKey_Key struct {
	// String key to use for lookup.
	Key string `protobuf:"bytes,1,opt,name=key,proto3,oneof"`
}

type FeatureViewSync added in v1.54.0

type FeatureViewSync struct {

	// Identifier. Name of the FeatureViewSync. Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Time when this FeatureViewSync is created. Creation of a
	// FeatureViewSync means that the job is pending / waiting for sufficient
	// resources but may not have started the actual data transfer yet.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Time when this FeatureViewSync is finished.
	RunTime *interval.Interval `protobuf:"bytes,5,opt,name=run_time,json=runTime,proto3" json:"run_time,omitempty"`
	// Output only. Final status of the FeatureViewSync.
	FinalStatus *status.Status `protobuf:"bytes,4,opt,name=final_status,json=finalStatus,proto3" json:"final_status,omitempty"`
	// Output only. Summary of the sync job.
	SyncSummary *FeatureViewSync_SyncSummary `protobuf:"bytes,6,opt,name=sync_summary,json=syncSummary,proto3" json:"sync_summary,omitempty"`
	// contains filtered or unexported fields
}

FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store.

func (*FeatureViewSync) Descriptor deprecated added in v1.54.0

func (*FeatureViewSync) Descriptor() ([]byte, []int)

Deprecated: Use FeatureViewSync.ProtoReflect.Descriptor instead.

func (*FeatureViewSync) GetCreateTime added in v1.54.0

func (x *FeatureViewSync) GetCreateTime() *timestamppb.Timestamp

func (*FeatureViewSync) GetFinalStatus added in v1.54.0

func (x *FeatureViewSync) GetFinalStatus() *status.Status

func (*FeatureViewSync) GetName added in v1.54.0

func (x *FeatureViewSync) GetName() string

func (*FeatureViewSync) GetRunTime added in v1.54.0

func (x *FeatureViewSync) GetRunTime() *interval.Interval

func (*FeatureViewSync) GetSyncSummary added in v1.63.0

func (x *FeatureViewSync) GetSyncSummary() *FeatureViewSync_SyncSummary

func (*FeatureViewSync) ProtoMessage added in v1.54.0

func (*FeatureViewSync) ProtoMessage()

func (*FeatureViewSync) ProtoReflect added in v1.54.0

func (x *FeatureViewSync) ProtoReflect() protoreflect.Message

func (*FeatureViewSync) Reset added in v1.54.0

func (x *FeatureViewSync) Reset()

func (*FeatureViewSync) String added in v1.54.0

func (x *FeatureViewSync) String() string

type FeatureViewSync_SyncSummary added in v1.63.0

type FeatureViewSync_SyncSummary struct {

	// Output only. Total number of rows synced.
	RowSynced int64 `protobuf:"varint,1,opt,name=row_synced,json=rowSynced,proto3" json:"row_synced,omitempty"`
	// Output only. BigQuery slot milliseconds consumed for the sync job.
	TotalSlot int64 `protobuf:"varint,2,opt,name=total_slot,json=totalSlot,proto3" json:"total_slot,omitempty"`
	// contains filtered or unexported fields
}

Summary from the Sync job. For continuous syncs, the summary is updated periodically. For batch syncs, it gets updated on completion of the sync.

func (*FeatureViewSync_SyncSummary) Descriptor deprecated added in v1.63.0

func (*FeatureViewSync_SyncSummary) Descriptor() ([]byte, []int)

Deprecated: Use FeatureViewSync_SyncSummary.ProtoReflect.Descriptor instead.

func (*FeatureViewSync_SyncSummary) GetRowSynced added in v1.63.0

func (x *FeatureViewSync_SyncSummary) GetRowSynced() int64

func (*FeatureViewSync_SyncSummary) GetTotalSlot added in v1.63.0

func (x *FeatureViewSync_SyncSummary) GetTotalSlot() int64

func (*FeatureViewSync_SyncSummary) ProtoMessage added in v1.63.0

func (*FeatureViewSync_SyncSummary) ProtoMessage()

func (*FeatureViewSync_SyncSummary) ProtoReflect added in v1.63.0

func (*FeatureViewSync_SyncSummary) Reset added in v1.63.0

func (x *FeatureViewSync_SyncSummary) Reset()

func (*FeatureViewSync_SyncSummary) String added in v1.63.0

func (x *FeatureViewSync_SyncSummary) String() string

type FeatureView_BigQuerySource added in v1.54.0

type FeatureView_BigQuerySource struct {

	// Required. The BigQuery view URI that will be materialized on each sync
	// trigger based on FeatureView.SyncConfig.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Required. Columns to construct entity_id / row keys.
	EntityIdColumns []string `protobuf:"bytes,2,rep,name=entity_id_columns,json=entityIdColumns,proto3" json:"entity_id_columns,omitempty"`
	// contains filtered or unexported fields
}

func (*FeatureView_BigQuerySource) Descriptor deprecated added in v1.54.0

func (*FeatureView_BigQuerySource) Descriptor() ([]byte, []int)

Deprecated: Use FeatureView_BigQuerySource.ProtoReflect.Descriptor instead.

func (*FeatureView_BigQuerySource) GetEntityIdColumns added in v1.54.0

func (x *FeatureView_BigQuerySource) GetEntityIdColumns() []string

func (*FeatureView_BigQuerySource) GetUri added in v1.54.0

func (x *FeatureView_BigQuerySource) GetUri() string

func (*FeatureView_BigQuerySource) ProtoMessage added in v1.54.0

func (*FeatureView_BigQuerySource) ProtoMessage()

func (*FeatureView_BigQuerySource) ProtoReflect added in v1.54.0

func (*FeatureView_BigQuerySource) Reset added in v1.54.0

func (x *FeatureView_BigQuerySource) Reset()

func (*FeatureView_BigQuerySource) String added in v1.54.0

func (x *FeatureView_BigQuerySource) String() string

type FeatureView_BigQuerySource_ added in v1.54.0

type FeatureView_BigQuerySource_ struct {
	// Optional. Configures how data is supposed to be extracted from a BigQuery
	// source to be loaded onto the FeatureOnlineStore.
	BigQuerySource *FeatureView_BigQuerySource `protobuf:"bytes,6,opt,name=big_query_source,json=bigQuerySource,proto3,oneof"`
}

type FeatureView_FeatureRegistrySource added in v1.54.0

type FeatureView_FeatureRegistrySource struct {

	// Required. List of features that need to be synced to Online Store.
	FeatureGroups []*FeatureView_FeatureRegistrySource_FeatureGroup `protobuf:"bytes,1,rep,name=feature_groups,json=featureGroups,proto3" json:"feature_groups,omitempty"`
	// Optional. The project number of the parent project of the Feature Groups.
	ProjectNumber *int64 `protobuf:"varint,2,opt,name=project_number,json=projectNumber,proto3,oneof" json:"project_number,omitempty"`
	// contains filtered or unexported fields
}

A Feature Registry source for features that need to be synced to Online Store.

func (*FeatureView_FeatureRegistrySource) Descriptor deprecated added in v1.54.0

func (*FeatureView_FeatureRegistrySource) Descriptor() ([]byte, []int)

Deprecated: Use FeatureView_FeatureRegistrySource.ProtoReflect.Descriptor instead.

func (*FeatureView_FeatureRegistrySource) GetFeatureGroups added in v1.54.0

func (*FeatureView_FeatureRegistrySource) GetProjectNumber added in v1.63.0

func (x *FeatureView_FeatureRegistrySource) GetProjectNumber() int64

func (*FeatureView_FeatureRegistrySource) ProtoMessage added in v1.54.0

func (*FeatureView_FeatureRegistrySource) ProtoMessage()

func (*FeatureView_FeatureRegistrySource) ProtoReflect added in v1.54.0

func (*FeatureView_FeatureRegistrySource) Reset added in v1.54.0

func (*FeatureView_FeatureRegistrySource) String added in v1.54.0

type FeatureView_FeatureRegistrySource_ added in v1.54.0

type FeatureView_FeatureRegistrySource_ struct {
	// Optional. Configures the features from a Feature Registry source that
	// need to be loaded onto the FeatureOnlineStore.
	FeatureRegistrySource *FeatureView_FeatureRegistrySource `protobuf:"bytes,9,opt,name=feature_registry_source,json=featureRegistrySource,proto3,oneof"`
}

type FeatureView_FeatureRegistrySource_FeatureGroup added in v1.54.0

type FeatureView_FeatureRegistrySource_FeatureGroup struct {

	// Required. Identifier of the feature group.
	FeatureGroupId string `protobuf:"bytes,1,opt,name=feature_group_id,json=featureGroupId,proto3" json:"feature_group_id,omitempty"`
	// Required. Identifiers of features under the feature group.
	FeatureIds []string `protobuf:"bytes,2,rep,name=feature_ids,json=featureIds,proto3" json:"feature_ids,omitempty"`
	// contains filtered or unexported fields
}

Features belonging to a single feature group that will be synced to Online Store.

func (*FeatureView_FeatureRegistrySource_FeatureGroup) Descriptor deprecated added in v1.54.0

Deprecated: Use FeatureView_FeatureRegistrySource_FeatureGroup.ProtoReflect.Descriptor instead.

func (*FeatureView_FeatureRegistrySource_FeatureGroup) GetFeatureGroupId added in v1.54.0

func (*FeatureView_FeatureRegistrySource_FeatureGroup) GetFeatureIds added in v1.54.0

func (*FeatureView_FeatureRegistrySource_FeatureGroup) ProtoMessage added in v1.54.0

func (*FeatureView_FeatureRegistrySource_FeatureGroup) ProtoReflect added in v1.54.0

func (*FeatureView_FeatureRegistrySource_FeatureGroup) Reset added in v1.54.0

func (*FeatureView_FeatureRegistrySource_FeatureGroup) String added in v1.54.0

type FeatureView_IndexConfig added in v1.65.0

type FeatureView_IndexConfig struct {

	// The configuration with regard to the algorithms used for efficient
	// search.
	//
	// Types that are assignable to AlgorithmConfig:
	//
	//	*FeatureView_IndexConfig_TreeAhConfig
	//	*FeatureView_IndexConfig_BruteForceConfig_
	AlgorithmConfig isFeatureView_IndexConfig_AlgorithmConfig `protobuf_oneof:"algorithm_config"`
	// Optional. Column of embedding. This column contains the source data to
	// create index for vector search. embedding_column must be set when using
	// vector search.
	EmbeddingColumn string `protobuf:"bytes,1,opt,name=embedding_column,json=embeddingColumn,proto3" json:"embedding_column,omitempty"`
	// Optional. Columns of features that're used to filter vector search
	// results.
	FilterColumns []string `protobuf:"bytes,2,rep,name=filter_columns,json=filterColumns,proto3" json:"filter_columns,omitempty"`
	// Optional. Column of crowding. This column contains crowding attribute
	// which is a constraint on a neighbor list produced by
	// [FeatureOnlineStoreService.SearchNearestEntities][google.cloud.aiplatform.v1.FeatureOnlineStoreService.SearchNearestEntities]
	// to diversify search results. If
	// [NearestNeighborQuery.per_crowding_attribute_neighbor_count][google.cloud.aiplatform.v1.NearestNeighborQuery.per_crowding_attribute_neighbor_count]
	// is set to K in
	// [SearchNearestEntitiesRequest][google.cloud.aiplatform.v1.SearchNearestEntitiesRequest],
	// it's guaranteed that no more than K entities of the same crowding
	// attribute are returned in the response.
	CrowdingColumn string `protobuf:"bytes,3,opt,name=crowding_column,json=crowdingColumn,proto3" json:"crowding_column,omitempty"`
	// Optional. The number of dimensions of the input embedding.
	EmbeddingDimension *int32 `protobuf:"varint,4,opt,name=embedding_dimension,json=embeddingDimension,proto3,oneof" json:"embedding_dimension,omitempty"`
	// Optional. The distance measure used in nearest neighbor search.
	DistanceMeasureType FeatureView_IndexConfig_DistanceMeasureType `` /* 197-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration for vector indexing.

func (*FeatureView_IndexConfig) Descriptor deprecated added in v1.65.0

func (*FeatureView_IndexConfig) Descriptor() ([]byte, []int)

Deprecated: Use FeatureView_IndexConfig.ProtoReflect.Descriptor instead.

func (*FeatureView_IndexConfig) GetAlgorithmConfig added in v1.65.0

func (m *FeatureView_IndexConfig) GetAlgorithmConfig() isFeatureView_IndexConfig_AlgorithmConfig

func (*FeatureView_IndexConfig) GetBruteForceConfig added in v1.65.0

func (*FeatureView_IndexConfig) GetCrowdingColumn added in v1.65.0

func (x *FeatureView_IndexConfig) GetCrowdingColumn() string

func (*FeatureView_IndexConfig) GetDistanceMeasureType added in v1.65.0

func (*FeatureView_IndexConfig) GetEmbeddingColumn added in v1.65.0

func (x *FeatureView_IndexConfig) GetEmbeddingColumn() string

func (*FeatureView_IndexConfig) GetEmbeddingDimension added in v1.65.0

func (x *FeatureView_IndexConfig) GetEmbeddingDimension() int32

func (*FeatureView_IndexConfig) GetFilterColumns added in v1.65.0

func (x *FeatureView_IndexConfig) GetFilterColumns() []string

func (*FeatureView_IndexConfig) GetTreeAhConfig added in v1.65.0

func (*FeatureView_IndexConfig) ProtoMessage added in v1.65.0

func (*FeatureView_IndexConfig) ProtoMessage()

func (*FeatureView_IndexConfig) ProtoReflect added in v1.65.0

func (x *FeatureView_IndexConfig) ProtoReflect() protoreflect.Message

func (*FeatureView_IndexConfig) Reset added in v1.65.0

func (x *FeatureView_IndexConfig) Reset()

func (*FeatureView_IndexConfig) String added in v1.65.0

func (x *FeatureView_IndexConfig) String() string

type FeatureView_IndexConfig_BruteForceConfig added in v1.65.0

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

Configuration options for using brute force search.

func (*FeatureView_IndexConfig_BruteForceConfig) Descriptor deprecated added in v1.65.0

func (*FeatureView_IndexConfig_BruteForceConfig) Descriptor() ([]byte, []int)

Deprecated: Use FeatureView_IndexConfig_BruteForceConfig.ProtoReflect.Descriptor instead.

func (*FeatureView_IndexConfig_BruteForceConfig) ProtoMessage added in v1.65.0

func (*FeatureView_IndexConfig_BruteForceConfig) ProtoReflect added in v1.65.0

func (*FeatureView_IndexConfig_BruteForceConfig) Reset added in v1.65.0

func (*FeatureView_IndexConfig_BruteForceConfig) String added in v1.65.0

type FeatureView_IndexConfig_BruteForceConfig_ added in v1.65.0

type FeatureView_IndexConfig_BruteForceConfig_ struct {
	// Optional. Configuration options for using brute force search, which
	// simply implements the standard linear search in the database for each
	// query. It is primarily meant for benchmarking and to generate the
	// ground truth for approximate search.
	BruteForceConfig *FeatureView_IndexConfig_BruteForceConfig `protobuf:"bytes,7,opt,name=brute_force_config,json=bruteForceConfig,proto3,oneof"`
}

type FeatureView_IndexConfig_DistanceMeasureType added in v1.65.0

type FeatureView_IndexConfig_DistanceMeasureType int32

The distance measure used in nearest neighbor search.

const (
	// Should not be set.
	FeatureView_IndexConfig_DISTANCE_MEASURE_TYPE_UNSPECIFIED FeatureView_IndexConfig_DistanceMeasureType = 0
	// Euclidean (L_2) Distance.
	FeatureView_IndexConfig_SQUARED_L2_DISTANCE FeatureView_IndexConfig_DistanceMeasureType = 1
	// Cosine Distance. Defined as 1 - cosine similarity.
	//
	// We strongly suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead
	// of COSINE distance. Our algorithms have been more optimized for
	// DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is
	// mathematically equivalent to COSINE distance and results in the same
	// ranking.
	FeatureView_IndexConfig_COSINE_DISTANCE FeatureView_IndexConfig_DistanceMeasureType = 2
	// Dot Product Distance. Defined as a negative of the dot product.
	FeatureView_IndexConfig_DOT_PRODUCT_DISTANCE FeatureView_IndexConfig_DistanceMeasureType = 3
)

func (FeatureView_IndexConfig_DistanceMeasureType) Descriptor added in v1.65.0

func (FeatureView_IndexConfig_DistanceMeasureType) Enum added in v1.65.0

func (FeatureView_IndexConfig_DistanceMeasureType) EnumDescriptor deprecated added in v1.65.0

func (FeatureView_IndexConfig_DistanceMeasureType) EnumDescriptor() ([]byte, []int)

Deprecated: Use FeatureView_IndexConfig_DistanceMeasureType.Descriptor instead.

func (FeatureView_IndexConfig_DistanceMeasureType) Number added in v1.65.0

func (FeatureView_IndexConfig_DistanceMeasureType) String added in v1.65.0

func (FeatureView_IndexConfig_DistanceMeasureType) Type added in v1.65.0

type FeatureView_IndexConfig_TreeAHConfig added in v1.65.0

type FeatureView_IndexConfig_TreeAHConfig struct {

	// Optional. Number of embeddings on each leaf node. The default value is
	// 1000 if not set.
	LeafNodeEmbeddingCount *int64 `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration options for the tree-AH algorithm.

func (*FeatureView_IndexConfig_TreeAHConfig) Descriptor deprecated added in v1.65.0

func (*FeatureView_IndexConfig_TreeAHConfig) Descriptor() ([]byte, []int)

Deprecated: Use FeatureView_IndexConfig_TreeAHConfig.ProtoReflect.Descriptor instead.

func (*FeatureView_IndexConfig_TreeAHConfig) GetLeafNodeEmbeddingCount added in v1.65.0

func (x *FeatureView_IndexConfig_TreeAHConfig) GetLeafNodeEmbeddingCount() int64

func (*FeatureView_IndexConfig_TreeAHConfig) ProtoMessage added in v1.65.0

func (*FeatureView_IndexConfig_TreeAHConfig) ProtoMessage()

func (*FeatureView_IndexConfig_TreeAHConfig) ProtoReflect added in v1.65.0

func (*FeatureView_IndexConfig_TreeAHConfig) Reset added in v1.65.0

func (*FeatureView_IndexConfig_TreeAHConfig) String added in v1.65.0

type FeatureView_IndexConfig_TreeAhConfig added in v1.65.0

type FeatureView_IndexConfig_TreeAhConfig struct {
	// Optional. Configuration options for the tree-AH algorithm (Shallow tree
	// + Asymmetric Hashing). Please refer to this paper for more details:
	// https://arxiv.org/abs/1908.10396
	TreeAhConfig *FeatureView_IndexConfig_TreeAHConfig `protobuf:"bytes,6,opt,name=tree_ah_config,json=treeAhConfig,proto3,oneof"`
}

type FeatureView_SyncConfig added in v1.54.0

type FeatureView_SyncConfig struct {

	// Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled
	// runs. To explicitly set a timezone to the cron tab, apply a prefix in
	// the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}".
	// The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone
	// database. For example, "CRON_TZ=America/New_York 1 * * * *", or
	// "TZ=America/New_York 1 * * * *".
	Cron string `protobuf:"bytes,1,opt,name=cron,proto3" json:"cron,omitempty"`
	// contains filtered or unexported fields
}

Configuration for Sync. Only one option is set.

func (*FeatureView_SyncConfig) Descriptor deprecated added in v1.54.0

func (*FeatureView_SyncConfig) Descriptor() ([]byte, []int)

Deprecated: Use FeatureView_SyncConfig.ProtoReflect.Descriptor instead.

func (*FeatureView_SyncConfig) GetCron added in v1.54.0

func (x *FeatureView_SyncConfig) GetCron() string

func (*FeatureView_SyncConfig) ProtoMessage added in v1.54.0

func (*FeatureView_SyncConfig) ProtoMessage()

func (*FeatureView_SyncConfig) ProtoReflect added in v1.54.0

func (x *FeatureView_SyncConfig) ProtoReflect() protoreflect.Message

func (*FeatureView_SyncConfig) Reset added in v1.54.0

func (x *FeatureView_SyncConfig) Reset()

func (*FeatureView_SyncConfig) String added in v1.54.0

func (x *FeatureView_SyncConfig) String() string

type Feature_MonitoringStatsAnomaly

type Feature_MonitoringStatsAnomaly struct {

	// Output only. The objective for each stats.
	Objective Feature_MonitoringStatsAnomaly_Objective `` /* 145-byte string literal not displayed */
	// Output only. The stats and anomalies generated at specific timestamp.
	FeatureStatsAnomaly *FeatureStatsAnomaly `protobuf:"bytes,2,opt,name=feature_stats_anomaly,json=featureStatsAnomaly,proto3" json:"feature_stats_anomaly,omitempty"`
	// contains filtered or unexported fields
}

A list of historical [SnapshotAnalysis][google.cloud.aiplatform.v1.FeaturestoreMonitoringConfig.SnapshotAnalysis] or [ImportFeaturesAnalysis][google.cloud.aiplatform.v1.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis] stats requested by user, sorted by [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1.FeatureStatsAnomaly.start_time] descending.

func (*Feature_MonitoringStatsAnomaly) Descriptor deprecated

func (*Feature_MonitoringStatsAnomaly) Descriptor() ([]byte, []int)

Deprecated: Use Feature_MonitoringStatsAnomaly.ProtoReflect.Descriptor instead.

func (*Feature_MonitoringStatsAnomaly) GetFeatureStatsAnomaly

func (x *Feature_MonitoringStatsAnomaly) GetFeatureStatsAnomaly() *FeatureStatsAnomaly

func (*Feature_MonitoringStatsAnomaly) GetObjective

func (*Feature_MonitoringStatsAnomaly) ProtoMessage

func (*Feature_MonitoringStatsAnomaly) ProtoMessage()

func (*Feature_MonitoringStatsAnomaly) ProtoReflect

func (*Feature_MonitoringStatsAnomaly) Reset

func (x *Feature_MonitoringStatsAnomaly) Reset()

func (*Feature_MonitoringStatsAnomaly) String

type Feature_MonitoringStatsAnomaly_Objective

type Feature_MonitoringStatsAnomaly_Objective int32

If the objective in the request is both Import Feature Analysis and Snapshot Analysis, this objective could be one of them. Otherwise, this objective should be the same as the objective in the request.

const (
	// If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty.
	Feature_MonitoringStatsAnomaly_OBJECTIVE_UNSPECIFIED Feature_MonitoringStatsAnomaly_Objective = 0
	// Stats are generated by Import Feature Analysis.
	Feature_MonitoringStatsAnomaly_IMPORT_FEATURE_ANALYSIS Feature_MonitoringStatsAnomaly_Objective = 1
	// Stats are generated by Snapshot Analysis.
	Feature_MonitoringStatsAnomaly_SNAPSHOT_ANALYSIS Feature_MonitoringStatsAnomaly_Objective = 2
)

func (Feature_MonitoringStatsAnomaly_Objective) Descriptor

func (Feature_MonitoringStatsAnomaly_Objective) Enum

func (Feature_MonitoringStatsAnomaly_Objective) EnumDescriptor deprecated

func (Feature_MonitoringStatsAnomaly_Objective) EnumDescriptor() ([]byte, []int)

Deprecated: Use Feature_MonitoringStatsAnomaly_Objective.Descriptor instead.

func (Feature_MonitoringStatsAnomaly_Objective) Number

func (Feature_MonitoringStatsAnomaly_Objective) String

func (Feature_MonitoringStatsAnomaly_Objective) Type

type Feature_ValueType

type Feature_ValueType int32

Only applicable for Vertex AI Legacy Feature Store. An enum representing the value type of a feature.

const (
	// The value type is unspecified.
	Feature_VALUE_TYPE_UNSPECIFIED Feature_ValueType = 0
	// Used for Feature that is a boolean.
	Feature_BOOL Feature_ValueType = 1
	// Used for Feature that is a list of boolean.
	Feature_BOOL_ARRAY Feature_ValueType = 2
	// Used for Feature that is double.
	Feature_DOUBLE Feature_ValueType = 3
	// Used for Feature that is a list of double.
	Feature_DOUBLE_ARRAY Feature_ValueType = 4
	// Used for Feature that is INT64.
	Feature_INT64 Feature_ValueType = 9
	// Used for Feature that is a list of INT64.
	Feature_INT64_ARRAY Feature_ValueType = 10
	// Used for Feature that is string.
	Feature_STRING Feature_ValueType = 11
	// Used for Feature that is a list of String.
	Feature_STRING_ARRAY Feature_ValueType = 12
	// Used for Feature that is bytes.
	Feature_BYTES Feature_ValueType = 13
)

func (Feature_ValueType) Descriptor

func (Feature_ValueType) Enum

func (Feature_ValueType) EnumDescriptor deprecated

func (Feature_ValueType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Feature_ValueType.Descriptor instead.

func (Feature_ValueType) Number

func (Feature_ValueType) String

func (x Feature_ValueType) String() string

func (Feature_ValueType) Type

type Featurestore

type Featurestore struct {

	// Output only. Name of the Featurestore. Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Timestamp when this Featurestore was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Featurestore was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. Used to perform consistent read-modify-write updates. If not set,
	// a blind "overwrite" update happens.
	Etag string `protobuf:"bytes,5,opt,name=etag,proto3" json:"etag,omitempty"`
	// Optional. The labels with user-defined metadata to organize your
	// Featurestore.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information on and examples of labels.
	// No more than 64 user labels can be associated with one Featurestore(System
	// labels are excluded)."
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Optional. Config for online storage resources. The field should not
	// co-exist with the field of `OnlineStoreReplicationConfig`. If both of it
	// and OnlineStoreReplicationConfig are unset, the feature store will not have
	// an online store and cannot be used for online serving.
	OnlineServingConfig *Featurestore_OnlineServingConfig `protobuf:"bytes,7,opt,name=online_serving_config,json=onlineServingConfig,proto3" json:"online_serving_config,omitempty"`
	// Output only. State of the featurestore.
	State Featurestore_State `protobuf:"varint,8,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.Featurestore_State" json:"state,omitempty"`
	// Optional. TTL in days for feature values that will be stored in online
	// serving storage. The Feature Store online storage periodically removes
	// obsolete feature values older than `online_storage_ttl_days` since the
	// feature generation time. Note that `online_storage_ttl_days` should be less
	// than or equal to `offline_storage_ttl_days` for each EntityType under a
	// featurestore. If not set, default to 4000 days
	OnlineStorageTtlDays int32 `` /* 127-byte string literal not displayed */
	// Optional. Customer-managed encryption key spec for data storage. If set,
	// both of the online and offline data storage will be secured by this key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,10,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// contains filtered or unexported fields
}

Vertex AI Feature Store provides a centralized repository for organizing, storing, and serving ML features. The Featurestore is a top-level container for your features and their values.

func (*Featurestore) Descriptor deprecated

func (*Featurestore) Descriptor() ([]byte, []int)

Deprecated: Use Featurestore.ProtoReflect.Descriptor instead.

func (*Featurestore) GetCreateTime

func (x *Featurestore) GetCreateTime() *timestamppb.Timestamp

func (*Featurestore) GetEncryptionSpec

func (x *Featurestore) GetEncryptionSpec() *EncryptionSpec

func (*Featurestore) GetEtag

func (x *Featurestore) GetEtag() string

func (*Featurestore) GetLabels

func (x *Featurestore) GetLabels() map[string]string

func (*Featurestore) GetName

func (x *Featurestore) GetName() string

func (*Featurestore) GetOnlineServingConfig

func (x *Featurestore) GetOnlineServingConfig() *Featurestore_OnlineServingConfig

func (*Featurestore) GetOnlineStorageTtlDays added in v1.40.0

func (x *Featurestore) GetOnlineStorageTtlDays() int32

func (*Featurestore) GetState

func (x *Featurestore) GetState() Featurestore_State

func (*Featurestore) GetUpdateTime

func (x *Featurestore) GetUpdateTime() *timestamppb.Timestamp

func (*Featurestore) ProtoMessage

func (*Featurestore) ProtoMessage()

func (*Featurestore) ProtoReflect

func (x *Featurestore) ProtoReflect() protoreflect.Message

func (*Featurestore) Reset

func (x *Featurestore) Reset()

func (*Featurestore) String

func (x *Featurestore) String() string

type FeaturestoreMonitoringConfig

type FeaturestoreMonitoringConfig struct {

	// The config for Snapshot Analysis Based Feature Monitoring.
	SnapshotAnalysis *FeaturestoreMonitoringConfig_SnapshotAnalysis `protobuf:"bytes,1,opt,name=snapshot_analysis,json=snapshotAnalysis,proto3" json:"snapshot_analysis,omitempty"`
	// The config for ImportFeatures Analysis Based Feature Monitoring.
	ImportFeaturesAnalysis *FeaturestoreMonitoringConfig_ImportFeaturesAnalysis `` /* 129-byte string literal not displayed */
	// Threshold for numerical features of anomaly detection.
	// This is shared by all objectives of Featurestore Monitoring for numerical
	// features (i.e. Features with type
	// ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) DOUBLE
	// or INT64).
	NumericalThresholdConfig *FeaturestoreMonitoringConfig_ThresholdConfig `` /* 135-byte string literal not displayed */
	// Threshold for categorical features of anomaly detection.
	// This is shared by all types of Featurestore Monitoring for categorical
	// features (i.e. Features with type
	// ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL or
	// STRING).
	CategoricalThresholdConfig *FeaturestoreMonitoringConfig_ThresholdConfig `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration of how features in Featurestore are monitored.

func (*FeaturestoreMonitoringConfig) Descriptor deprecated

func (*FeaturestoreMonitoringConfig) Descriptor() ([]byte, []int)

Deprecated: Use FeaturestoreMonitoringConfig.ProtoReflect.Descriptor instead.

func (*FeaturestoreMonitoringConfig) GetCategoricalThresholdConfig

func (*FeaturestoreMonitoringConfig) GetImportFeaturesAnalysis

func (*FeaturestoreMonitoringConfig) GetNumericalThresholdConfig

func (*FeaturestoreMonitoringConfig) GetSnapshotAnalysis

func (*FeaturestoreMonitoringConfig) ProtoMessage

func (*FeaturestoreMonitoringConfig) ProtoMessage()

func (*FeaturestoreMonitoringConfig) ProtoReflect

func (*FeaturestoreMonitoringConfig) Reset

func (x *FeaturestoreMonitoringConfig) Reset()

func (*FeaturestoreMonitoringConfig) String

type FeaturestoreMonitoringConfig_ImportFeaturesAnalysis

type FeaturestoreMonitoringConfig_ImportFeaturesAnalysis struct {

	// Whether to enable / disable / inherite default hebavior for import
	// features analysis.
	State FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State `` /* 154-byte string literal not displayed */
	// The baseline used to do anomaly detection for the statistics generated by
	// import features analysis.
	AnomalyDetectionBaseline FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline `` /* 229-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration of the Featurestore's ImportFeature Analysis Based Monitoring. This type of analysis generates statistics for values of each Feature imported by every [ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues] operation.

func (*FeaturestoreMonitoringConfig_ImportFeaturesAnalysis) Descriptor deprecated

Deprecated: Use FeaturestoreMonitoringConfig_ImportFeaturesAnalysis.ProtoReflect.Descriptor instead.

func (*FeaturestoreMonitoringConfig_ImportFeaturesAnalysis) GetAnomalyDetectionBaseline

func (*FeaturestoreMonitoringConfig_ImportFeaturesAnalysis) GetState

func (*FeaturestoreMonitoringConfig_ImportFeaturesAnalysis) ProtoMessage

func (*FeaturestoreMonitoringConfig_ImportFeaturesAnalysis) ProtoReflect

func (*FeaturestoreMonitoringConfig_ImportFeaturesAnalysis) Reset

func (*FeaturestoreMonitoringConfig_ImportFeaturesAnalysis) String

type FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline

type FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline int32

Defines the baseline to do anomaly detection for feature values imported by each [ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues] operation.

const (
	// Should not be used.
	FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_BASELINE_UNSPECIFIED FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline = 0
	// Choose the later one statistics generated by either most recent
	// snapshot analysis or previous import features analysis. If non of them
	// exists, skip anomaly detection and only generate a statistics.
	FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_LATEST_STATS FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline = 1
	// Use the statistics generated by the most recent snapshot analysis if
	// exists.
	FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_MOST_RECENT_SNAPSHOT_STATS FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline = 2
	// Use the statistics generated by the previous import features analysis
	// if exists.
	FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_PREVIOUS_IMPORT_FEATURES_STATS FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline = 3
)

func (FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline) Descriptor

func (FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline) Enum

func (FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline) EnumDescriptor deprecated

Deprecated: Use FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline.Descriptor instead.

func (FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline) Number

func (FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline) String

func (FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_Baseline) Type

type FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State

type FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State int32

The state defines whether to enable ImportFeature analysis.

const (
	// Should not be used.
	FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_STATE_UNSPECIFIED FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State = 0
	// The default behavior of whether to enable the monitoring.
	// EntityType-level config: disabled.
	// Feature-level config: inherited from the configuration of EntityType
	// this Feature belongs to.
	FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_DEFAULT FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State = 1
	// Explicitly enables import features analysis.
	// EntityType-level config: by default enables import features analysis
	// for all Features under it. Feature-level config: enables import
	// features analysis regardless of the EntityType-level config.
	FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_ENABLED FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State = 2
	// Explicitly disables import features analysis.
	// EntityType-level config: by default disables import features analysis
	// for all Features under it. Feature-level config: disables import
	// features analysis regardless of the EntityType-level config.
	FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_DISABLED FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State = 3
)

func (FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State) Descriptor

func (FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State) Enum

func (FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State) EnumDescriptor deprecated

Deprecated: Use FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State.Descriptor instead.

func (FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State) Number

func (FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State) String

func (FeaturestoreMonitoringConfig_ImportFeaturesAnalysis_State) Type

type FeaturestoreMonitoringConfig_SnapshotAnalysis

type FeaturestoreMonitoringConfig_SnapshotAnalysis struct {

	// The monitoring schedule for snapshot analysis.
	// For EntityType-level config:
	//
	//	unset / disabled = true indicates disabled by
	//	default for Features under it; otherwise by default enable snapshot
	//	analysis monitoring with monitoring_interval for Features under it.
	//
	// Feature-level config:
	//
	//	disabled = true indicates disabled regardless of the EntityType-level
	//	config; unset monitoring_interval indicates going with EntityType-level
	//	config; otherwise run snapshot analysis monitoring with
	//	monitoring_interval regardless of the EntityType-level config.
	//
	// Explicitly Disable the snapshot analysis based monitoring.
	Disabled bool `protobuf:"varint,1,opt,name=disabled,proto3" json:"disabled,omitempty"`
	// Configuration of the snapshot analysis based monitoring pipeline
	// running interval. The value indicates number of days.
	MonitoringIntervalDays int32 `` /* 130-byte string literal not displayed */
	// Customized export features time window for snapshot analysis. Unit is one
	// day. Default value is 3 weeks. Minimum value is 1 day. Maximum value is
	// 4000 days.
	StalenessDays int32 `protobuf:"varint,4,opt,name=staleness_days,json=stalenessDays,proto3" json:"staleness_days,omitempty"`
	// contains filtered or unexported fields
}

Configuration of the Featurestore's Snapshot Analysis Based Monitoring. This type of analysis generates statistics for each Feature based on a snapshot of the latest feature value of each entities every monitoring_interval.

func (*FeaturestoreMonitoringConfig_SnapshotAnalysis) Descriptor deprecated

Deprecated: Use FeaturestoreMonitoringConfig_SnapshotAnalysis.ProtoReflect.Descriptor instead.

func (*FeaturestoreMonitoringConfig_SnapshotAnalysis) GetDisabled

func (*FeaturestoreMonitoringConfig_SnapshotAnalysis) GetMonitoringIntervalDays

func (x *FeaturestoreMonitoringConfig_SnapshotAnalysis) GetMonitoringIntervalDays() int32

func (*FeaturestoreMonitoringConfig_SnapshotAnalysis) GetStalenessDays

func (*FeaturestoreMonitoringConfig_SnapshotAnalysis) ProtoMessage

func (*FeaturestoreMonitoringConfig_SnapshotAnalysis) ProtoReflect

func (*FeaturestoreMonitoringConfig_SnapshotAnalysis) Reset

func (*FeaturestoreMonitoringConfig_SnapshotAnalysis) String

type FeaturestoreMonitoringConfig_ThresholdConfig

type FeaturestoreMonitoringConfig_ThresholdConfig struct {

	// Types that are assignable to Threshold:
	//
	//	*FeaturestoreMonitoringConfig_ThresholdConfig_Value
	Threshold isFeaturestoreMonitoringConfig_ThresholdConfig_Threshold `protobuf_oneof:"threshold"`
	// contains filtered or unexported fields
}

The config for Featurestore Monitoring threshold.

func (*FeaturestoreMonitoringConfig_ThresholdConfig) Descriptor deprecated

Deprecated: Use FeaturestoreMonitoringConfig_ThresholdConfig.ProtoReflect.Descriptor instead.

func (*FeaturestoreMonitoringConfig_ThresholdConfig) GetThreshold

func (m *FeaturestoreMonitoringConfig_ThresholdConfig) GetThreshold() isFeaturestoreMonitoringConfig_ThresholdConfig_Threshold

func (*FeaturestoreMonitoringConfig_ThresholdConfig) GetValue

func (*FeaturestoreMonitoringConfig_ThresholdConfig) ProtoMessage

func (*FeaturestoreMonitoringConfig_ThresholdConfig) ProtoReflect

func (*FeaturestoreMonitoringConfig_ThresholdConfig) Reset

func (*FeaturestoreMonitoringConfig_ThresholdConfig) String

type FeaturestoreMonitoringConfig_ThresholdConfig_Value

type FeaturestoreMonitoringConfig_ThresholdConfig_Value struct {
	// Specify a threshold value that can trigger the alert.
	// 1. For categorical feature, the distribution distance is calculated by
	// L-inifinity norm.
	// 2. For numerical feature, the distribution distance is calculated by
	// Jensen–Shannon divergence. Each feature must have a non-zero threshold
	// if they need to be monitored. Otherwise no alert will be triggered for
	// that feature.
	Value float64 `protobuf:"fixed64,1,opt,name=value,proto3,oneof"`
}

type FeaturestoreOnlineServingServiceClient

type FeaturestoreOnlineServingServiceClient interface {
	// Reads Feature values of a specific entity of an EntityType. For reading
	// feature values of multiple entities of an EntityType, please use
	// StreamingReadFeatureValues.
	ReadFeatureValues(ctx context.Context, in *ReadFeatureValuesRequest, opts ...grpc.CallOption) (*ReadFeatureValuesResponse, error)
	// Reads Feature values for multiple entities. Depending on their size, data
	// for different entities may be broken
	// up across multiple responses.
	StreamingReadFeatureValues(ctx context.Context, in *StreamingReadFeatureValuesRequest, opts ...grpc.CallOption) (FeaturestoreOnlineServingService_StreamingReadFeatureValuesClient, error)
	// Writes Feature values of one or more entities of an EntityType.
	//
	// The Feature values are merged into existing entities if any. The Feature
	// values to be written must have timestamp within the online storage
	// retention.
	WriteFeatureValues(ctx context.Context, in *WriteFeatureValuesRequest, opts ...grpc.CallOption) (*WriteFeatureValuesResponse, error)
}

FeaturestoreOnlineServingServiceClient is the client API for FeaturestoreOnlineServingService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type FeaturestoreOnlineServingServiceServer

type FeaturestoreOnlineServingServiceServer interface {
	// Reads Feature values of a specific entity of an EntityType. For reading
	// feature values of multiple entities of an EntityType, please use
	// StreamingReadFeatureValues.
	ReadFeatureValues(context.Context, *ReadFeatureValuesRequest) (*ReadFeatureValuesResponse, error)
	// Reads Feature values for multiple entities. Depending on their size, data
	// for different entities may be broken
	// up across multiple responses.
	StreamingReadFeatureValues(*StreamingReadFeatureValuesRequest, FeaturestoreOnlineServingService_StreamingReadFeatureValuesServer) error
	// Writes Feature values of one or more entities of an EntityType.
	//
	// The Feature values are merged into existing entities if any. The Feature
	// values to be written must have timestamp within the online storage
	// retention.
	WriteFeatureValues(context.Context, *WriteFeatureValuesRequest) (*WriteFeatureValuesResponse, error)
}

FeaturestoreOnlineServingServiceServer is the server API for FeaturestoreOnlineServingService service.

type FeaturestoreOnlineServingService_StreamingReadFeatureValuesClient

type FeaturestoreOnlineServingService_StreamingReadFeatureValuesClient interface {
	Recv() (*ReadFeatureValuesResponse, error)
	grpc.ClientStream
}

type FeaturestoreOnlineServingService_StreamingReadFeatureValuesServer

type FeaturestoreOnlineServingService_StreamingReadFeatureValuesServer interface {
	Send(*ReadFeatureValuesResponse) error
	grpc.ServerStream
}

type FeaturestoreServiceClient

type FeaturestoreServiceClient interface {
	// Creates a new Featurestore in a given project and location.
	CreateFeaturestore(ctx context.Context, in *CreateFeaturestoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets details of a single Featurestore.
	GetFeaturestore(ctx context.Context, in *GetFeaturestoreRequest, opts ...grpc.CallOption) (*Featurestore, error)
	// Lists Featurestores in a given project and location.
	ListFeaturestores(ctx context.Context, in *ListFeaturestoresRequest, opts ...grpc.CallOption) (*ListFeaturestoresResponse, error)
	// Updates the parameters of a single Featurestore.
	UpdateFeaturestore(ctx context.Context, in *UpdateFeaturestoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single Featurestore. The Featurestore must not contain any
	// EntityTypes or `force` must be set to true for the request to succeed.
	DeleteFeaturestore(ctx context.Context, in *DeleteFeaturestoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a new EntityType in a given Featurestore.
	CreateEntityType(ctx context.Context, in *CreateEntityTypeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets details of a single EntityType.
	GetEntityType(ctx context.Context, in *GetEntityTypeRequest, opts ...grpc.CallOption) (*EntityType, error)
	// Lists EntityTypes in a given Featurestore.
	ListEntityTypes(ctx context.Context, in *ListEntityTypesRequest, opts ...grpc.CallOption) (*ListEntityTypesResponse, error)
	// Updates the parameters of a single EntityType.
	UpdateEntityType(ctx context.Context, in *UpdateEntityTypeRequest, opts ...grpc.CallOption) (*EntityType, error)
	// Deletes a single EntityType. The EntityType must not have any Features
	// or `force` must be set to true for the request to succeed.
	DeleteEntityType(ctx context.Context, in *DeleteEntityTypeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a new Feature in a given EntityType.
	CreateFeature(ctx context.Context, in *CreateFeatureRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a batch of Features in a given EntityType.
	BatchCreateFeatures(ctx context.Context, in *BatchCreateFeaturesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets details of a single Feature.
	GetFeature(ctx context.Context, in *GetFeatureRequest, opts ...grpc.CallOption) (*Feature, error)
	// Lists Features in a given EntityType.
	ListFeatures(ctx context.Context, in *ListFeaturesRequest, opts ...grpc.CallOption) (*ListFeaturesResponse, error)
	// Updates the parameters of a single Feature.
	UpdateFeature(ctx context.Context, in *UpdateFeatureRequest, opts ...grpc.CallOption) (*Feature, error)
	// Deletes a single Feature.
	DeleteFeature(ctx context.Context, in *DeleteFeatureRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Imports Feature values into the Featurestore from a source storage.
	//
	// The progress of the import is tracked by the returned operation. The
	// imported features are guaranteed to be visible to subsequent read
	// operations after the operation is marked as successfully done.
	//
	// If an import operation fails, the Feature values returned from
	// reads and exports may be inconsistent. If consistency is
	// required, the caller must retry the same import request again and wait till
	// the new operation returned is marked as successfully done.
	//
	// There are also scenarios where the caller can cause inconsistency.
	//
	//   - Source data for import contains multiple distinct Feature values for
	//     the same entity ID and timestamp.
	//   - Source is modified during an import. This includes adding, updating, or
	//     removing source data and/or metadata. Examples of updating metadata
	//     include but are not limited to changing storage location, storage class,
	//     or retention policy.
	//   - Online serving cluster is under-provisioned.
	ImportFeatureValues(ctx context.Context, in *ImportFeatureValuesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Batch reads Feature values from a Featurestore.
	//
	// This API enables batch reading Feature values, where each read
	// instance in the batch may read Feature values of entities from one or
	// more EntityTypes. Point-in-time correctness is guaranteed for Feature
	// values of each read instance as of each instance's read timestamp.
	BatchReadFeatureValues(ctx context.Context, in *BatchReadFeatureValuesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Exports Feature values from all the entities of a target EntityType.
	ExportFeatureValues(ctx context.Context, in *ExportFeatureValuesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Delete Feature values from Featurestore.
	//
	// The progress of the deletion is tracked by the returned operation. The
	// deleted feature values are guaranteed to be invisible to subsequent read
	// operations after the operation is marked as successfully done.
	//
	// If a delete feature values operation fails, the feature values
	// returned from reads and exports may be inconsistent. If consistency is
	// required, the caller must retry the same delete request again and wait till
	// the new operation returned is marked as successfully done.
	DeleteFeatureValues(ctx context.Context, in *DeleteFeatureValuesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Searches Features matching a query in a given project.
	SearchFeatures(ctx context.Context, in *SearchFeaturesRequest, opts ...grpc.CallOption) (*SearchFeaturesResponse, error)
}

FeaturestoreServiceClient is the client API for FeaturestoreService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type FeaturestoreServiceServer

type FeaturestoreServiceServer interface {
	// Creates a new Featurestore in a given project and location.
	CreateFeaturestore(context.Context, *CreateFeaturestoreRequest) (*longrunningpb.Operation, error)
	// Gets details of a single Featurestore.
	GetFeaturestore(context.Context, *GetFeaturestoreRequest) (*Featurestore, error)
	// Lists Featurestores in a given project and location.
	ListFeaturestores(context.Context, *ListFeaturestoresRequest) (*ListFeaturestoresResponse, error)
	// Updates the parameters of a single Featurestore.
	UpdateFeaturestore(context.Context, *UpdateFeaturestoreRequest) (*longrunningpb.Operation, error)
	// Deletes a single Featurestore. The Featurestore must not contain any
	// EntityTypes or `force` must be set to true for the request to succeed.
	DeleteFeaturestore(context.Context, *DeleteFeaturestoreRequest) (*longrunningpb.Operation, error)
	// Creates a new EntityType in a given Featurestore.
	CreateEntityType(context.Context, *CreateEntityTypeRequest) (*longrunningpb.Operation, error)
	// Gets details of a single EntityType.
	GetEntityType(context.Context, *GetEntityTypeRequest) (*EntityType, error)
	// Lists EntityTypes in a given Featurestore.
	ListEntityTypes(context.Context, *ListEntityTypesRequest) (*ListEntityTypesResponse, error)
	// Updates the parameters of a single EntityType.
	UpdateEntityType(context.Context, *UpdateEntityTypeRequest) (*EntityType, error)
	// Deletes a single EntityType. The EntityType must not have any Features
	// or `force` must be set to true for the request to succeed.
	DeleteEntityType(context.Context, *DeleteEntityTypeRequest) (*longrunningpb.Operation, error)
	// Creates a new Feature in a given EntityType.
	CreateFeature(context.Context, *CreateFeatureRequest) (*longrunningpb.Operation, error)
	// Creates a batch of Features in a given EntityType.
	BatchCreateFeatures(context.Context, *BatchCreateFeaturesRequest) (*longrunningpb.Operation, error)
	// Gets details of a single Feature.
	GetFeature(context.Context, *GetFeatureRequest) (*Feature, error)
	// Lists Features in a given EntityType.
	ListFeatures(context.Context, *ListFeaturesRequest) (*ListFeaturesResponse, error)
	// Updates the parameters of a single Feature.
	UpdateFeature(context.Context, *UpdateFeatureRequest) (*Feature, error)
	// Deletes a single Feature.
	DeleteFeature(context.Context, *DeleteFeatureRequest) (*longrunningpb.Operation, error)
	// Imports Feature values into the Featurestore from a source storage.
	//
	// The progress of the import is tracked by the returned operation. The
	// imported features are guaranteed to be visible to subsequent read
	// operations after the operation is marked as successfully done.
	//
	// If an import operation fails, the Feature values returned from
	// reads and exports may be inconsistent. If consistency is
	// required, the caller must retry the same import request again and wait till
	// the new operation returned is marked as successfully done.
	//
	// There are also scenarios where the caller can cause inconsistency.
	//
	//   - Source data for import contains multiple distinct Feature values for
	//     the same entity ID and timestamp.
	//   - Source is modified during an import. This includes adding, updating, or
	//     removing source data and/or metadata. Examples of updating metadata
	//     include but are not limited to changing storage location, storage class,
	//     or retention policy.
	//   - Online serving cluster is under-provisioned.
	ImportFeatureValues(context.Context, *ImportFeatureValuesRequest) (*longrunningpb.Operation, error)
	// Batch reads Feature values from a Featurestore.
	//
	// This API enables batch reading Feature values, where each read
	// instance in the batch may read Feature values of entities from one or
	// more EntityTypes. Point-in-time correctness is guaranteed for Feature
	// values of each read instance as of each instance's read timestamp.
	BatchReadFeatureValues(context.Context, *BatchReadFeatureValuesRequest) (*longrunningpb.Operation, error)
	// Exports Feature values from all the entities of a target EntityType.
	ExportFeatureValues(context.Context, *ExportFeatureValuesRequest) (*longrunningpb.Operation, error)
	// Delete Feature values from Featurestore.
	//
	// The progress of the deletion is tracked by the returned operation. The
	// deleted feature values are guaranteed to be invisible to subsequent read
	// operations after the operation is marked as successfully done.
	//
	// If a delete feature values operation fails, the feature values
	// returned from reads and exports may be inconsistent. If consistency is
	// required, the caller must retry the same delete request again and wait till
	// the new operation returned is marked as successfully done.
	DeleteFeatureValues(context.Context, *DeleteFeatureValuesRequest) (*longrunningpb.Operation, error)
	// Searches Features matching a query in a given project.
	SearchFeatures(context.Context, *SearchFeaturesRequest) (*SearchFeaturesResponse, error)
}

FeaturestoreServiceServer is the server API for FeaturestoreService service.

type Featurestore_OnlineServingConfig

type Featurestore_OnlineServingConfig struct {

	// The number of nodes for the online store. The number of nodes doesn't
	// scale automatically, but you can manually update the number of
	// nodes. If set to 0, the featurestore will not have an
	// online store and cannot be used for online serving.
	FixedNodeCount int32 `protobuf:"varint,2,opt,name=fixed_node_count,json=fixedNodeCount,proto3" json:"fixed_node_count,omitempty"`
	// Online serving scaling configuration.
	// Only one of `fixed_node_count` and `scaling` can be set. Setting one will
	// reset the other.
	Scaling *Featurestore_OnlineServingConfig_Scaling `protobuf:"bytes,4,opt,name=scaling,proto3" json:"scaling,omitempty"`
	// contains filtered or unexported fields
}

OnlineServingConfig specifies the details for provisioning online serving resources.

func (*Featurestore_OnlineServingConfig) Descriptor deprecated

func (*Featurestore_OnlineServingConfig) Descriptor() ([]byte, []int)

Deprecated: Use Featurestore_OnlineServingConfig.ProtoReflect.Descriptor instead.

func (*Featurestore_OnlineServingConfig) GetFixedNodeCount

func (x *Featurestore_OnlineServingConfig) GetFixedNodeCount() int32

func (*Featurestore_OnlineServingConfig) GetScaling

func (*Featurestore_OnlineServingConfig) ProtoMessage

func (*Featurestore_OnlineServingConfig) ProtoMessage()

func (*Featurestore_OnlineServingConfig) ProtoReflect

func (*Featurestore_OnlineServingConfig) Reset

func (*Featurestore_OnlineServingConfig) String

type Featurestore_OnlineServingConfig_Scaling

type Featurestore_OnlineServingConfig_Scaling struct {

	// Required. The minimum number of nodes to scale down to. Must be greater
	// than or equal to 1.
	MinNodeCount int32 `protobuf:"varint,1,opt,name=min_node_count,json=minNodeCount,proto3" json:"min_node_count,omitempty"`
	// The maximum number of nodes to scale up to. Must be greater than
	// min_node_count, and less than or equal to 10 times of 'min_node_count'.
	MaxNodeCount int32 `protobuf:"varint,2,opt,name=max_node_count,json=maxNodeCount,proto3" json:"max_node_count,omitempty"`
	// Optional. The cpu utilization that the Autoscaler should be trying to
	// achieve. This number is on a scale from 0 (no utilization) to 100
	// (total utilization), and is limited between 10 and 80. When a cluster's
	// CPU utilization exceeds the target that you have set, Bigtable
	// immediately adds nodes to the cluster. When CPU utilization is
	// substantially lower than the target, Bigtable removes nodes. If not set
	// or set to 0, default to 50.
	CpuUtilizationTarget int32 `protobuf:"varint,3,opt,name=cpu_utilization_target,json=cpuUtilizationTarget,proto3" json:"cpu_utilization_target,omitempty"`
	// contains filtered or unexported fields
}

Online serving scaling configuration. If min_node_count and max_node_count are set to the same value, the cluster will be configured with the fixed number of node (no auto-scaling).

func (*Featurestore_OnlineServingConfig_Scaling) Descriptor deprecated

func (*Featurestore_OnlineServingConfig_Scaling) Descriptor() ([]byte, []int)

Deprecated: Use Featurestore_OnlineServingConfig_Scaling.ProtoReflect.Descriptor instead.

func (*Featurestore_OnlineServingConfig_Scaling) GetCpuUtilizationTarget added in v1.36.0

func (x *Featurestore_OnlineServingConfig_Scaling) GetCpuUtilizationTarget() int32

func (*Featurestore_OnlineServingConfig_Scaling) GetMaxNodeCount

func (x *Featurestore_OnlineServingConfig_Scaling) GetMaxNodeCount() int32

func (*Featurestore_OnlineServingConfig_Scaling) GetMinNodeCount

func (x *Featurestore_OnlineServingConfig_Scaling) GetMinNodeCount() int32

func (*Featurestore_OnlineServingConfig_Scaling) ProtoMessage

func (*Featurestore_OnlineServingConfig_Scaling) ProtoReflect

func (*Featurestore_OnlineServingConfig_Scaling) Reset

func (*Featurestore_OnlineServingConfig_Scaling) String

type Featurestore_State

type Featurestore_State int32

Possible states a featurestore can have.

const (
	// Default value. This value is unused.
	Featurestore_STATE_UNSPECIFIED Featurestore_State = 0
	// State when the featurestore configuration is not being updated and the
	// fields reflect the current configuration of the featurestore. The
	// featurestore is usable in this state.
	Featurestore_STABLE Featurestore_State = 1
	// The state of the featurestore configuration when it is being updated.
	// During an update, the fields reflect either the original configuration
	// or the updated configuration of the featurestore. For example,
	// `online_serving_config.fixed_node_count` can take minutes to update.
	// While the update is in progress, the featurestore is in the UPDATING
	// state, and the value of `fixed_node_count` can be the original value or
	// the updated value, depending on the progress of the operation. Until the
	// update completes, the actual number of nodes can still be the original
	// value of `fixed_node_count`. The featurestore is still usable in this
	// state.
	Featurestore_UPDATING Featurestore_State = 2
)

func (Featurestore_State) Descriptor

func (Featurestore_State) Enum

func (Featurestore_State) EnumDescriptor deprecated

func (Featurestore_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Featurestore_State.Descriptor instead.

func (Featurestore_State) Number

func (Featurestore_State) String

func (x Featurestore_State) String() string

func (Featurestore_State) Type

type FetchFeatureValuesRequest added in v1.54.0

type FetchFeatureValuesRequest struct {

	// Required. FeatureView resource format
	// `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`
	FeatureView string `protobuf:"bytes,1,opt,name=feature_view,json=featureView,proto3" json:"feature_view,omitempty"`
	// Optional. The request key to fetch feature values for.
	DataKey *FeatureViewDataKey `protobuf:"bytes,6,opt,name=data_key,json=dataKey,proto3" json:"data_key,omitempty"`
	// Optional. Response data format. If not set,
	// [FeatureViewDataFormat.KEY_VALUE][google.cloud.aiplatform.v1.FeatureViewDataFormat.KEY_VALUE]
	// will be used.
	DataFormat FeatureViewDataFormat `` /* 146-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreService.FetchFeatureValues][google.cloud.aiplatform.v1.FeatureOnlineStoreService.FetchFeatureValues]. All the features under the requested feature view will be returned.

func (*FetchFeatureValuesRequest) Descriptor deprecated added in v1.54.0

func (*FetchFeatureValuesRequest) Descriptor() ([]byte, []int)

Deprecated: Use FetchFeatureValuesRequest.ProtoReflect.Descriptor instead.

func (*FetchFeatureValuesRequest) GetDataFormat added in v1.54.0

func (*FetchFeatureValuesRequest) GetDataKey added in v1.54.0

func (*FetchFeatureValuesRequest) GetFeatureView added in v1.54.0

func (x *FetchFeatureValuesRequest) GetFeatureView() string

func (*FetchFeatureValuesRequest) ProtoMessage added in v1.54.0

func (*FetchFeatureValuesRequest) ProtoMessage()

func (*FetchFeatureValuesRequest) ProtoReflect added in v1.54.0

func (*FetchFeatureValuesRequest) Reset added in v1.54.0

func (x *FetchFeatureValuesRequest) Reset()

func (*FetchFeatureValuesRequest) String added in v1.54.0

func (x *FetchFeatureValuesRequest) String() string

type FetchFeatureValuesResponse added in v1.54.0

type FetchFeatureValuesResponse struct {

	// Types that are assignable to Format:
	//
	//	*FetchFeatureValuesResponse_KeyValues
	//	*FetchFeatureValuesResponse_ProtoStruct
	Format isFetchFeatureValuesResponse_Format `protobuf_oneof:"format"`
	// The data key associated with this response.
	// Will only be populated for
	// [FeatureOnlineStoreService.StreamingFetchFeatureValues][] RPCs.
	DataKey *FeatureViewDataKey `protobuf:"bytes,4,opt,name=data_key,json=dataKey,proto3" json:"data_key,omitempty"`
	// contains filtered or unexported fields
}

Response message for [FeatureOnlineStoreService.FetchFeatureValues][google.cloud.aiplatform.v1.FeatureOnlineStoreService.FetchFeatureValues]

func (*FetchFeatureValuesResponse) Descriptor deprecated added in v1.54.0

func (*FetchFeatureValuesResponse) Descriptor() ([]byte, []int)

Deprecated: Use FetchFeatureValuesResponse.ProtoReflect.Descriptor instead.

func (*FetchFeatureValuesResponse) GetDataKey added in v1.65.0

func (*FetchFeatureValuesResponse) GetFormat added in v1.54.0

func (m *FetchFeatureValuesResponse) GetFormat() isFetchFeatureValuesResponse_Format

func (*FetchFeatureValuesResponse) GetKeyValues added in v1.54.0

func (*FetchFeatureValuesResponse) GetProtoStruct added in v1.54.0

func (x *FetchFeatureValuesResponse) GetProtoStruct() *structpb.Struct

func (*FetchFeatureValuesResponse) ProtoMessage added in v1.54.0

func (*FetchFeatureValuesResponse) ProtoMessage()

func (*FetchFeatureValuesResponse) ProtoReflect added in v1.54.0

func (*FetchFeatureValuesResponse) Reset added in v1.54.0

func (x *FetchFeatureValuesResponse) Reset()

func (*FetchFeatureValuesResponse) String added in v1.54.0

func (x *FetchFeatureValuesResponse) String() string

type FetchFeatureValuesResponse_FeatureNameValuePairList added in v1.54.0

type FetchFeatureValuesResponse_FeatureNameValuePairList struct {

	// List of feature names and values.
	Features []*FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair `protobuf:"bytes,1,rep,name=features,proto3" json:"features,omitempty"`
	// contains filtered or unexported fields
}

Response structure in the format of key (feature name) and (feature) value pair.

func (*FetchFeatureValuesResponse_FeatureNameValuePairList) Descriptor deprecated added in v1.54.0

Deprecated: Use FetchFeatureValuesResponse_FeatureNameValuePairList.ProtoReflect.Descriptor instead.

func (*FetchFeatureValuesResponse_FeatureNameValuePairList) GetFeatures added in v1.54.0

func (*FetchFeatureValuesResponse_FeatureNameValuePairList) ProtoMessage added in v1.54.0

func (*FetchFeatureValuesResponse_FeatureNameValuePairList) ProtoReflect added in v1.54.0

func (*FetchFeatureValuesResponse_FeatureNameValuePairList) Reset added in v1.54.0

func (*FetchFeatureValuesResponse_FeatureNameValuePairList) String added in v1.54.0

type FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair added in v1.54.0

type FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair struct {

	// Types that are assignable to Data:
	//
	//	*FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair_Value
	Data isFetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair_Data `protobuf_oneof:"data"`
	// Feature short name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Feature name & value pair.

func (*FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair) Descriptor deprecated added in v1.54.0

Deprecated: Use FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair.ProtoReflect.Descriptor instead.

func (*FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair) GetData added in v1.54.0

func (m *FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair) GetData() isFetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair_Data

func (*FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair) GetName added in v1.54.0

func (*FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair) GetValue added in v1.54.0

func (*FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair) ProtoMessage added in v1.54.0

func (*FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair) ProtoReflect added in v1.54.0

func (*FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair) Reset added in v1.54.0

func (*FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair) String added in v1.54.0

type FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair_Value added in v1.54.0

type FetchFeatureValuesResponse_FeatureNameValuePairList_FeatureNameValuePair_Value struct {
	// Feature value.
	Value *FeatureValue `protobuf:"bytes,2,opt,name=value,proto3,oneof"`
}

type FetchFeatureValuesResponse_KeyValues added in v1.54.0

type FetchFeatureValuesResponse_KeyValues struct {
	// Feature values in KeyValue format.
	KeyValues *FetchFeatureValuesResponse_FeatureNameValuePairList `protobuf:"bytes,3,opt,name=key_values,json=keyValues,proto3,oneof"`
}

type FetchFeatureValuesResponse_ProtoStruct added in v1.54.0

type FetchFeatureValuesResponse_ProtoStruct struct {
	// Feature values in proto Struct format.
	ProtoStruct *structpb.Struct `protobuf:"bytes,2,opt,name=proto_struct,json=protoStruct,proto3,oneof"`
}

type FileData added in v1.57.0

type FileData struct {

	// Required. The IANA standard MIME type of the source data.
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Required. URI.
	FileUri string `protobuf:"bytes,2,opt,name=file_uri,json=fileUri,proto3" json:"file_uri,omitempty"`
	// contains filtered or unexported fields
}

URI based data.

func (*FileData) Descriptor deprecated added in v1.57.0

func (*FileData) Descriptor() ([]byte, []int)

Deprecated: Use FileData.ProtoReflect.Descriptor instead.

func (*FileData) GetFileUri added in v1.57.0

func (x *FileData) GetFileUri() string

func (*FileData) GetMimeType added in v1.57.0

func (x *FileData) GetMimeType() string

func (*FileData) ProtoMessage added in v1.57.0

func (*FileData) ProtoMessage()

func (*FileData) ProtoReflect added in v1.57.0

func (x *FileData) ProtoReflect() protoreflect.Message

func (*FileData) Reset added in v1.57.0

func (x *FileData) Reset()

func (*FileData) String added in v1.57.0

func (x *FileData) String() string

type FilterSplit

type FilterSplit struct {

	// Required. A filter on DataItems of the Dataset. DataItems that match
	// this filter are used to train the Model. A filter with same syntax
	// as the one used in
	// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
	// may be used. If a single DataItem is matched by more than one of the
	// FilterSplit filters, then it is assigned to the first set that applies to
	// it in the training, validation, test order.
	TrainingFilter string `protobuf:"bytes,1,opt,name=training_filter,json=trainingFilter,proto3" json:"training_filter,omitempty"`
	// Required. A filter on DataItems of the Dataset. DataItems that match
	// this filter are used to validate the Model. A filter with same syntax
	// as the one used in
	// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
	// may be used. If a single DataItem is matched by more than one of the
	// FilterSplit filters, then it is assigned to the first set that applies to
	// it in the training, validation, test order.
	ValidationFilter string `protobuf:"bytes,2,opt,name=validation_filter,json=validationFilter,proto3" json:"validation_filter,omitempty"`
	// Required. A filter on DataItems of the Dataset. DataItems that match
	// this filter are used to test the Model. A filter with same syntax
	// as the one used in
	// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
	// may be used. If a single DataItem is matched by more than one of the
	// FilterSplit filters, then it is assigned to the first set that applies to
	// it in the training, validation, test order.
	TestFilter string `protobuf:"bytes,3,opt,name=test_filter,json=testFilter,proto3" json:"test_filter,omitempty"`
	// contains filtered or unexported fields
}

Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as '-' (the minus sign).

Supported only for unstructured Datasets.

func (*FilterSplit) Descriptor deprecated

func (*FilterSplit) Descriptor() ([]byte, []int)

Deprecated: Use FilterSplit.ProtoReflect.Descriptor instead.

func (*FilterSplit) GetTestFilter

func (x *FilterSplit) GetTestFilter() string

func (*FilterSplit) GetTrainingFilter

func (x *FilterSplit) GetTrainingFilter() string

func (*FilterSplit) GetValidationFilter

func (x *FilterSplit) GetValidationFilter() string

func (*FilterSplit) ProtoMessage

func (*FilterSplit) ProtoMessage()

func (*FilterSplit) ProtoReflect

func (x *FilterSplit) ProtoReflect() protoreflect.Message

func (*FilterSplit) Reset

func (x *FilterSplit) Reset()

func (*FilterSplit) String

func (x *FilterSplit) String() string

type FindNeighborsRequest added in v1.43.0

type FindNeighborsRequest struct {

	// Required. The name of the index endpoint.
	// Format:
	// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
	IndexEndpoint string `protobuf:"bytes,1,opt,name=index_endpoint,json=indexEndpoint,proto3" json:"index_endpoint,omitempty"`
	// The ID of the DeployedIndex that will serve the request. This request is
	// sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
	// IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
	// has a DeployedIndex.id field.
	// The value of the field below must equal one of the DeployedIndex.id
	// fields of the IndexEndpoint that is being called for this request.
	DeployedIndexId string `protobuf:"bytes,2,opt,name=deployed_index_id,json=deployedIndexId,proto3" json:"deployed_index_id,omitempty"`
	// The list of queries.
	Queries []*FindNeighborsRequest_Query `protobuf:"bytes,3,rep,name=queries,proto3" json:"queries,omitempty"`
	// If set to true, the full datapoints (including all vector values and
	// restricts) of the nearest neighbors are returned.
	// Note that returning full datapoint will significantly increase the
	// latency and cost of the query.
	ReturnFullDatapoint bool `protobuf:"varint,4,opt,name=return_full_datapoint,json=returnFullDatapoint,proto3" json:"return_full_datapoint,omitempty"`
	// contains filtered or unexported fields
}

The request message for [MatchService.FindNeighbors][google.cloud.aiplatform.v1.MatchService.FindNeighbors].

func (*FindNeighborsRequest) Descriptor deprecated added in v1.43.0

func (*FindNeighborsRequest) Descriptor() ([]byte, []int)

Deprecated: Use FindNeighborsRequest.ProtoReflect.Descriptor instead.

func (*FindNeighborsRequest) GetDeployedIndexId added in v1.43.0

func (x *FindNeighborsRequest) GetDeployedIndexId() string

func (*FindNeighborsRequest) GetIndexEndpoint added in v1.43.0

func (x *FindNeighborsRequest) GetIndexEndpoint() string

func (*FindNeighborsRequest) GetQueries added in v1.43.0

func (*FindNeighborsRequest) GetReturnFullDatapoint added in v1.43.0

func (x *FindNeighborsRequest) GetReturnFullDatapoint() bool

func (*FindNeighborsRequest) ProtoMessage added in v1.43.0

func (*FindNeighborsRequest) ProtoMessage()

func (*FindNeighborsRequest) ProtoReflect added in v1.43.0

func (x *FindNeighborsRequest) ProtoReflect() protoreflect.Message

func (*FindNeighborsRequest) Reset added in v1.43.0

func (x *FindNeighborsRequest) Reset()

func (*FindNeighborsRequest) String added in v1.43.0

func (x *FindNeighborsRequest) String() string

type FindNeighborsRequest_Query added in v1.43.0

type FindNeighborsRequest_Query struct {

	// Required. The datapoint/vector whose nearest neighbors should be searched
	// for.
	Datapoint *IndexDatapoint `protobuf:"bytes,1,opt,name=datapoint,proto3" json:"datapoint,omitempty"`
	// The number of nearest neighbors to be retrieved from database for each
	// query. If not set, will use the default from the service configuration
	// (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config).
	NeighborCount int32 `protobuf:"varint,2,opt,name=neighbor_count,json=neighborCount,proto3" json:"neighbor_count,omitempty"`
	// Crowding 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.
	// It's used for improving result diversity.
	// This field is the maximum number of matches with the same crowding tag.
	PerCrowdingAttributeNeighborCount int32 `` /* 167-byte string literal not displayed */
	// The number of neighbors to find via approximate search before
	// exact reordering is performed. If not set, the default value from scam
	// config is used; if set, this value must be > 0.
	ApproximateNeighborCount int32 `` /* 136-byte string literal not displayed */
	// The fraction of the number of leaves to search, set at query time allows
	// user to tune search performance. This value increase result in both
	// search accuracy and latency increase. The value should be between 0.0
	// and 1.0. If not set or set to 0.0, query uses the default value specified
	// in
	// NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.
	FractionLeafNodesToSearchOverride float64 `` /* 170-byte string literal not displayed */
	// contains filtered or unexported fields
}

A query to find a number of the nearest neighbors (most similar vectors) of a vector.

func (*FindNeighborsRequest_Query) Descriptor deprecated added in v1.43.0

func (*FindNeighborsRequest_Query) Descriptor() ([]byte, []int)

Deprecated: Use FindNeighborsRequest_Query.ProtoReflect.Descriptor instead.

func (*FindNeighborsRequest_Query) GetApproximateNeighborCount added in v1.43.0

func (x *FindNeighborsRequest_Query) GetApproximateNeighborCount() int32

func (*FindNeighborsRequest_Query) GetDatapoint added in v1.43.0

func (x *FindNeighborsRequest_Query) GetDatapoint() *IndexDatapoint

func (*FindNeighborsRequest_Query) GetFractionLeafNodesToSearchOverride added in v1.43.0

func (x *FindNeighborsRequest_Query) GetFractionLeafNodesToSearchOverride() float64

func (*FindNeighborsRequest_Query) GetNeighborCount added in v1.43.0

func (x *FindNeighborsRequest_Query) GetNeighborCount() int32

func (*FindNeighborsRequest_Query) GetPerCrowdingAttributeNeighborCount added in v1.43.0

func (x *FindNeighborsRequest_Query) GetPerCrowdingAttributeNeighborCount() int32

func (*FindNeighborsRequest_Query) ProtoMessage added in v1.43.0

func (*FindNeighborsRequest_Query) ProtoMessage()

func (*FindNeighborsRequest_Query) ProtoReflect added in v1.43.0

func (*FindNeighborsRequest_Query) Reset added in v1.43.0

func (x *FindNeighborsRequest_Query) Reset()

func (*FindNeighborsRequest_Query) String added in v1.43.0

func (x *FindNeighborsRequest_Query) String() string

type FindNeighborsResponse added in v1.43.0

type FindNeighborsResponse struct {

	// The nearest neighbors of the query datapoints.
	NearestNeighbors []*FindNeighborsResponse_NearestNeighbors `protobuf:"bytes,1,rep,name=nearest_neighbors,json=nearestNeighbors,proto3" json:"nearest_neighbors,omitempty"`
	// contains filtered or unexported fields
}

The response message for [MatchService.FindNeighbors][google.cloud.aiplatform.v1.MatchService.FindNeighbors].

func (*FindNeighborsResponse) Descriptor deprecated added in v1.43.0

func (*FindNeighborsResponse) Descriptor() ([]byte, []int)

Deprecated: Use FindNeighborsResponse.ProtoReflect.Descriptor instead.

func (*FindNeighborsResponse) GetNearestNeighbors added in v1.43.0

func (*FindNeighborsResponse) ProtoMessage added in v1.43.0

func (*FindNeighborsResponse) ProtoMessage()

func (*FindNeighborsResponse) ProtoReflect added in v1.43.0

func (x *FindNeighborsResponse) ProtoReflect() protoreflect.Message

func (*FindNeighborsResponse) Reset added in v1.43.0

func (x *FindNeighborsResponse) Reset()

func (*FindNeighborsResponse) String added in v1.43.0

func (x *FindNeighborsResponse) String() string

type FindNeighborsResponse_NearestNeighbors added in v1.43.0

type FindNeighborsResponse_NearestNeighbors struct {

	// The ID of the query datapoint.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// All its neighbors.
	Neighbors []*FindNeighborsResponse_Neighbor `protobuf:"bytes,2,rep,name=neighbors,proto3" json:"neighbors,omitempty"`
	// contains filtered or unexported fields
}

Nearest neighbors for one query.

func (*FindNeighborsResponse_NearestNeighbors) Descriptor deprecated added in v1.43.0

func (*FindNeighborsResponse_NearestNeighbors) Descriptor() ([]byte, []int)

Deprecated: Use FindNeighborsResponse_NearestNeighbors.ProtoReflect.Descriptor instead.

func (*FindNeighborsResponse_NearestNeighbors) GetId added in v1.43.0

func (*FindNeighborsResponse_NearestNeighbors) GetNeighbors added in v1.43.0

func (*FindNeighborsResponse_NearestNeighbors) ProtoMessage added in v1.43.0

func (*FindNeighborsResponse_NearestNeighbors) ProtoReflect added in v1.43.0

func (*FindNeighborsResponse_NearestNeighbors) Reset added in v1.43.0

func (*FindNeighborsResponse_NearestNeighbors) String added in v1.43.0

type FindNeighborsResponse_Neighbor added in v1.43.0

type FindNeighborsResponse_Neighbor struct {

	// The datapoint of the neighbor.
	// Note that full datapoints are returned only when "return_full_datapoint"
	// is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
	// fields are populated.
	Datapoint *IndexDatapoint `protobuf:"bytes,1,opt,name=datapoint,proto3" json:"datapoint,omitempty"`
	// The distance between the neighbor and the query vector.
	Distance float64 `protobuf:"fixed64,2,opt,name=distance,proto3" json:"distance,omitempty"`
	// contains filtered or unexported fields
}

A neighbor of the query vector.

func (*FindNeighborsResponse_Neighbor) Descriptor deprecated added in v1.43.0

func (*FindNeighborsResponse_Neighbor) Descriptor() ([]byte, []int)

Deprecated: Use FindNeighborsResponse_Neighbor.ProtoReflect.Descriptor instead.

func (*FindNeighborsResponse_Neighbor) GetDatapoint added in v1.43.0

func (*FindNeighborsResponse_Neighbor) GetDistance added in v1.43.0

func (x *FindNeighborsResponse_Neighbor) GetDistance() float64

func (*FindNeighborsResponse_Neighbor) ProtoMessage added in v1.43.0

func (*FindNeighborsResponse_Neighbor) ProtoMessage()

func (*FindNeighborsResponse_Neighbor) ProtoReflect added in v1.43.0

func (*FindNeighborsResponse_Neighbor) Reset added in v1.43.0

func (x *FindNeighborsResponse_Neighbor) Reset()

func (*FindNeighborsResponse_Neighbor) String added in v1.43.0

type FractionSplit

type FractionSplit struct {

	// The fraction of the input data that is to be used to train the Model.
	TrainingFraction float64 `protobuf:"fixed64,1,opt,name=training_fraction,json=trainingFraction,proto3" json:"training_fraction,omitempty"`
	// The fraction of the input data that is to be used to validate the Model.
	ValidationFraction float64 `protobuf:"fixed64,2,opt,name=validation_fraction,json=validationFraction,proto3" json:"validation_fraction,omitempty"`
	// The fraction of the input data that is to be used to evaluate the Model.
	TestFraction float64 `protobuf:"fixed64,3,opt,name=test_fraction,json=testFraction,proto3" json:"test_fraction,omitempty"`
	// contains filtered or unexported fields
}

Assigns the input data to training, validation, and test sets as per the given fractions. Any of `training_fraction`, `validation_fraction` and `test_fraction` may optionally be provided, they must sum to up to 1. If the provided ones sum to less than 1, the remainder is assigned to sets as decided by Vertex AI. If none of the fractions are set, by default roughly 80% of data is used for training, 10% for validation, and 10% for test.

func (*FractionSplit) Descriptor deprecated

func (*FractionSplit) Descriptor() ([]byte, []int)

Deprecated: Use FractionSplit.ProtoReflect.Descriptor instead.

func (*FractionSplit) GetTestFraction

func (x *FractionSplit) GetTestFraction() float64

func (*FractionSplit) GetTrainingFraction

func (x *FractionSplit) GetTrainingFraction() float64

func (*FractionSplit) GetValidationFraction

func (x *FractionSplit) GetValidationFraction() float64

func (*FractionSplit) ProtoMessage

func (*FractionSplit) ProtoMessage()

func (*FractionSplit) ProtoReflect

func (x *FractionSplit) ProtoReflect() protoreflect.Message

func (*FractionSplit) Reset

func (x *FractionSplit) Reset()

func (*FractionSplit) String

func (x *FractionSplit) String() string

type FunctionCall added in v1.57.0

type FunctionCall struct {

	// Required. The name of the function to call.
	// Matches [FunctionDeclaration.name].
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Required. The function parameters and values in JSON object
	// format. See [FunctionDeclaration.parameters] for parameter details.
	Args *structpb.Struct `protobuf:"bytes,2,opt,name=args,proto3" json:"args,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*FunctionCall) Descriptor deprecated added in v1.57.0

func (*FunctionCall) Descriptor() ([]byte, []int)

Deprecated: Use FunctionCall.ProtoReflect.Descriptor instead.

func (*FunctionCall) GetArgs added in v1.57.0

func (x *FunctionCall) GetArgs() *structpb.Struct

func (*FunctionCall) GetName added in v1.57.0

func (x *FunctionCall) GetName() string

func (*FunctionCall) ProtoMessage added in v1.57.0

func (*FunctionCall) ProtoMessage()

func (*FunctionCall) ProtoReflect added in v1.57.0

func (x *FunctionCall) ProtoReflect() protoreflect.Message

func (*FunctionCall) Reset added in v1.57.0

func (x *FunctionCall) Reset()

func (*FunctionCall) String added in v1.57.0

func (x *FunctionCall) String() string

type FunctionDeclaration added in v1.57.0

type FunctionDeclaration struct {

	// Required. The name of the function to call.
	// Must start with a letter or an underscore.
	// Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a
	// maximum length of 64.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Description and purpose of the function.
	// Model uses it to decide how and whether to call the function.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. Describes the parameters to this function in JSON Schema Object
	// format. Reflects the Open API 3.03 Parameter Object. string Key: the name
	// of the parameter. Parameter names are case sensitive. Schema Value: the
	// Schema defining the type used for the parameter. For function with no
	// parameters, this can be left unset. Parameter names must start with a
	// letter or an underscore and must only contain chars a-z, A-Z, 0-9, or
	// underscores with a maximum length of 64. Example with 1 required and 1
	// optional parameter: type: OBJECT properties:
	//
	//	param1:
	//	  type: STRING
	//	param2:
	//	  type: INTEGER
	//
	// required:
	//   - param1
	Parameters *Schema `protobuf:"bytes,3,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.

func (*FunctionDeclaration) Descriptor deprecated added in v1.57.0

func (*FunctionDeclaration) Descriptor() ([]byte, []int)

Deprecated: Use FunctionDeclaration.ProtoReflect.Descriptor instead.

func (*FunctionDeclaration) GetDescription added in v1.57.0

func (x *FunctionDeclaration) GetDescription() string

func (*FunctionDeclaration) GetName added in v1.57.0

func (x *FunctionDeclaration) GetName() string

func (*FunctionDeclaration) GetParameters added in v1.57.0

func (x *FunctionDeclaration) GetParameters() *Schema

func (*FunctionDeclaration) ProtoMessage added in v1.57.0

func (*FunctionDeclaration) ProtoMessage()

func (*FunctionDeclaration) ProtoReflect added in v1.57.0

func (x *FunctionDeclaration) ProtoReflect() protoreflect.Message

func (*FunctionDeclaration) Reset added in v1.57.0

func (x *FunctionDeclaration) Reset()

func (*FunctionDeclaration) String added in v1.57.0

func (x *FunctionDeclaration) String() string

type FunctionResponse added in v1.57.0

type FunctionResponse struct {

	// Required. The name of the function to call.
	// Matches [FunctionDeclaration.name] and [FunctionCall.name].
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The function response in JSON object format.
	Response *structpb.Struct `protobuf:"bytes,2,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

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. This should contain the result of a FunctionCall made based on model prediction.

func (*FunctionResponse) Descriptor deprecated added in v1.57.0

func (*FunctionResponse) Descriptor() ([]byte, []int)

Deprecated: Use FunctionResponse.ProtoReflect.Descriptor instead.

func (*FunctionResponse) GetName added in v1.57.0

func (x *FunctionResponse) GetName() string

func (*FunctionResponse) GetResponse added in v1.57.0

func (x *FunctionResponse) GetResponse() *structpb.Struct

func (*FunctionResponse) ProtoMessage added in v1.57.0

func (*FunctionResponse) ProtoMessage()

func (*FunctionResponse) ProtoReflect added in v1.57.0

func (x *FunctionResponse) ProtoReflect() protoreflect.Message

func (*FunctionResponse) Reset added in v1.57.0

func (x *FunctionResponse) Reset()

func (*FunctionResponse) String added in v1.57.0

func (x *FunctionResponse) String() string

type GcsDestination

type GcsDestination struct {

	// Required. Google Cloud Storage URI to output directory. If the uri doesn't
	// end with
	// '/', a '/' will be automatically appended. The directory is created if it
	// doesn't exist.
	OutputUriPrefix string `protobuf:"bytes,1,opt,name=output_uri_prefix,json=outputUriPrefix,proto3" json:"output_uri_prefix,omitempty"`
	// contains filtered or unexported fields
}

The Google Cloud Storage location where the output is to be written to.

func (*GcsDestination) Descriptor deprecated

func (*GcsDestination) Descriptor() ([]byte, []int)

Deprecated: Use GcsDestination.ProtoReflect.Descriptor instead.

func (*GcsDestination) GetOutputUriPrefix

func (x *GcsDestination) GetOutputUriPrefix() string

func (*GcsDestination) ProtoMessage

func (*GcsDestination) ProtoMessage()

func (*GcsDestination) ProtoReflect

func (x *GcsDestination) ProtoReflect() protoreflect.Message

func (*GcsDestination) Reset

func (x *GcsDestination) Reset()

func (*GcsDestination) String

func (x *GcsDestination) String() string

type GcsSource

type GcsSource struct {

	// Required. Google Cloud Storage URI(-s) to the input file(s). May contain
	// wildcards. For more information on wildcards, see
	// https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
	Uris []string `protobuf:"bytes,1,rep,name=uris,proto3" json:"uris,omitempty"`
	// contains filtered or unexported fields
}

The Google Cloud Storage location for the input content.

func (*GcsSource) Descriptor deprecated

func (*GcsSource) Descriptor() ([]byte, []int)

Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.

func (*GcsSource) GetUris

func (x *GcsSource) GetUris() []string

func (*GcsSource) ProtoMessage

func (*GcsSource) ProtoMessage()

func (*GcsSource) ProtoReflect

func (x *GcsSource) ProtoReflect() protoreflect.Message

func (*GcsSource) Reset

func (x *GcsSource) Reset()

func (*GcsSource) String

func (x *GcsSource) String() string

type GenAiTuningServiceClient added in v1.67.0

type GenAiTuningServiceClient interface {
	// Creates a TuningJob. A created TuningJob right away will be attempted to
	// be run.
	CreateTuningJob(ctx context.Context, in *CreateTuningJobRequest, opts ...grpc.CallOption) (*TuningJob, error)
	// Gets a TuningJob.
	GetTuningJob(ctx context.Context, in *GetTuningJobRequest, opts ...grpc.CallOption) (*TuningJob, error)
	// Lists TuningJobs in a Location.
	ListTuningJobs(ctx context.Context, in *ListTuningJobsRequest, opts ...grpc.CallOption) (*ListTuningJobsResponse, error)
	// Cancels a TuningJob.
	// Starts asynchronous cancellation on the TuningJob. The server makes a best
	// effort to cancel the job, but success is not guaranteed. Clients can use
	// [GenAiTuningService.GetTuningJob][google.cloud.aiplatform.v1.GenAiTuningService.GetTuningJob]
	// or other methods to check whether the cancellation succeeded or whether the
	// job completed despite cancellation. On successful cancellation, the
	// TuningJob is not deleted; instead it becomes a job with a
	// [TuningJob.error][google.cloud.aiplatform.v1.TuningJob.error] value with a
	// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
	// `Code.CANCELLED`, and
	// [TuningJob.state][google.cloud.aiplatform.v1.TuningJob.state] is set to
	// `CANCELLED`.
	CancelTuningJob(ctx context.Context, in *CancelTuningJobRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

GenAiTuningServiceClient is the client API for GenAiTuningService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewGenAiTuningServiceClient added in v1.67.0

func NewGenAiTuningServiceClient(cc grpc.ClientConnInterface) GenAiTuningServiceClient

type GenAiTuningServiceServer added in v1.67.0

type GenAiTuningServiceServer interface {
	// Creates a TuningJob. A created TuningJob right away will be attempted to
	// be run.
	CreateTuningJob(context.Context, *CreateTuningJobRequest) (*TuningJob, error)
	// Gets a TuningJob.
	GetTuningJob(context.Context, *GetTuningJobRequest) (*TuningJob, error)
	// Lists TuningJobs in a Location.
	ListTuningJobs(context.Context, *ListTuningJobsRequest) (*ListTuningJobsResponse, error)
	// Cancels a TuningJob.
	// Starts asynchronous cancellation on the TuningJob. The server makes a best
	// effort to cancel the job, but success is not guaranteed. Clients can use
	// [GenAiTuningService.GetTuningJob][google.cloud.aiplatform.v1.GenAiTuningService.GetTuningJob]
	// or other methods to check whether the cancellation succeeded or whether the
	// job completed despite cancellation. On successful cancellation, the
	// TuningJob is not deleted; instead it becomes a job with a
	// [TuningJob.error][google.cloud.aiplatform.v1.TuningJob.error] value with a
	// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
	// `Code.CANCELLED`, and
	// [TuningJob.state][google.cloud.aiplatform.v1.TuningJob.state] is set to
	// `CANCELLED`.
	CancelTuningJob(context.Context, *CancelTuningJobRequest) (*emptypb.Empty, error)
}

GenAiTuningServiceServer is the server API for GenAiTuningService service.

type GenerateContentRequest added in v1.57.0

type GenerateContentRequest struct {

	// Required. The name of the publisher model requested to serve the
	// prediction. Format:
	// `projects/{project}/locations/{location}/publishers/*/models/*`
	Model string `protobuf:"bytes,5,opt,name=model,proto3" json:"model,omitempty"`
	// Required. The content of the current conversation with the model.
	//
	// For single-turn queries, this is a single instance. For multi-turn queries,
	// this is a repeated field that contains conversation history + latest
	// request.
	Contents []*Content `protobuf:"bytes,2,rep,name=contents,proto3" json:"contents,omitempty"`
	// Optional. The user provided system instructions for the model.
	// Note: only text should be used in parts and content in each part will be in
	// a separate paragraph.
	SystemInstruction *Content `protobuf:"bytes,8,opt,name=system_instruction,json=systemInstruction,proto3,oneof" json:"system_instruction,omitempty"`
	// Optional. A list of `Tools` the model may use to generate the next
	// response.
	//
	// A `Tool` is a piece of code that enables the system to interact with
	// external systems to perform an action, or set of actions, outside of
	// knowledge and scope of the model.
	Tools []*Tool `protobuf:"bytes,6,rep,name=tools,proto3" json:"tools,omitempty"`
	// Optional. Per request settings for blocking unsafe content.
	// Enforced on GenerateContentResponse.candidates.
	SafetySettings []*SafetySetting `protobuf:"bytes,3,rep,name=safety_settings,json=safetySettings,proto3" json:"safety_settings,omitempty"`
	// Optional. Generation config.
	GenerationConfig *GenerationConfig `protobuf:"bytes,4,opt,name=generation_config,json=generationConfig,proto3" json:"generation_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.GenerateContent].

func (*GenerateContentRequest) Descriptor deprecated added in v1.57.0

func (*GenerateContentRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateContentRequest.ProtoReflect.Descriptor instead.

func (*GenerateContentRequest) GetContents added in v1.57.0

func (x *GenerateContentRequest) GetContents() []*Content

func (*GenerateContentRequest) GetGenerationConfig added in v1.57.0

func (x *GenerateContentRequest) GetGenerationConfig() *GenerationConfig

func (*GenerateContentRequest) GetModel added in v1.57.0

func (x *GenerateContentRequest) GetModel() string

func (*GenerateContentRequest) GetSafetySettings added in v1.57.0

func (x *GenerateContentRequest) GetSafetySettings() []*SafetySetting

func (*GenerateContentRequest) GetSystemInstruction added in v1.67.0

func (x *GenerateContentRequest) GetSystemInstruction() *Content

func (*GenerateContentRequest) GetTools added in v1.57.0

func (x *GenerateContentRequest) GetTools() []*Tool

func (*GenerateContentRequest) ProtoMessage added in v1.57.0

func (*GenerateContentRequest) ProtoMessage()

func (*GenerateContentRequest) ProtoReflect added in v1.57.0

func (x *GenerateContentRequest) ProtoReflect() protoreflect.Message

func (*GenerateContentRequest) Reset added in v1.57.0

func (x *GenerateContentRequest) Reset()

func (*GenerateContentRequest) String added in v1.57.0

func (x *GenerateContentRequest) String() string

type GenerateContentResponse added in v1.57.0

type GenerateContentResponse struct {

	// Output only. Generated candidates.
	Candidates []*Candidate `protobuf:"bytes,2,rep,name=candidates,proto3" json:"candidates,omitempty"`
	// Output only. Content filter results for a prompt sent in the request.
	// Note: Sent only in the first stream chunk.
	// Only happens when no candidates were generated due to content violations.
	PromptFeedback *GenerateContentResponse_PromptFeedback `protobuf:"bytes,3,opt,name=prompt_feedback,json=promptFeedback,proto3" json:"prompt_feedback,omitempty"`
	// Usage metadata about the response(s).
	UsageMetadata *GenerateContentResponse_UsageMetadata `protobuf:"bytes,4,opt,name=usage_metadata,json=usageMetadata,proto3" json:"usage_metadata,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.GenerateContent].

func (*GenerateContentResponse) Descriptor deprecated added in v1.57.0

func (*GenerateContentResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateContentResponse.ProtoReflect.Descriptor instead.

func (*GenerateContentResponse) GetCandidates added in v1.57.0

func (x *GenerateContentResponse) GetCandidates() []*Candidate

func (*GenerateContentResponse) GetPromptFeedback added in v1.57.0

func (*GenerateContentResponse) GetUsageMetadata added in v1.57.0

func (*GenerateContentResponse) ProtoMessage added in v1.57.0

func (*GenerateContentResponse) ProtoMessage()

func (*GenerateContentResponse) ProtoReflect added in v1.57.0

func (x *GenerateContentResponse) ProtoReflect() protoreflect.Message

func (*GenerateContentResponse) Reset added in v1.57.0

func (x *GenerateContentResponse) Reset()

func (*GenerateContentResponse) String added in v1.57.0

func (x *GenerateContentResponse) String() string

type GenerateContentResponse_PromptFeedback added in v1.57.0

type GenerateContentResponse_PromptFeedback struct {

	// Output only. Blocked reason.
	BlockReason GenerateContentResponse_PromptFeedback_BlockedReason `` /* 180-byte string literal not displayed */
	// Output only. Safety ratings.
	SafetyRatings []*SafetyRating `protobuf:"bytes,2,rep,name=safety_ratings,json=safetyRatings,proto3" json:"safety_ratings,omitempty"`
	// Output only. A readable block reason message.
	BlockReasonMessage string `protobuf:"bytes,3,opt,name=block_reason_message,json=blockReasonMessage,proto3" json:"block_reason_message,omitempty"`
	// contains filtered or unexported fields
}

Content filter results for a prompt sent in the request.

func (*GenerateContentResponse_PromptFeedback) Descriptor deprecated added in v1.57.0

func (*GenerateContentResponse_PromptFeedback) Descriptor() ([]byte, []int)

Deprecated: Use GenerateContentResponse_PromptFeedback.ProtoReflect.Descriptor instead.

func (*GenerateContentResponse_PromptFeedback) GetBlockReason added in v1.57.0

func (*GenerateContentResponse_PromptFeedback) GetBlockReasonMessage added in v1.57.0

func (x *GenerateContentResponse_PromptFeedback) GetBlockReasonMessage() string

func (*GenerateContentResponse_PromptFeedback) GetSafetyRatings added in v1.57.0

func (x *GenerateContentResponse_PromptFeedback) GetSafetyRatings() []*SafetyRating

func (*GenerateContentResponse_PromptFeedback) ProtoMessage added in v1.57.0

func (*GenerateContentResponse_PromptFeedback) ProtoReflect added in v1.57.0

func (*GenerateContentResponse_PromptFeedback) Reset added in v1.57.0

func (*GenerateContentResponse_PromptFeedback) String added in v1.57.0

type GenerateContentResponse_PromptFeedback_BlockedReason added in v1.57.0

type GenerateContentResponse_PromptFeedback_BlockedReason int32

Blocked reason enumeration.

const (
	// Unspecified blocked reason.
	GenerateContentResponse_PromptFeedback_BLOCKED_REASON_UNSPECIFIED GenerateContentResponse_PromptFeedback_BlockedReason = 0
	// Candidates blocked due to safety.
	GenerateContentResponse_PromptFeedback_SAFETY GenerateContentResponse_PromptFeedback_BlockedReason = 1
	// Candidates blocked due to other reason.
	GenerateContentResponse_PromptFeedback_OTHER GenerateContentResponse_PromptFeedback_BlockedReason = 2
	// Candidates blocked due to the terms which are included from the
	// terminology blocklist.
	GenerateContentResponse_PromptFeedback_BLOCKLIST GenerateContentResponse_PromptFeedback_BlockedReason = 3
	// Candidates blocked due to prohibited content.
	GenerateContentResponse_PromptFeedback_PROHIBITED_CONTENT GenerateContentResponse_PromptFeedback_BlockedReason = 4
)

func (GenerateContentResponse_PromptFeedback_BlockedReason) Descriptor added in v1.57.0

func (GenerateContentResponse_PromptFeedback_BlockedReason) Enum added in v1.57.0

func (GenerateContentResponse_PromptFeedback_BlockedReason) EnumDescriptor deprecated added in v1.57.0

Deprecated: Use GenerateContentResponse_PromptFeedback_BlockedReason.Descriptor instead.

func (GenerateContentResponse_PromptFeedback_BlockedReason) Number added in v1.57.0

func (GenerateContentResponse_PromptFeedback_BlockedReason) String added in v1.57.0

func (GenerateContentResponse_PromptFeedback_BlockedReason) Type added in v1.57.0

type GenerateContentResponse_UsageMetadata added in v1.57.0

type GenerateContentResponse_UsageMetadata struct {

	// Number of tokens in the request.
	PromptTokenCount int32 `protobuf:"varint,1,opt,name=prompt_token_count,json=promptTokenCount,proto3" json:"prompt_token_count,omitempty"`
	// Number of tokens in the response(s).
	CandidatesTokenCount int32 `protobuf:"varint,2,opt,name=candidates_token_count,json=candidatesTokenCount,proto3" json:"candidates_token_count,omitempty"`
	TotalTokenCount      int32 `protobuf:"varint,3,opt,name=total_token_count,json=totalTokenCount,proto3" json:"total_token_count,omitempty"`
	// contains filtered or unexported fields
}

Usage metadata about response(s).

func (*GenerateContentResponse_UsageMetadata) Descriptor deprecated added in v1.57.0

func (*GenerateContentResponse_UsageMetadata) Descriptor() ([]byte, []int)

Deprecated: Use GenerateContentResponse_UsageMetadata.ProtoReflect.Descriptor instead.

func (*GenerateContentResponse_UsageMetadata) GetCandidatesTokenCount added in v1.57.0

func (x *GenerateContentResponse_UsageMetadata) GetCandidatesTokenCount() int32

func (*GenerateContentResponse_UsageMetadata) GetPromptTokenCount added in v1.57.0

func (x *GenerateContentResponse_UsageMetadata) GetPromptTokenCount() int32

func (*GenerateContentResponse_UsageMetadata) GetTotalTokenCount added in v1.57.0

func (x *GenerateContentResponse_UsageMetadata) GetTotalTokenCount() int32

func (*GenerateContentResponse_UsageMetadata) ProtoMessage added in v1.57.0

func (*GenerateContentResponse_UsageMetadata) ProtoMessage()

func (*GenerateContentResponse_UsageMetadata) ProtoReflect added in v1.57.0

func (*GenerateContentResponse_UsageMetadata) Reset added in v1.57.0

func (*GenerateContentResponse_UsageMetadata) String added in v1.57.0

type GenerationConfig added in v1.57.0

type GenerationConfig struct {

	// Optional. Controls the randomness of predictions.
	Temperature *float32 `protobuf:"fixed32,1,opt,name=temperature,proto3,oneof" json:"temperature,omitempty"`
	// Optional. If specified, nucleus sampling will be used.
	TopP *float32 `protobuf:"fixed32,2,opt,name=top_p,json=topP,proto3,oneof" json:"top_p,omitempty"`
	// Optional. If specified, top-k sampling will be used.
	TopK *float32 `protobuf:"fixed32,3,opt,name=top_k,json=topK,proto3,oneof" json:"top_k,omitempty"`
	// Optional. Number of candidates to generate.
	CandidateCount *int32 `protobuf:"varint,4,opt,name=candidate_count,json=candidateCount,proto3,oneof" json:"candidate_count,omitempty"`
	// Optional. The maximum number of output tokens to generate per message.
	MaxOutputTokens *int32 `protobuf:"varint,5,opt,name=max_output_tokens,json=maxOutputTokens,proto3,oneof" json:"max_output_tokens,omitempty"`
	// Optional. Stop sequences.
	StopSequences []string `protobuf:"bytes,6,rep,name=stop_sequences,json=stopSequences,proto3" json:"stop_sequences,omitempty"`
	// Optional. Positive penalties.
	PresencePenalty *float32 `protobuf:"fixed32,8,opt,name=presence_penalty,json=presencePenalty,proto3,oneof" json:"presence_penalty,omitempty"`
	// Optional. Frequency penalties.
	FrequencyPenalty *float32 `protobuf:"fixed32,9,opt,name=frequency_penalty,json=frequencyPenalty,proto3,oneof" json:"frequency_penalty,omitempty"`
	// Optional. Output response mimetype of the generated candidate text.
	// Supported mimetype:
	// - `text/plain`: (default) Text output.
	// - `application/json`: JSON response in the candidates.
	// The model needs to be prompted to output the appropriate response type,
	// otherwise the behavior is undefined.
	// This is a preview feature.
	ResponseMimeType string `protobuf:"bytes,13,opt,name=response_mime_type,json=responseMimeType,proto3" json:"response_mime_type,omitempty"`
	// contains filtered or unexported fields
}

Generation config.

func (*GenerationConfig) Descriptor deprecated added in v1.57.0

func (*GenerationConfig) Descriptor() ([]byte, []int)

Deprecated: Use GenerationConfig.ProtoReflect.Descriptor instead.

func (*GenerationConfig) GetCandidateCount added in v1.57.0

func (x *GenerationConfig) GetCandidateCount() int32

func (*GenerationConfig) GetFrequencyPenalty added in v1.67.0

func (x *GenerationConfig) GetFrequencyPenalty() float32

func (*GenerationConfig) GetMaxOutputTokens added in v1.57.0

func (x *GenerationConfig) GetMaxOutputTokens() int32

func (*GenerationConfig) GetPresencePenalty added in v1.67.0

func (x *GenerationConfig) GetPresencePenalty() float32

func (*GenerationConfig) GetResponseMimeType added in v1.67.0

func (x *GenerationConfig) GetResponseMimeType() string

func (*GenerationConfig) GetStopSequences added in v1.57.0

func (x *GenerationConfig) GetStopSequences() []string

func (*GenerationConfig) GetTemperature added in v1.57.0

func (x *GenerationConfig) GetTemperature() float32

func (*GenerationConfig) GetTopK added in v1.57.0

func (x *GenerationConfig) GetTopK() float32

func (*GenerationConfig) GetTopP added in v1.57.0

func (x *GenerationConfig) GetTopP() float32

func (*GenerationConfig) ProtoMessage added in v1.57.0

func (*GenerationConfig) ProtoMessage()

func (*GenerationConfig) ProtoReflect added in v1.57.0

func (x *GenerationConfig) ProtoReflect() protoreflect.Message

func (*GenerationConfig) Reset added in v1.57.0

func (x *GenerationConfig) Reset()

func (*GenerationConfig) String added in v1.57.0

func (x *GenerationConfig) String() string

type GenericOperationMetadata

type GenericOperationMetadata struct {

	// Output only. Partial failures encountered.
	// E.g. single files that couldn't be read.
	// This field should never exceed 20 entries.
	// Status details field will contain standard Google Cloud error details.
	PartialFailures []*status.Status `protobuf:"bytes,1,rep,name=partial_failures,json=partialFailures,proto3" json:"partial_failures,omitempty"`
	// Output only. Time when the operation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Time when the operation was updated for the last time.
	// If the operation has finished (successfully or not), this is the finish
	// time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Generic Metadata shared by all operations.

func (*GenericOperationMetadata) Descriptor deprecated

func (*GenericOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use GenericOperationMetadata.ProtoReflect.Descriptor instead.

func (*GenericOperationMetadata) GetCreateTime

func (x *GenericOperationMetadata) GetCreateTime() *timestamppb.Timestamp

func (*GenericOperationMetadata) GetPartialFailures

func (x *GenericOperationMetadata) GetPartialFailures() []*status.Status

func (*GenericOperationMetadata) GetUpdateTime

func (x *GenericOperationMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*GenericOperationMetadata) ProtoMessage

func (*GenericOperationMetadata) ProtoMessage()

func (*GenericOperationMetadata) ProtoReflect

func (x *GenericOperationMetadata) ProtoReflect() protoreflect.Message

func (*GenericOperationMetadata) Reset

func (x *GenericOperationMetadata) Reset()

func (*GenericOperationMetadata) String

func (x *GenericOperationMetadata) String() string

type GenieSource added in v1.63.0

type GenieSource struct {

	// Required. The public base model URI.
	BaseModelUri string `protobuf:"bytes,1,opt,name=base_model_uri,json=baseModelUri,proto3" json:"base_model_uri,omitempty"`
	// contains filtered or unexported fields
}

Contains information about the source of the models generated from Generative AI Studio.

func (*GenieSource) Descriptor deprecated added in v1.63.0

func (*GenieSource) Descriptor() ([]byte, []int)

Deprecated: Use GenieSource.ProtoReflect.Descriptor instead.

func (*GenieSource) GetBaseModelUri added in v1.63.0

func (x *GenieSource) GetBaseModelUri() string

func (*GenieSource) ProtoMessage added in v1.63.0

func (*GenieSource) ProtoMessage()

func (*GenieSource) ProtoReflect added in v1.63.0

func (x *GenieSource) ProtoReflect() protoreflect.Message

func (*GenieSource) Reset added in v1.63.0

func (x *GenieSource) Reset()

func (*GenieSource) String added in v1.63.0

func (x *GenieSource) String() string

type GetAnnotationSpecRequest

type GetAnnotationSpecRequest struct {

	// Required. The name of the AnnotationSpec resource.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1.DatasetService.GetAnnotationSpec].

func (*GetAnnotationSpecRequest) Descriptor deprecated

func (*GetAnnotationSpecRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetAnnotationSpecRequest.ProtoReflect.Descriptor instead.

func (*GetAnnotationSpecRequest) GetName

func (x *GetAnnotationSpecRequest) GetName() string

func (*GetAnnotationSpecRequest) GetReadMask

func (*GetAnnotationSpecRequest) ProtoMessage

func (*GetAnnotationSpecRequest) ProtoMessage()

func (*GetAnnotationSpecRequest) ProtoReflect

func (x *GetAnnotationSpecRequest) ProtoReflect() protoreflect.Message

func (*GetAnnotationSpecRequest) Reset

func (x *GetAnnotationSpecRequest) Reset()

func (*GetAnnotationSpecRequest) String

func (x *GetAnnotationSpecRequest) String() string

type GetArtifactRequest

type GetArtifactRequest struct {

	// Required. The resource name of the Artifact to retrieve.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.GetArtifact][google.cloud.aiplatform.v1.MetadataService.GetArtifact].

func (*GetArtifactRequest) Descriptor deprecated

func (*GetArtifactRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetArtifactRequest.ProtoReflect.Descriptor instead.

func (*GetArtifactRequest) GetName

func (x *GetArtifactRequest) GetName() string

func (*GetArtifactRequest) ProtoMessage

func (*GetArtifactRequest) ProtoMessage()

func (*GetArtifactRequest) ProtoReflect

func (x *GetArtifactRequest) ProtoReflect() protoreflect.Message

func (*GetArtifactRequest) Reset

func (x *GetArtifactRequest) Reset()

func (*GetArtifactRequest) String

func (x *GetArtifactRequest) String() string

type GetBatchPredictionJobRequest

type GetBatchPredictionJobRequest struct {

	// Required. The name of the BatchPredictionJob resource.
	// Format:
	// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob].

func (*GetBatchPredictionJobRequest) Descriptor deprecated

func (*GetBatchPredictionJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetBatchPredictionJobRequest.ProtoReflect.Descriptor instead.

func (*GetBatchPredictionJobRequest) GetName

func (x *GetBatchPredictionJobRequest) GetName() string

func (*GetBatchPredictionJobRequest) ProtoMessage

func (*GetBatchPredictionJobRequest) ProtoMessage()

func (*GetBatchPredictionJobRequest) ProtoReflect

func (*GetBatchPredictionJobRequest) Reset

func (x *GetBatchPredictionJobRequest) Reset()

func (*GetBatchPredictionJobRequest) String

type GetContextRequest

type GetContextRequest struct {

	// Required. The resource name of the Context to retrieve.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.GetContext][google.cloud.aiplatform.v1.MetadataService.GetContext].

func (*GetContextRequest) Descriptor deprecated

func (*GetContextRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetContextRequest.ProtoReflect.Descriptor instead.

func (*GetContextRequest) GetName

func (x *GetContextRequest) GetName() string

func (*GetContextRequest) ProtoMessage

func (*GetContextRequest) ProtoMessage()

func (*GetContextRequest) ProtoReflect

func (x *GetContextRequest) ProtoReflect() protoreflect.Message

func (*GetContextRequest) Reset

func (x *GetContextRequest) Reset()

func (*GetContextRequest) String

func (x *GetContextRequest) String() string

type GetCustomJobRequest

type GetCustomJobRequest struct {

	// Required. The name of the CustomJob resource.
	// Format:
	// `projects/{project}/locations/{location}/customJobs/{custom_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob].

func (*GetCustomJobRequest) Descriptor deprecated

func (*GetCustomJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetCustomJobRequest.ProtoReflect.Descriptor instead.

func (*GetCustomJobRequest) GetName

func (x *GetCustomJobRequest) GetName() string

func (*GetCustomJobRequest) ProtoMessage

func (*GetCustomJobRequest) ProtoMessage()

func (*GetCustomJobRequest) ProtoReflect

func (x *GetCustomJobRequest) ProtoReflect() protoreflect.Message

func (*GetCustomJobRequest) Reset

func (x *GetCustomJobRequest) Reset()

func (*GetCustomJobRequest) String

func (x *GetCustomJobRequest) String() string

type GetDataLabelingJobRequest

type GetDataLabelingJobRequest struct {

	// Required. The name of the DataLabelingJob.
	// Format:
	// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.GetDataLabelingJob][google.cloud.aiplatform.v1.JobService.GetDataLabelingJob].

func (*GetDataLabelingJobRequest) Descriptor deprecated

func (*GetDataLabelingJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDataLabelingJobRequest.ProtoReflect.Descriptor instead.

func (*GetDataLabelingJobRequest) GetName

func (x *GetDataLabelingJobRequest) GetName() string

func (*GetDataLabelingJobRequest) ProtoMessage

func (*GetDataLabelingJobRequest) ProtoMessage()

func (*GetDataLabelingJobRequest) ProtoReflect

func (*GetDataLabelingJobRequest) Reset

func (x *GetDataLabelingJobRequest) Reset()

func (*GetDataLabelingJobRequest) String

func (x *GetDataLabelingJobRequest) String() string

type GetDatasetRequest

type GetDatasetRequest struct {

	// Required. The name of the Dataset resource.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.GetDataset][google.cloud.aiplatform.v1.DatasetService.GetDataset].

func (*GetDatasetRequest) Descriptor deprecated

func (*GetDatasetRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDatasetRequest.ProtoReflect.Descriptor instead.

func (*GetDatasetRequest) GetName

func (x *GetDatasetRequest) GetName() string

func (*GetDatasetRequest) GetReadMask

func (x *GetDatasetRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*GetDatasetRequest) ProtoMessage

func (*GetDatasetRequest) ProtoMessage()

func (*GetDatasetRequest) ProtoReflect

func (x *GetDatasetRequest) ProtoReflect() protoreflect.Message

func (*GetDatasetRequest) Reset

func (x *GetDatasetRequest) Reset()

func (*GetDatasetRequest) String

func (x *GetDatasetRequest) String() string

type GetDatasetVersionRequest added in v1.51.0

type GetDatasetVersionRequest struct {

	// Required. The resource name of the Dataset version to delete.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.GetDatasetVersion][google.cloud.aiplatform.v1.DatasetService.GetDatasetVersion].

func (*GetDatasetVersionRequest) Descriptor deprecated added in v1.51.0

func (*GetDatasetVersionRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDatasetVersionRequest.ProtoReflect.Descriptor instead.

func (*GetDatasetVersionRequest) GetName added in v1.51.0

func (x *GetDatasetVersionRequest) GetName() string

func (*GetDatasetVersionRequest) GetReadMask added in v1.51.0

func (*GetDatasetVersionRequest) ProtoMessage added in v1.51.0

func (*GetDatasetVersionRequest) ProtoMessage()

func (*GetDatasetVersionRequest) ProtoReflect added in v1.51.0

func (x *GetDatasetVersionRequest) ProtoReflect() protoreflect.Message

func (*GetDatasetVersionRequest) Reset added in v1.51.0

func (x *GetDatasetVersionRequest) Reset()

func (*GetDatasetVersionRequest) String added in v1.51.0

func (x *GetDatasetVersionRequest) String() string

type GetDeploymentResourcePoolRequest added in v1.57.0

type GetDeploymentResourcePoolRequest struct {

	// Required. The name of the DeploymentResourcePool to retrieve.
	// Format:
	// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetDeploymentResourcePool method.

func (*GetDeploymentResourcePoolRequest) Descriptor deprecated added in v1.57.0

func (*GetDeploymentResourcePoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDeploymentResourcePoolRequest.ProtoReflect.Descriptor instead.

func (*GetDeploymentResourcePoolRequest) GetName added in v1.57.0

func (*GetDeploymentResourcePoolRequest) ProtoMessage added in v1.57.0

func (*GetDeploymentResourcePoolRequest) ProtoMessage()

func (*GetDeploymentResourcePoolRequest) ProtoReflect added in v1.57.0

func (*GetDeploymentResourcePoolRequest) Reset added in v1.57.0

func (*GetDeploymentResourcePoolRequest) String added in v1.57.0

type GetEndpointRequest

type GetEndpointRequest struct {

	// Required. The name of the Endpoint resource.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EndpointService.GetEndpoint][google.cloud.aiplatform.v1.EndpointService.GetEndpoint]

func (*GetEndpointRequest) Descriptor deprecated

func (*GetEndpointRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetEndpointRequest.ProtoReflect.Descriptor instead.

func (*GetEndpointRequest) GetName

func (x *GetEndpointRequest) GetName() string

func (*GetEndpointRequest) ProtoMessage

func (*GetEndpointRequest) ProtoMessage()

func (*GetEndpointRequest) ProtoReflect

func (x *GetEndpointRequest) ProtoReflect() protoreflect.Message

func (*GetEndpointRequest) Reset

func (x *GetEndpointRequest) Reset()

func (*GetEndpointRequest) String

func (x *GetEndpointRequest) String() string

type GetEntityTypeRequest

type GetEntityTypeRequest struct {

	// Required. The name of the EntityType resource.
	// Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.GetEntityType][google.cloud.aiplatform.v1.FeaturestoreService.GetEntityType].

func (*GetEntityTypeRequest) Descriptor deprecated

func (*GetEntityTypeRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetEntityTypeRequest.ProtoReflect.Descriptor instead.

func (*GetEntityTypeRequest) GetName

func (x *GetEntityTypeRequest) GetName() string

func (*GetEntityTypeRequest) ProtoMessage

func (*GetEntityTypeRequest) ProtoMessage()

func (*GetEntityTypeRequest) ProtoReflect

func (x *GetEntityTypeRequest) ProtoReflect() protoreflect.Message

func (*GetEntityTypeRequest) Reset

func (x *GetEntityTypeRequest) Reset()

func (*GetEntityTypeRequest) String

func (x *GetEntityTypeRequest) String() string

type GetExecutionRequest

type GetExecutionRequest struct {

	// Required. The resource name of the Execution to retrieve.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.GetExecution][google.cloud.aiplatform.v1.MetadataService.GetExecution].

func (*GetExecutionRequest) Descriptor deprecated

func (*GetExecutionRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetExecutionRequest.ProtoReflect.Descriptor instead.

func (*GetExecutionRequest) GetName

func (x *GetExecutionRequest) GetName() string

func (*GetExecutionRequest) ProtoMessage

func (*GetExecutionRequest) ProtoMessage()

func (*GetExecutionRequest) ProtoReflect

func (x *GetExecutionRequest) ProtoReflect() protoreflect.Message

func (*GetExecutionRequest) Reset

func (x *GetExecutionRequest) Reset()

func (*GetExecutionRequest) String

func (x *GetExecutionRequest) String() string

type GetFeatureGroupRequest added in v1.54.0

type GetFeatureGroupRequest struct {

	// Required. The name of the FeatureGroup resource.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureRegistryService.GetFeatureGroup][google.cloud.aiplatform.v1.FeatureRegistryService.GetFeatureGroup].

func (*GetFeatureGroupRequest) Descriptor deprecated added in v1.54.0

func (*GetFeatureGroupRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetFeatureGroupRequest.ProtoReflect.Descriptor instead.

func (*GetFeatureGroupRequest) GetName added in v1.54.0

func (x *GetFeatureGroupRequest) GetName() string

func (*GetFeatureGroupRequest) ProtoMessage added in v1.54.0

func (*GetFeatureGroupRequest) ProtoMessage()

func (*GetFeatureGroupRequest) ProtoReflect added in v1.54.0

func (x *GetFeatureGroupRequest) ProtoReflect() protoreflect.Message

func (*GetFeatureGroupRequest) Reset added in v1.54.0

func (x *GetFeatureGroupRequest) Reset()

func (*GetFeatureGroupRequest) String added in v1.54.0

func (x *GetFeatureGroupRequest) String() string

type GetFeatureOnlineStoreRequest added in v1.54.0

type GetFeatureOnlineStoreRequest struct {

	// Required. The name of the FeatureOnlineStore resource.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.GetFeatureOnlineStore][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.GetFeatureOnlineStore].

func (*GetFeatureOnlineStoreRequest) Descriptor deprecated added in v1.54.0

func (*GetFeatureOnlineStoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetFeatureOnlineStoreRequest.ProtoReflect.Descriptor instead.

func (*GetFeatureOnlineStoreRequest) GetName added in v1.54.0

func (x *GetFeatureOnlineStoreRequest) GetName() string

func (*GetFeatureOnlineStoreRequest) ProtoMessage added in v1.54.0

func (*GetFeatureOnlineStoreRequest) ProtoMessage()

func (*GetFeatureOnlineStoreRequest) ProtoReflect added in v1.54.0

func (*GetFeatureOnlineStoreRequest) Reset added in v1.54.0

func (x *GetFeatureOnlineStoreRequest) Reset()

func (*GetFeatureOnlineStoreRequest) String added in v1.54.0

type GetFeatureRequest

type GetFeatureRequest struct {

	// Required. The name of the Feature resource.
	// Format for entity_type as parent:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
	// Format for feature_group as parent:
	// `projects/{project}/locations/{location}/featureGroups/{feature_group}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.GetFeature][google.cloud.aiplatform.v1.FeaturestoreService.GetFeature]. Request message for [FeatureRegistryService.GetFeature][google.cloud.aiplatform.v1.FeatureRegistryService.GetFeature].

func (*GetFeatureRequest) Descriptor deprecated

func (*GetFeatureRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetFeatureRequest.ProtoReflect.Descriptor instead.

func (*GetFeatureRequest) GetName

func (x *GetFeatureRequest) GetName() string

func (*GetFeatureRequest) ProtoMessage

func (*GetFeatureRequest) ProtoMessage()

func (*GetFeatureRequest) ProtoReflect

func (x *GetFeatureRequest) ProtoReflect() protoreflect.Message

func (*GetFeatureRequest) Reset

func (x *GetFeatureRequest) Reset()

func (*GetFeatureRequest) String

func (x *GetFeatureRequest) String() string

type GetFeatureViewRequest added in v1.54.0

type GetFeatureViewRequest struct {

	// Required. The name of the FeatureView resource.
	// Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.GetFeatureView][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.GetFeatureView].

func (*GetFeatureViewRequest) Descriptor deprecated added in v1.54.0

func (*GetFeatureViewRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetFeatureViewRequest.ProtoReflect.Descriptor instead.

func (*GetFeatureViewRequest) GetName added in v1.54.0

func (x *GetFeatureViewRequest) GetName() string

func (*GetFeatureViewRequest) ProtoMessage added in v1.54.0

func (*GetFeatureViewRequest) ProtoMessage()

func (*GetFeatureViewRequest) ProtoReflect added in v1.54.0

func (x *GetFeatureViewRequest) ProtoReflect() protoreflect.Message

func (*GetFeatureViewRequest) Reset added in v1.54.0

func (x *GetFeatureViewRequest) Reset()

func (*GetFeatureViewRequest) String added in v1.54.0

func (x *GetFeatureViewRequest) String() string

type GetFeatureViewSyncRequest added in v1.54.0

type GetFeatureViewSyncRequest struct {

	// Required. The name of the FeatureViewSync resource.
	// Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.GetFeatureViewSync][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.GetFeatureViewSync].

func (*GetFeatureViewSyncRequest) Descriptor deprecated added in v1.54.0

func (*GetFeatureViewSyncRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetFeatureViewSyncRequest.ProtoReflect.Descriptor instead.

func (*GetFeatureViewSyncRequest) GetName added in v1.54.0

func (x *GetFeatureViewSyncRequest) GetName() string

func (*GetFeatureViewSyncRequest) ProtoMessage added in v1.54.0

func (*GetFeatureViewSyncRequest) ProtoMessage()

func (*GetFeatureViewSyncRequest) ProtoReflect added in v1.54.0

func (*GetFeatureViewSyncRequest) Reset added in v1.54.0

func (x *GetFeatureViewSyncRequest) Reset()

func (*GetFeatureViewSyncRequest) String added in v1.54.0

func (x *GetFeatureViewSyncRequest) String() string

type GetFeaturestoreRequest

type GetFeaturestoreRequest struct {

	// Required. The name of the Featurestore resource.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.GetFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.GetFeaturestore].

func (*GetFeaturestoreRequest) Descriptor deprecated

func (*GetFeaturestoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetFeaturestoreRequest.ProtoReflect.Descriptor instead.

func (*GetFeaturestoreRequest) GetName

func (x *GetFeaturestoreRequest) GetName() string

func (*GetFeaturestoreRequest) ProtoMessage

func (*GetFeaturestoreRequest) ProtoMessage()

func (*GetFeaturestoreRequest) ProtoReflect

func (x *GetFeaturestoreRequest) ProtoReflect() protoreflect.Message

func (*GetFeaturestoreRequest) Reset

func (x *GetFeaturestoreRequest) Reset()

func (*GetFeaturestoreRequest) String

func (x *GetFeaturestoreRequest) String() string

type GetHyperparameterTuningJobRequest

type GetHyperparameterTuningJobRequest struct {

	// Required. The name of the HyperparameterTuningJob resource.
	// Format:
	// `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob].

func (*GetHyperparameterTuningJobRequest) Descriptor deprecated

func (*GetHyperparameterTuningJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetHyperparameterTuningJobRequest.ProtoReflect.Descriptor instead.

func (*GetHyperparameterTuningJobRequest) GetName

func (*GetHyperparameterTuningJobRequest) ProtoMessage

func (*GetHyperparameterTuningJobRequest) ProtoMessage()

func (*GetHyperparameterTuningJobRequest) ProtoReflect

func (*GetHyperparameterTuningJobRequest) Reset

func (*GetHyperparameterTuningJobRequest) String

type GetIndexEndpointRequest

type GetIndexEndpointRequest struct {

	// Required. The name of the IndexEndpoint resource.
	// Format:
	// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexEndpointService.GetIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.GetIndexEndpoint]

func (*GetIndexEndpointRequest) Descriptor deprecated

func (*GetIndexEndpointRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetIndexEndpointRequest.ProtoReflect.Descriptor instead.

func (*GetIndexEndpointRequest) GetName

func (x *GetIndexEndpointRequest) GetName() string

func (*GetIndexEndpointRequest) ProtoMessage

func (*GetIndexEndpointRequest) ProtoMessage()

func (*GetIndexEndpointRequest) ProtoReflect

func (x *GetIndexEndpointRequest) ProtoReflect() protoreflect.Message

func (*GetIndexEndpointRequest) Reset

func (x *GetIndexEndpointRequest) Reset()

func (*GetIndexEndpointRequest) String

func (x *GetIndexEndpointRequest) String() string

type GetIndexRequest

type GetIndexRequest struct {

	// Required. The name of the Index resource.
	// Format:
	// `projects/{project}/locations/{location}/indexes/{index}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexService.GetIndex][google.cloud.aiplatform.v1.IndexService.GetIndex]

func (*GetIndexRequest) Descriptor deprecated

func (*GetIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetIndexRequest.ProtoReflect.Descriptor instead.

func (*GetIndexRequest) GetName

func (x *GetIndexRequest) GetName() string

func (*GetIndexRequest) ProtoMessage

func (*GetIndexRequest) ProtoMessage()

func (*GetIndexRequest) ProtoReflect

func (x *GetIndexRequest) ProtoReflect() protoreflect.Message

func (*GetIndexRequest) Reset

func (x *GetIndexRequest) Reset()

func (*GetIndexRequest) String

func (x *GetIndexRequest) String() string

type GetMetadataSchemaRequest

type GetMetadataSchemaRequest struct {

	// Required. The resource name of the MetadataSchema to retrieve.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.GetMetadataSchema][google.cloud.aiplatform.v1.MetadataService.GetMetadataSchema].

func (*GetMetadataSchemaRequest) Descriptor deprecated

func (*GetMetadataSchemaRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetMetadataSchemaRequest.ProtoReflect.Descriptor instead.

func (*GetMetadataSchemaRequest) GetName

func (x *GetMetadataSchemaRequest) GetName() string

func (*GetMetadataSchemaRequest) ProtoMessage

func (*GetMetadataSchemaRequest) ProtoMessage()

func (*GetMetadataSchemaRequest) ProtoReflect

func (x *GetMetadataSchemaRequest) ProtoReflect() protoreflect.Message

func (*GetMetadataSchemaRequest) Reset

func (x *GetMetadataSchemaRequest) Reset()

func (*GetMetadataSchemaRequest) String

func (x *GetMetadataSchemaRequest) String() string

type GetMetadataStoreRequest

type GetMetadataStoreRequest struct {

	// Required. The resource name of the MetadataStore to retrieve.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.GetMetadataStore][google.cloud.aiplatform.v1.MetadataService.GetMetadataStore].

func (*GetMetadataStoreRequest) Descriptor deprecated

func (*GetMetadataStoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetMetadataStoreRequest.ProtoReflect.Descriptor instead.

func (*GetMetadataStoreRequest) GetName

func (x *GetMetadataStoreRequest) GetName() string

func (*GetMetadataStoreRequest) ProtoMessage

func (*GetMetadataStoreRequest) ProtoMessage()

func (*GetMetadataStoreRequest) ProtoReflect

func (x *GetMetadataStoreRequest) ProtoReflect() protoreflect.Message

func (*GetMetadataStoreRequest) Reset

func (x *GetMetadataStoreRequest) Reset()

func (*GetMetadataStoreRequest) String

func (x *GetMetadataStoreRequest) String() string

type GetModelDeploymentMonitoringJobRequest

type GetModelDeploymentMonitoringJobRequest struct {

	// Required. The resource name of the ModelDeploymentMonitoringJob.
	// Format:
	// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.GetModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.GetModelDeploymentMonitoringJob].

func (*GetModelDeploymentMonitoringJobRequest) Descriptor deprecated

func (*GetModelDeploymentMonitoringJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetModelDeploymentMonitoringJobRequest.ProtoReflect.Descriptor instead.

func (*GetModelDeploymentMonitoringJobRequest) GetName

func (*GetModelDeploymentMonitoringJobRequest) ProtoMessage

func (*GetModelDeploymentMonitoringJobRequest) ProtoReflect

func (*GetModelDeploymentMonitoringJobRequest) Reset

func (*GetModelDeploymentMonitoringJobRequest) String

type GetModelEvaluationRequest

type GetModelEvaluationRequest struct {

	// Required. The name of the ModelEvaluation resource.
	// Format:
	// `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.GetModelEvaluation][google.cloud.aiplatform.v1.ModelService.GetModelEvaluation].

func (*GetModelEvaluationRequest) Descriptor deprecated

func (*GetModelEvaluationRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetModelEvaluationRequest.ProtoReflect.Descriptor instead.

func (*GetModelEvaluationRequest) GetName

func (x *GetModelEvaluationRequest) GetName() string

func (*GetModelEvaluationRequest) ProtoMessage

func (*GetModelEvaluationRequest) ProtoMessage()

func (*GetModelEvaluationRequest) ProtoReflect

func (*GetModelEvaluationRequest) Reset

func (x *GetModelEvaluationRequest) Reset()

func (*GetModelEvaluationRequest) String

func (x *GetModelEvaluationRequest) String() string

type GetModelEvaluationSliceRequest

type GetModelEvaluationSliceRequest struct {

	// Required. The name of the ModelEvaluationSlice resource.
	// Format:
	// `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.GetModelEvaluationSlice][google.cloud.aiplatform.v1.ModelService.GetModelEvaluationSlice].

func (*GetModelEvaluationSliceRequest) Descriptor deprecated

func (*GetModelEvaluationSliceRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetModelEvaluationSliceRequest.ProtoReflect.Descriptor instead.

func (*GetModelEvaluationSliceRequest) GetName

func (*GetModelEvaluationSliceRequest) ProtoMessage

func (*GetModelEvaluationSliceRequest) ProtoMessage()

func (*GetModelEvaluationSliceRequest) ProtoReflect

func (*GetModelEvaluationSliceRequest) Reset

func (x *GetModelEvaluationSliceRequest) Reset()

func (*GetModelEvaluationSliceRequest) String

type GetModelRequest

type GetModelRequest struct {

	// Required. The name of the Model resource.
	// Format: `projects/{project}/locations/{location}/models/{model}`
	//
	// In order to retrieve a specific version of the model, also provide
	// the version ID or version alias.
	//
	//	Example: `projects/{project}/locations/{location}/models/{model}@2`
	//	           or
	//	         `projects/{project}/locations/{location}/models/{model}@golden`
	//
	// If no version ID or alias is specified, the "default" version will be
	// returned. The "default" version alias is created for the first version of
	// the model, and can be moved to other versions later on. There will be
	// exactly one default version.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.GetModel][google.cloud.aiplatform.v1.ModelService.GetModel].

func (*GetModelRequest) Descriptor deprecated

func (*GetModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetModelRequest.ProtoReflect.Descriptor instead.

func (*GetModelRequest) GetName

func (x *GetModelRequest) GetName() string

func (*GetModelRequest) ProtoMessage

func (*GetModelRequest) ProtoMessage()

func (*GetModelRequest) ProtoReflect

func (x *GetModelRequest) ProtoReflect() protoreflect.Message

func (*GetModelRequest) Reset

func (x *GetModelRequest) Reset()

func (*GetModelRequest) String

func (x *GetModelRequest) String() string

type GetNasJobRequest added in v1.34.0

type GetNasJobRequest struct {

	// Required. The name of the NasJob resource.
	// Format:
	// `projects/{project}/locations/{location}/nasJobs/{nas_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob].

func (*GetNasJobRequest) Descriptor deprecated added in v1.34.0

func (*GetNasJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetNasJobRequest.ProtoReflect.Descriptor instead.

func (*GetNasJobRequest) GetName added in v1.34.0

func (x *GetNasJobRequest) GetName() string

func (*GetNasJobRequest) ProtoMessage added in v1.34.0

func (*GetNasJobRequest) ProtoMessage()

func (*GetNasJobRequest) ProtoReflect added in v1.34.0

func (x *GetNasJobRequest) ProtoReflect() protoreflect.Message

func (*GetNasJobRequest) Reset added in v1.34.0

func (x *GetNasJobRequest) Reset()

func (*GetNasJobRequest) String added in v1.34.0

func (x *GetNasJobRequest) String() string

type GetNasTrialDetailRequest added in v1.34.0

type GetNasTrialDetailRequest struct {

	// Required. The name of the NasTrialDetail resource.
	// Format:
	// `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.GetNasTrialDetail][google.cloud.aiplatform.v1.JobService.GetNasTrialDetail].

func (*GetNasTrialDetailRequest) Descriptor deprecated added in v1.34.0

func (*GetNasTrialDetailRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetNasTrialDetailRequest.ProtoReflect.Descriptor instead.

func (*GetNasTrialDetailRequest) GetName added in v1.34.0

func (x *GetNasTrialDetailRequest) GetName() string

func (*GetNasTrialDetailRequest) ProtoMessage added in v1.34.0

func (*GetNasTrialDetailRequest) ProtoMessage()

func (*GetNasTrialDetailRequest) ProtoReflect added in v1.34.0

func (x *GetNasTrialDetailRequest) ProtoReflect() protoreflect.Message

func (*GetNasTrialDetailRequest) Reset added in v1.34.0

func (x *GetNasTrialDetailRequest) Reset()

func (*GetNasTrialDetailRequest) String added in v1.34.0

func (x *GetNasTrialDetailRequest) String() string

type GetNotebookRuntimeRequest added in v1.67.0

type GetNotebookRuntimeRequest struct {

	// Required. The name of the NotebookRuntime resource.
	// Instead of checking whether the name is in valid NotebookRuntime resource
	// name format, directly throw NotFound exception if there is no such
	// NotebookRuntime in spanner.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [NotebookService.GetNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.GetNotebookRuntime]

func (*GetNotebookRuntimeRequest) Descriptor deprecated added in v1.67.0

func (*GetNotebookRuntimeRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetNotebookRuntimeRequest.ProtoReflect.Descriptor instead.

func (*GetNotebookRuntimeRequest) GetName added in v1.67.0

func (x *GetNotebookRuntimeRequest) GetName() string

func (*GetNotebookRuntimeRequest) ProtoMessage added in v1.67.0

func (*GetNotebookRuntimeRequest) ProtoMessage()

func (*GetNotebookRuntimeRequest) ProtoReflect added in v1.67.0

func (*GetNotebookRuntimeRequest) Reset added in v1.67.0

func (x *GetNotebookRuntimeRequest) Reset()

func (*GetNotebookRuntimeRequest) String added in v1.67.0

func (x *GetNotebookRuntimeRequest) String() string

type GetNotebookRuntimeTemplateRequest added in v1.67.0

type GetNotebookRuntimeTemplateRequest struct {

	// Required. The name of the NotebookRuntimeTemplate resource.
	// Format:
	// `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [NotebookService.GetNotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookService.GetNotebookRuntimeTemplate]

func (*GetNotebookRuntimeTemplateRequest) Descriptor deprecated added in v1.67.0

func (*GetNotebookRuntimeTemplateRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetNotebookRuntimeTemplateRequest.ProtoReflect.Descriptor instead.

func (*GetNotebookRuntimeTemplateRequest) GetName added in v1.67.0

func (*GetNotebookRuntimeTemplateRequest) ProtoMessage added in v1.67.0

func (*GetNotebookRuntimeTemplateRequest) ProtoMessage()

func (*GetNotebookRuntimeTemplateRequest) ProtoReflect added in v1.67.0

func (*GetNotebookRuntimeTemplateRequest) Reset added in v1.67.0

func (*GetNotebookRuntimeTemplateRequest) String added in v1.67.0

type GetPersistentResourceRequest added in v1.67.0

type GetPersistentResourceRequest struct {

	// Required. The name of the PersistentResource resource.
	// Format:
	// `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PersistentResourceService.GetPersistentResource][google.cloud.aiplatform.v1.PersistentResourceService.GetPersistentResource].

func (*GetPersistentResourceRequest) Descriptor deprecated added in v1.67.0

func (*GetPersistentResourceRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetPersistentResourceRequest.ProtoReflect.Descriptor instead.

func (*GetPersistentResourceRequest) GetName added in v1.67.0

func (x *GetPersistentResourceRequest) GetName() string

func (*GetPersistentResourceRequest) ProtoMessage added in v1.67.0

func (*GetPersistentResourceRequest) ProtoMessage()

func (*GetPersistentResourceRequest) ProtoReflect added in v1.67.0

func (*GetPersistentResourceRequest) Reset added in v1.67.0

func (x *GetPersistentResourceRequest) Reset()

func (*GetPersistentResourceRequest) String added in v1.67.0

type GetPipelineJobRequest

type GetPipelineJobRequest struct {

	// Required. The name of the PipelineJob resource.
	// Format:
	// `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob].

func (*GetPipelineJobRequest) Descriptor deprecated

func (*GetPipelineJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetPipelineJobRequest.ProtoReflect.Descriptor instead.

func (*GetPipelineJobRequest) GetName

func (x *GetPipelineJobRequest) GetName() string

func (*GetPipelineJobRequest) ProtoMessage

func (*GetPipelineJobRequest) ProtoMessage()

func (*GetPipelineJobRequest) ProtoReflect

func (x *GetPipelineJobRequest) ProtoReflect() protoreflect.Message

func (*GetPipelineJobRequest) Reset

func (x *GetPipelineJobRequest) Reset()

func (*GetPipelineJobRequest) String

func (x *GetPipelineJobRequest) String() string

type GetPublisherModelRequest added in v1.44.0

type GetPublisherModelRequest struct {

	// Required. The name of the PublisherModel resource.
	// Format:
	// `publishers/{publisher}/models/{publisher_model}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The IETF BCP-47 language code representing the language in which
	// the publisher model's text information should be written in (see go/bcp47).
	LanguageCode string `protobuf:"bytes,2,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// Optional. PublisherModel view specifying which fields to read.
	View PublisherModelView `protobuf:"varint,3,opt,name=view,proto3,enum=google.cloud.aiplatform.v1.PublisherModelView" json:"view,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelGardenService.GetPublisherModel][google.cloud.aiplatform.v1.ModelGardenService.GetPublisherModel]

func (*GetPublisherModelRequest) Descriptor deprecated added in v1.44.0

func (*GetPublisherModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetPublisherModelRequest.ProtoReflect.Descriptor instead.

func (*GetPublisherModelRequest) GetLanguageCode added in v1.44.0

func (x *GetPublisherModelRequest) GetLanguageCode() string

func (*GetPublisherModelRequest) GetName added in v1.44.0

func (x *GetPublisherModelRequest) GetName() string

func (*GetPublisherModelRequest) GetView added in v1.44.0

func (*GetPublisherModelRequest) ProtoMessage added in v1.44.0

func (*GetPublisherModelRequest) ProtoMessage()

func (*GetPublisherModelRequest) ProtoReflect added in v1.44.0

func (x *GetPublisherModelRequest) ProtoReflect() protoreflect.Message

func (*GetPublisherModelRequest) Reset added in v1.44.0

func (x *GetPublisherModelRequest) Reset()

func (*GetPublisherModelRequest) String added in v1.44.0

func (x *GetPublisherModelRequest) String() string

type GetScheduleRequest added in v1.47.0

type GetScheduleRequest struct {

	// Required. The name of the Schedule resource.
	// Format:
	// `projects/{project}/locations/{location}/schedules/{schedule}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ScheduleService.GetSchedule][google.cloud.aiplatform.v1.ScheduleService.GetSchedule].

func (*GetScheduleRequest) Descriptor deprecated added in v1.47.0

func (*GetScheduleRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetScheduleRequest.ProtoReflect.Descriptor instead.

func (*GetScheduleRequest) GetName added in v1.47.0

func (x *GetScheduleRequest) GetName() string

func (*GetScheduleRequest) ProtoMessage added in v1.47.0

func (*GetScheduleRequest) ProtoMessage()

func (*GetScheduleRequest) ProtoReflect added in v1.47.0

func (x *GetScheduleRequest) ProtoReflect() protoreflect.Message

func (*GetScheduleRequest) Reset added in v1.47.0

func (x *GetScheduleRequest) Reset()

func (*GetScheduleRequest) String added in v1.47.0

func (x *GetScheduleRequest) String() string

type GetSpecialistPoolRequest

type GetSpecialistPoolRequest struct {

	// Required. The name of the SpecialistPool resource.
	// The form is
	// `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SpecialistPoolService.GetSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.GetSpecialistPool].

func (*GetSpecialistPoolRequest) Descriptor deprecated

func (*GetSpecialistPoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSpecialistPoolRequest.ProtoReflect.Descriptor instead.

func (*GetSpecialistPoolRequest) GetName

func (x *GetSpecialistPoolRequest) GetName() string

func (*GetSpecialistPoolRequest) ProtoMessage

func (*GetSpecialistPoolRequest) ProtoMessage()

func (*GetSpecialistPoolRequest) ProtoReflect

func (x *GetSpecialistPoolRequest) ProtoReflect() protoreflect.Message

func (*GetSpecialistPoolRequest) Reset

func (x *GetSpecialistPoolRequest) Reset()

func (*GetSpecialistPoolRequest) String

func (x *GetSpecialistPoolRequest) String() string

type GetStudyRequest

type GetStudyRequest struct {

	// Required. The name of the Study resource.
	// Format: `projects/{project}/locations/{location}/studies/{study}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.GetStudy][google.cloud.aiplatform.v1.VizierService.GetStudy].

func (*GetStudyRequest) Descriptor deprecated

func (*GetStudyRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetStudyRequest.ProtoReflect.Descriptor instead.

func (*GetStudyRequest) GetName

func (x *GetStudyRequest) GetName() string

func (*GetStudyRequest) ProtoMessage

func (*GetStudyRequest) ProtoMessage()

func (*GetStudyRequest) ProtoReflect

func (x *GetStudyRequest) ProtoReflect() protoreflect.Message

func (*GetStudyRequest) Reset

func (x *GetStudyRequest) Reset()

func (*GetStudyRequest) String

func (x *GetStudyRequest) String() string

type GetTensorboardExperimentRequest

type GetTensorboardExperimentRequest struct {

	// Required. The name of the TensorboardExperiment resource.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.GetTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardExperiment].

func (*GetTensorboardExperimentRequest) Descriptor deprecated

func (*GetTensorboardExperimentRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTensorboardExperimentRequest.ProtoReflect.Descriptor instead.

func (*GetTensorboardExperimentRequest) GetName

func (*GetTensorboardExperimentRequest) ProtoMessage

func (*GetTensorboardExperimentRequest) ProtoMessage()

func (*GetTensorboardExperimentRequest) ProtoReflect

func (*GetTensorboardExperimentRequest) Reset

func (*GetTensorboardExperimentRequest) String

type GetTensorboardRequest

type GetTensorboardRequest struct {

	// Required. The name of the Tensorboard resource.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.GetTensorboard][google.cloud.aiplatform.v1.TensorboardService.GetTensorboard].

func (*GetTensorboardRequest) Descriptor deprecated

func (*GetTensorboardRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTensorboardRequest.ProtoReflect.Descriptor instead.

func (*GetTensorboardRequest) GetName

func (x *GetTensorboardRequest) GetName() string

func (*GetTensorboardRequest) ProtoMessage

func (*GetTensorboardRequest) ProtoMessage()

func (*GetTensorboardRequest) ProtoReflect

func (x *GetTensorboardRequest) ProtoReflect() protoreflect.Message

func (*GetTensorboardRequest) Reset

func (x *GetTensorboardRequest) Reset()

func (*GetTensorboardRequest) String

func (x *GetTensorboardRequest) String() string

type GetTensorboardRunRequest

type GetTensorboardRunRequest struct {

	// Required. The name of the TensorboardRun resource.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.GetTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardRun].

func (*GetTensorboardRunRequest) Descriptor deprecated

func (*GetTensorboardRunRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTensorboardRunRequest.ProtoReflect.Descriptor instead.

func (*GetTensorboardRunRequest) GetName

func (x *GetTensorboardRunRequest) GetName() string

func (*GetTensorboardRunRequest) ProtoMessage

func (*GetTensorboardRunRequest) ProtoMessage()

func (*GetTensorboardRunRequest) ProtoReflect

func (x *GetTensorboardRunRequest) ProtoReflect() protoreflect.Message

func (*GetTensorboardRunRequest) Reset

func (x *GetTensorboardRunRequest) Reset()

func (*GetTensorboardRunRequest) String

func (x *GetTensorboardRunRequest) String() string

type GetTensorboardTimeSeriesRequest

type GetTensorboardTimeSeriesRequest struct {

	// Required. The name of the TensorboardTimeSeries resource.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.GetTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardTimeSeries].

func (*GetTensorboardTimeSeriesRequest) Descriptor deprecated

func (*GetTensorboardTimeSeriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTensorboardTimeSeriesRequest.ProtoReflect.Descriptor instead.

func (*GetTensorboardTimeSeriesRequest) GetName

func (*GetTensorboardTimeSeriesRequest) ProtoMessage

func (*GetTensorboardTimeSeriesRequest) ProtoMessage()

func (*GetTensorboardTimeSeriesRequest) ProtoReflect

func (*GetTensorboardTimeSeriesRequest) Reset

func (*GetTensorboardTimeSeriesRequest) String

type GetTrainingPipelineRequest

type GetTrainingPipelineRequest struct {

	// Required. The name of the TrainingPipeline resource.
	// Format:
	// `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline].

func (*GetTrainingPipelineRequest) Descriptor deprecated

func (*GetTrainingPipelineRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTrainingPipelineRequest.ProtoReflect.Descriptor instead.

func (*GetTrainingPipelineRequest) GetName

func (x *GetTrainingPipelineRequest) GetName() string

func (*GetTrainingPipelineRequest) ProtoMessage

func (*GetTrainingPipelineRequest) ProtoMessage()

func (*GetTrainingPipelineRequest) ProtoReflect

func (*GetTrainingPipelineRequest) Reset

func (x *GetTrainingPipelineRequest) Reset()

func (*GetTrainingPipelineRequest) String

func (x *GetTrainingPipelineRequest) String() string

type GetTrialRequest

type GetTrialRequest struct {

	// Required. The name of the Trial resource.
	// Format:
	// `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.GetTrial][google.cloud.aiplatform.v1.VizierService.GetTrial].

func (*GetTrialRequest) Descriptor deprecated

func (*GetTrialRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTrialRequest.ProtoReflect.Descriptor instead.

func (*GetTrialRequest) GetName

func (x *GetTrialRequest) GetName() string

func (*GetTrialRequest) ProtoMessage

func (*GetTrialRequest) ProtoMessage()

func (*GetTrialRequest) ProtoReflect

func (x *GetTrialRequest) ProtoReflect() protoreflect.Message

func (*GetTrialRequest) Reset

func (x *GetTrialRequest) Reset()

func (*GetTrialRequest) String

func (x *GetTrialRequest) String() string

type GetTuningJobRequest added in v1.67.0

type GetTuningJobRequest struct {

	// Required. The name of the TuningJob resource. Format:
	// `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [GenAiTuningService.GetTuningJob][google.cloud.aiplatform.v1.GenAiTuningService.GetTuningJob].

func (*GetTuningJobRequest) Descriptor deprecated added in v1.67.0

func (*GetTuningJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTuningJobRequest.ProtoReflect.Descriptor instead.

func (*GetTuningJobRequest) GetName added in v1.67.0

func (x *GetTuningJobRequest) GetName() string

func (*GetTuningJobRequest) ProtoMessage added in v1.67.0

func (*GetTuningJobRequest) ProtoMessage()

func (*GetTuningJobRequest) ProtoReflect added in v1.67.0

func (x *GetTuningJobRequest) ProtoReflect() protoreflect.Message

func (*GetTuningJobRequest) Reset added in v1.67.0

func (x *GetTuningJobRequest) Reset()

func (*GetTuningJobRequest) String added in v1.67.0

func (x *GetTuningJobRequest) String() string

type GoogleSearchRetrieval added in v1.63.0

type GoogleSearchRetrieval struct {

	// Optional. Disable using the result from this tool in detecting grounding
	// attribution. This does not affect how the result is given to the model for
	// generation.
	DisableAttribution bool `protobuf:"varint,1,opt,name=disable_attribution,json=disableAttribution,proto3" json:"disable_attribution,omitempty"`
	// contains filtered or unexported fields
}

Tool to retrieve public web data for grounding, powered by Google.

func (*GoogleSearchRetrieval) Descriptor deprecated added in v1.63.0

func (*GoogleSearchRetrieval) Descriptor() ([]byte, []int)

Deprecated: Use GoogleSearchRetrieval.ProtoReflect.Descriptor instead.

func (*GoogleSearchRetrieval) GetDisableAttribution added in v1.63.0

func (x *GoogleSearchRetrieval) GetDisableAttribution() bool

func (*GoogleSearchRetrieval) ProtoMessage added in v1.63.0

func (*GoogleSearchRetrieval) ProtoMessage()

func (*GoogleSearchRetrieval) ProtoReflect added in v1.63.0

func (x *GoogleSearchRetrieval) ProtoReflect() protoreflect.Message

func (*GoogleSearchRetrieval) Reset added in v1.63.0

func (x *GoogleSearchRetrieval) Reset()

func (*GoogleSearchRetrieval) String added in v1.63.0

func (x *GoogleSearchRetrieval) String() string

type GroundingAttribution added in v1.63.0

type GroundingAttribution struct {

	// Types that are assignable to Reference:
	//
	//	*GroundingAttribution_Web_
	Reference isGroundingAttribution_Reference `protobuf_oneof:"reference"`
	// Output only. Segment of the content this attribution belongs to.
	Segment *Segment `protobuf:"bytes,1,opt,name=segment,proto3" json:"segment,omitempty"`
	// Optional. Output only. Confidence score of the attribution. Ranges from 0
	// to 1. 1 is the most confident.
	ConfidenceScore *float32 `protobuf:"fixed32,2,opt,name=confidence_score,json=confidenceScore,proto3,oneof" json:"confidence_score,omitempty"`
	// contains filtered or unexported fields
}

Grounding attribution.

func (*GroundingAttribution) Descriptor deprecated added in v1.63.0

func (*GroundingAttribution) Descriptor() ([]byte, []int)

Deprecated: Use GroundingAttribution.ProtoReflect.Descriptor instead.

func (*GroundingAttribution) GetConfidenceScore added in v1.63.0

func (x *GroundingAttribution) GetConfidenceScore() float32

func (*GroundingAttribution) GetReference added in v1.63.0

func (m *GroundingAttribution) GetReference() isGroundingAttribution_Reference

func (*GroundingAttribution) GetSegment added in v1.63.0

func (x *GroundingAttribution) GetSegment() *Segment

func (*GroundingAttribution) GetWeb added in v1.63.0

func (*GroundingAttribution) ProtoMessage added in v1.63.0

func (*GroundingAttribution) ProtoMessage()

func (*GroundingAttribution) ProtoReflect added in v1.63.0

func (x *GroundingAttribution) ProtoReflect() protoreflect.Message

func (*GroundingAttribution) Reset added in v1.63.0

func (x *GroundingAttribution) Reset()

func (*GroundingAttribution) String added in v1.63.0

func (x *GroundingAttribution) String() string

type GroundingAttribution_Web added in v1.63.0

type GroundingAttribution_Web struct {

	// Output only. URI reference of the attribution.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Output only. Title of the attribution.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// contains filtered or unexported fields
}

Attribution from the web.

func (*GroundingAttribution_Web) Descriptor deprecated added in v1.63.0

func (*GroundingAttribution_Web) Descriptor() ([]byte, []int)

Deprecated: Use GroundingAttribution_Web.ProtoReflect.Descriptor instead.

func (*GroundingAttribution_Web) GetTitle added in v1.63.0

func (x *GroundingAttribution_Web) GetTitle() string

func (*GroundingAttribution_Web) GetUri added in v1.63.0

func (x *GroundingAttribution_Web) GetUri() string

func (*GroundingAttribution_Web) ProtoMessage added in v1.63.0

func (*GroundingAttribution_Web) ProtoMessage()

func (*GroundingAttribution_Web) ProtoReflect added in v1.63.0

func (x *GroundingAttribution_Web) ProtoReflect() protoreflect.Message

func (*GroundingAttribution_Web) Reset added in v1.63.0

func (x *GroundingAttribution_Web) Reset()

func (*GroundingAttribution_Web) String added in v1.63.0

func (x *GroundingAttribution_Web) String() string

type GroundingAttribution_Web_ added in v1.63.0

type GroundingAttribution_Web_ struct {
	// Optional. Attribution from the web.
	Web *GroundingAttribution_Web `protobuf:"bytes,3,opt,name=web,proto3,oneof"`
}

type GroundingMetadata added in v1.63.0

type GroundingMetadata struct {

	// Optional. Web search queries for the following-up web search.
	WebSearchQueries []string `protobuf:"bytes,1,rep,name=web_search_queries,json=webSearchQueries,proto3" json:"web_search_queries,omitempty"`
	// Optional. List of grounding attributions.
	GroundingAttributions []*GroundingAttribution `protobuf:"bytes,2,rep,name=grounding_attributions,json=groundingAttributions,proto3" json:"grounding_attributions,omitempty"`
	// contains filtered or unexported fields
}

Metadata returned to client when grounding is enabled.

func (*GroundingMetadata) Descriptor deprecated added in v1.63.0

func (*GroundingMetadata) Descriptor() ([]byte, []int)

Deprecated: Use GroundingMetadata.ProtoReflect.Descriptor instead.

func (*GroundingMetadata) GetGroundingAttributions added in v1.63.0

func (x *GroundingMetadata) GetGroundingAttributions() []*GroundingAttribution

func (*GroundingMetadata) GetWebSearchQueries added in v1.63.0

func (x *GroundingMetadata) GetWebSearchQueries() []string

func (*GroundingMetadata) ProtoMessage added in v1.63.0

func (*GroundingMetadata) ProtoMessage()

func (*GroundingMetadata) ProtoReflect added in v1.63.0

func (x *GroundingMetadata) ProtoReflect() protoreflect.Message

func (*GroundingMetadata) Reset added in v1.63.0

func (x *GroundingMetadata) Reset()

func (*GroundingMetadata) String added in v1.63.0

func (x *GroundingMetadata) String() string

type HarmCategory added in v1.57.0

type HarmCategory int32

Harm categories that will block the content.

const (
	// The harm category is unspecified.
	HarmCategory_HARM_CATEGORY_UNSPECIFIED HarmCategory = 0
	// The harm category is hate speech.
	HarmCategory_HARM_CATEGORY_HATE_SPEECH HarmCategory = 1
	// The harm category is dangerous content.
	HarmCategory_HARM_CATEGORY_DANGEROUS_CONTENT HarmCategory = 2
	// The harm category is harassment.
	HarmCategory_HARM_CATEGORY_HARASSMENT HarmCategory = 3
	// The harm category is sexually explicit content.
	HarmCategory_HARM_CATEGORY_SEXUALLY_EXPLICIT HarmCategory = 4
)

func (HarmCategory) Descriptor added in v1.57.0

func (HarmCategory) Enum added in v1.57.0

func (x HarmCategory) Enum() *HarmCategory

func (HarmCategory) EnumDescriptor deprecated added in v1.57.0

func (HarmCategory) EnumDescriptor() ([]byte, []int)

Deprecated: Use HarmCategory.Descriptor instead.

func (HarmCategory) Number added in v1.57.0

func (HarmCategory) String added in v1.57.0

func (x HarmCategory) String() string

func (HarmCategory) Type added in v1.57.0

type HyperparameterTuningJob

type HyperparameterTuningJob struct {

	// Output only. Resource name of the HyperparameterTuningJob.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The display name of the HyperparameterTuningJob.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Required. Study configuration of the HyperparameterTuningJob.
	StudySpec *StudySpec `protobuf:"bytes,4,opt,name=study_spec,json=studySpec,proto3" json:"study_spec,omitempty"`
	// Required. The desired total number of Trials.
	MaxTrialCount int32 `protobuf:"varint,5,opt,name=max_trial_count,json=maxTrialCount,proto3" json:"max_trial_count,omitempty"`
	// Required. The desired number of Trials to run in parallel.
	ParallelTrialCount int32 `protobuf:"varint,6,opt,name=parallel_trial_count,json=parallelTrialCount,proto3" json:"parallel_trial_count,omitempty"`
	// The number of failed Trials that need to be seen before failing
	// the HyperparameterTuningJob.
	//
	// If set to 0, Vertex AI decides how many Trials must fail
	// before the whole job fails.
	MaxFailedTrialCount int32 `protobuf:"varint,7,opt,name=max_failed_trial_count,json=maxFailedTrialCount,proto3" json:"max_failed_trial_count,omitempty"`
	// Required. The spec of a trial job. The same spec applies to the CustomJobs
	// created in all the trials.
	TrialJobSpec *CustomJobSpec `protobuf:"bytes,8,opt,name=trial_job_spec,json=trialJobSpec,proto3" json:"trial_job_spec,omitempty"`
	// Output only. Trials of the HyperparameterTuningJob.
	Trials []*Trial `protobuf:"bytes,9,rep,name=trials,proto3" json:"trials,omitempty"`
	// Output only. The detailed state of the job.
	State JobState `protobuf:"varint,10,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.JobState" json:"state,omitempty"`
	// Output only. Time when the HyperparameterTuningJob was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Time when the HyperparameterTuningJob for the first time
	// entered the `JOB_STATE_RUNNING` state.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. Time when the HyperparameterTuningJob entered any of the
	// following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
	// `JOB_STATE_CANCELLED`.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Time when the HyperparameterTuningJob was most recently
	// updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Only populated when job's state is JOB_STATE_FAILED or
	// JOB_STATE_CANCELLED.
	Error *status.Status `protobuf:"bytes,15,opt,name=error,proto3" json:"error,omitempty"`
	// The labels with user-defined metadata to organize HyperparameterTuningJobs.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Customer-managed encryption key options for a HyperparameterTuningJob.
	// If this is set, then all resources created by the HyperparameterTuningJob
	// will be encrypted with the provided encryption key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,17,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// contains filtered or unexported fields
}

Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.

func (*HyperparameterTuningJob) Descriptor deprecated

func (*HyperparameterTuningJob) Descriptor() ([]byte, []int)

Deprecated: Use HyperparameterTuningJob.ProtoReflect.Descriptor instead.

func (*HyperparameterTuningJob) GetCreateTime

func (x *HyperparameterTuningJob) GetCreateTime() *timestamppb.Timestamp

func (*HyperparameterTuningJob) GetDisplayName

func (x *HyperparameterTuningJob) GetDisplayName() string

func (*HyperparameterTuningJob) GetEncryptionSpec

func (x *HyperparameterTuningJob) GetEncryptionSpec() *EncryptionSpec

func (*HyperparameterTuningJob) GetEndTime

func (*HyperparameterTuningJob) GetError

func (x *HyperparameterTuningJob) GetError() *status.Status

func (*HyperparameterTuningJob) GetLabels

func (x *HyperparameterTuningJob) GetLabels() map[string]string

func (*HyperparameterTuningJob) GetMaxFailedTrialCount

func (x *HyperparameterTuningJob) GetMaxFailedTrialCount() int32

func (*HyperparameterTuningJob) GetMaxTrialCount

func (x *HyperparameterTuningJob) GetMaxTrialCount() int32

func (*HyperparameterTuningJob) GetName

func (x *HyperparameterTuningJob) GetName() string

func (*HyperparameterTuningJob) GetParallelTrialCount

func (x *HyperparameterTuningJob) GetParallelTrialCount() int32

func (*HyperparameterTuningJob) GetStartTime

func (x *HyperparameterTuningJob) GetStartTime() *timestamppb.Timestamp

func (*HyperparameterTuningJob) GetState

func (x *HyperparameterTuningJob) GetState() JobState

func (*HyperparameterTuningJob) GetStudySpec

func (x *HyperparameterTuningJob) GetStudySpec() *StudySpec

func (*HyperparameterTuningJob) GetTrialJobSpec

func (x *HyperparameterTuningJob) GetTrialJobSpec() *CustomJobSpec

func (*HyperparameterTuningJob) GetTrials

func (x *HyperparameterTuningJob) GetTrials() []*Trial

func (*HyperparameterTuningJob) GetUpdateTime

func (x *HyperparameterTuningJob) GetUpdateTime() *timestamppb.Timestamp

func (*HyperparameterTuningJob) ProtoMessage

func (*HyperparameterTuningJob) ProtoMessage()

func (*HyperparameterTuningJob) ProtoReflect

func (x *HyperparameterTuningJob) ProtoReflect() protoreflect.Message

func (*HyperparameterTuningJob) Reset

func (x *HyperparameterTuningJob) Reset()

func (*HyperparameterTuningJob) String

func (x *HyperparameterTuningJob) String() string

type IdMatcher

type IdMatcher struct {

	// Required. The following are accepted as `ids`:
	//
	//   - A single-element list containing only `*`, which selects all Features
	//     in the target EntityType, or
	//   - A list containing only Feature IDs, which selects only Features with
	//     those IDs in the target EntityType.
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

Matcher for Features of an EntityType by Feature ID.

func (*IdMatcher) Descriptor deprecated

func (*IdMatcher) Descriptor() ([]byte, []int)

Deprecated: Use IdMatcher.ProtoReflect.Descriptor instead.

func (*IdMatcher) GetIds

func (x *IdMatcher) GetIds() []string

func (*IdMatcher) ProtoMessage

func (*IdMatcher) ProtoMessage()

func (*IdMatcher) ProtoReflect

func (x *IdMatcher) ProtoReflect() protoreflect.Message

func (*IdMatcher) Reset

func (x *IdMatcher) Reset()

func (*IdMatcher) String

func (x *IdMatcher) String() string

type ImportDataConfig

type ImportDataConfig struct {

	// The source of the input.
	//
	// Types that are assignable to Source:
	//
	//	*ImportDataConfig_GcsSource
	Source isImportDataConfig_Source `protobuf_oneof:"source"`
	// Labels that will be applied to newly imported DataItems. If an identical
	// DataItem as one being imported already exists in the Dataset, then these
	// labels will be appended to these of the already existing one, and if labels
	// with identical key is imported before, the old label value will be
	// overwritten. If two DataItems are identical in the same import data
	// operation, the labels will be combined and if key collision happens in this
	// case, one of the values will be picked randomly. Two DataItems are
	// considered identical if their content bytes are identical (e.g. image bytes
	// or pdf bytes).
	// These labels will be overridden by Annotation labels specified inside index
	// file referenced by
	// [import_schema_uri][google.cloud.aiplatform.v1.ImportDataConfig.import_schema_uri],
	// e.g. jsonl file.
	DataItemLabels map[string]string `` /* 193-byte string literal not displayed */
	// Labels that will be applied to newly imported Annotations. If two
	// Annotations are identical, one of them will be deduped. Two Annotations are
	// considered identical if their
	// [payload][google.cloud.aiplatform.v1.Annotation.payload],
	// [payload_schema_uri][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
	// and all of their [labels][google.cloud.aiplatform.v1.Annotation.labels] are
	// the same. These labels will be overridden by Annotation labels specified
	// inside index file referenced by
	// [import_schema_uri][google.cloud.aiplatform.v1.ImportDataConfig.import_schema_uri],
	// e.g. jsonl file.
	AnnotationLabels map[string]string `` /* 197-byte string literal not displayed */
	// Required. Points to a YAML file stored on Google Cloud Storage describing
	// the import format. Validation will be done against the schema. The schema
	// is defined as an [OpenAPI 3.0.2 Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	ImportSchemaUri string `protobuf:"bytes,4,opt,name=import_schema_uri,json=importSchemaUri,proto3" json:"import_schema_uri,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*ImportDataConfig) Descriptor deprecated

func (*ImportDataConfig) Descriptor() ([]byte, []int)

Deprecated: Use ImportDataConfig.ProtoReflect.Descriptor instead.

func (*ImportDataConfig) GetAnnotationLabels

func (x *ImportDataConfig) GetAnnotationLabels() map[string]string

func (*ImportDataConfig) GetDataItemLabels

func (x *ImportDataConfig) GetDataItemLabels() map[string]string

func (*ImportDataConfig) GetGcsSource

func (x *ImportDataConfig) GetGcsSource() *GcsSource

func (*ImportDataConfig) GetImportSchemaUri

func (x *ImportDataConfig) GetImportSchemaUri() string

func (*ImportDataConfig) GetSource

func (m *ImportDataConfig) GetSource() isImportDataConfig_Source

func (*ImportDataConfig) ProtoMessage

func (*ImportDataConfig) ProtoMessage()

func (*ImportDataConfig) ProtoReflect

func (x *ImportDataConfig) ProtoReflect() protoreflect.Message

func (*ImportDataConfig) Reset

func (x *ImportDataConfig) Reset()

func (*ImportDataConfig) String

func (x *ImportDataConfig) String() string

type ImportDataConfig_GcsSource

type ImportDataConfig_GcsSource struct {
	// The Google Cloud Storage location for the input content.
	GcsSource *GcsSource `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type ImportDataOperationMetadata

type ImportDataOperationMetadata struct {

	// The common part of the operation metadata.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData].

func (*ImportDataOperationMetadata) Descriptor deprecated

func (*ImportDataOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportDataOperationMetadata.ProtoReflect.Descriptor instead.

func (*ImportDataOperationMetadata) GetGenericMetadata

func (x *ImportDataOperationMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*ImportDataOperationMetadata) ProtoMessage

func (*ImportDataOperationMetadata) ProtoMessage()

func (*ImportDataOperationMetadata) ProtoReflect

func (*ImportDataOperationMetadata) Reset

func (x *ImportDataOperationMetadata) Reset()

func (*ImportDataOperationMetadata) String

func (x *ImportDataOperationMetadata) String() string

type ImportDataRequest

type ImportDataRequest struct {

	// Required. The name of the Dataset resource.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The desired input locations. The contents of all input locations
	// will be imported in one batch.
	ImportConfigs []*ImportDataConfig `protobuf:"bytes,2,rep,name=import_configs,json=importConfigs,proto3" json:"import_configs,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData].

func (*ImportDataRequest) Descriptor deprecated

func (*ImportDataRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportDataRequest.ProtoReflect.Descriptor instead.

func (*ImportDataRequest) GetImportConfigs

func (x *ImportDataRequest) GetImportConfigs() []*ImportDataConfig

func (*ImportDataRequest) GetName

func (x *ImportDataRequest) GetName() string

func (*ImportDataRequest) ProtoMessage

func (*ImportDataRequest) ProtoMessage()

func (*ImportDataRequest) ProtoReflect

func (x *ImportDataRequest) ProtoReflect() protoreflect.Message

func (*ImportDataRequest) Reset

func (x *ImportDataRequest) Reset()

func (*ImportDataRequest) String

func (x *ImportDataRequest) String() string

type ImportDataResponse

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

Response message for [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData].

func (*ImportDataResponse) Descriptor deprecated

func (*ImportDataResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportDataResponse.ProtoReflect.Descriptor instead.

func (*ImportDataResponse) ProtoMessage

func (*ImportDataResponse) ProtoMessage()

func (*ImportDataResponse) ProtoReflect

func (x *ImportDataResponse) ProtoReflect() protoreflect.Message

func (*ImportDataResponse) Reset

func (x *ImportDataResponse) Reset()

func (*ImportDataResponse) String

func (x *ImportDataResponse) String() string

type ImportFeatureValuesOperationMetadata

type ImportFeatureValuesOperationMetadata struct {

	// Operation metadata for Featurestore import Feature values.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// Number of entities that have been imported by the operation.
	ImportedEntityCount int64 `protobuf:"varint,2,opt,name=imported_entity_count,json=importedEntityCount,proto3" json:"imported_entity_count,omitempty"`
	// Number of Feature values that have been imported by the operation.
	ImportedFeatureValueCount int64 `` /* 141-byte string literal not displayed */
	// The source URI from where Feature values are imported.
	SourceUris []string `protobuf:"bytes,4,rep,name=source_uris,json=sourceUris,proto3" json:"source_uris,omitempty"`
	// The number of rows in input source that weren't imported due to either
	// * Not having any featureValues.
	// * Having a null entityId.
	// * Having a null timestamp.
	// * Not being parsable (applicable for CSV sources).
	InvalidRowCount int64 `protobuf:"varint,6,opt,name=invalid_row_count,json=invalidRowCount,proto3" json:"invalid_row_count,omitempty"`
	// The number rows that weren't ingested due to having timestamps outside the
	// retention boundary.
	TimestampOutsideRetentionRowsCount int64 `` /* 170-byte string literal not displayed */
	// List of ImportFeatureValues operations running under a single EntityType
	// that are blocking this operation.
	BlockingOperationIds []int64 `` /* 131-byte string literal not displayed */
	// contains filtered or unexported fields
}

Details of operations that perform import Feature values.

func (*ImportFeatureValuesOperationMetadata) Descriptor deprecated

func (*ImportFeatureValuesOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportFeatureValuesOperationMetadata.ProtoReflect.Descriptor instead.

func (*ImportFeatureValuesOperationMetadata) GetBlockingOperationIds added in v1.44.0

func (x *ImportFeatureValuesOperationMetadata) GetBlockingOperationIds() []int64

func (*ImportFeatureValuesOperationMetadata) GetGenericMetadata

func (*ImportFeatureValuesOperationMetadata) GetImportedEntityCount

func (x *ImportFeatureValuesOperationMetadata) GetImportedEntityCount() int64

func (*ImportFeatureValuesOperationMetadata) GetImportedFeatureValueCount

func (x *ImportFeatureValuesOperationMetadata) GetImportedFeatureValueCount() int64

func (*ImportFeatureValuesOperationMetadata) GetInvalidRowCount

func (x *ImportFeatureValuesOperationMetadata) GetInvalidRowCount() int64

func (*ImportFeatureValuesOperationMetadata) GetSourceUris

func (x *ImportFeatureValuesOperationMetadata) GetSourceUris() []string

func (*ImportFeatureValuesOperationMetadata) GetTimestampOutsideRetentionRowsCount

func (x *ImportFeatureValuesOperationMetadata) GetTimestampOutsideRetentionRowsCount() int64

func (*ImportFeatureValuesOperationMetadata) ProtoMessage

func (*ImportFeatureValuesOperationMetadata) ProtoMessage()

func (*ImportFeatureValuesOperationMetadata) ProtoReflect

func (*ImportFeatureValuesOperationMetadata) Reset

func (*ImportFeatureValuesOperationMetadata) String

type ImportFeatureValuesRequest

type ImportFeatureValuesRequest struct {

	// Details about the source data, including the location of the storage and
	// the format.
	//
	// Types that are assignable to Source:
	//
	//	*ImportFeatureValuesRequest_AvroSource
	//	*ImportFeatureValuesRequest_BigquerySource
	//	*ImportFeatureValuesRequest_CsvSource
	Source isImportFeatureValuesRequest_Source `protobuf_oneof:"source"`
	// Source of Feature timestamp for all Feature values of each entity.
	// Timestamps must be millisecond-aligned.
	//
	// Types that are assignable to FeatureTimeSource:
	//
	//	*ImportFeatureValuesRequest_FeatureTimeField
	//	*ImportFeatureValuesRequest_FeatureTime
	FeatureTimeSource isImportFeatureValuesRequest_FeatureTimeSource `protobuf_oneof:"feature_time_source"`
	// Required. The resource name of the EntityType grouping the Features for
	// which values are being imported. Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
	EntityType string `protobuf:"bytes,1,opt,name=entity_type,json=entityType,proto3" json:"entity_type,omitempty"`
	// Source column that holds entity IDs. If not provided, entity IDs are
	// extracted from the column named entity_id.
	EntityIdField string `protobuf:"bytes,5,opt,name=entity_id_field,json=entityIdField,proto3" json:"entity_id_field,omitempty"`
	// Required. Specifications defining which Feature values to import from the
	// entity. The request fails if no feature_specs are provided, and having
	// multiple feature_specs for one Feature is not allowed.
	FeatureSpecs []*ImportFeatureValuesRequest_FeatureSpec `protobuf:"bytes,8,rep,name=feature_specs,json=featureSpecs,proto3" json:"feature_specs,omitempty"`
	// If set, data will not be imported for online serving. This
	// is typically used for backfilling, where Feature generation timestamps are
	// not in the timestamp range needed for online serving.
	DisableOnlineServing bool `protobuf:"varint,9,opt,name=disable_online_serving,json=disableOnlineServing,proto3" json:"disable_online_serving,omitempty"`
	// Specifies the number of workers that are used to write data to the
	// Featurestore. Consider the online serving capacity that you require to
	// achieve the desired import throughput without interfering with online
	// serving. The value must be positive, and less than or equal to 100.
	// If not set, defaults to using 1 worker. The low count ensures minimal
	// impact on online serving performance.
	WorkerCount int32 `protobuf:"varint,11,opt,name=worker_count,json=workerCount,proto3" json:"worker_count,omitempty"`
	// If true, API doesn't start ingestion analysis pipeline.
	DisableIngestionAnalysis bool `` /* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues].

func (*ImportFeatureValuesRequest) Descriptor deprecated

func (*ImportFeatureValuesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportFeatureValuesRequest.ProtoReflect.Descriptor instead.

func (*ImportFeatureValuesRequest) GetAvroSource

func (x *ImportFeatureValuesRequest) GetAvroSource() *AvroSource

func (*ImportFeatureValuesRequest) GetBigquerySource

func (x *ImportFeatureValuesRequest) GetBigquerySource() *BigQuerySource

func (*ImportFeatureValuesRequest) GetCsvSource

func (x *ImportFeatureValuesRequest) GetCsvSource() *CsvSource

func (*ImportFeatureValuesRequest) GetDisableIngestionAnalysis

func (x *ImportFeatureValuesRequest) GetDisableIngestionAnalysis() bool

func (*ImportFeatureValuesRequest) GetDisableOnlineServing

func (x *ImportFeatureValuesRequest) GetDisableOnlineServing() bool

func (*ImportFeatureValuesRequest) GetEntityIdField

func (x *ImportFeatureValuesRequest) GetEntityIdField() string

func (*ImportFeatureValuesRequest) GetEntityType

func (x *ImportFeatureValuesRequest) GetEntityType() string

func (*ImportFeatureValuesRequest) GetFeatureSpecs

func (*ImportFeatureValuesRequest) GetFeatureTime

func (x *ImportFeatureValuesRequest) GetFeatureTime() *timestamppb.Timestamp

func (*ImportFeatureValuesRequest) GetFeatureTimeField

func (x *ImportFeatureValuesRequest) GetFeatureTimeField() string

func (*ImportFeatureValuesRequest) GetFeatureTimeSource

func (m *ImportFeatureValuesRequest) GetFeatureTimeSource() isImportFeatureValuesRequest_FeatureTimeSource

func (*ImportFeatureValuesRequest) GetSource

func (m *ImportFeatureValuesRequest) GetSource() isImportFeatureValuesRequest_Source

func (*ImportFeatureValuesRequest) GetWorkerCount

func (x *ImportFeatureValuesRequest) GetWorkerCount() int32

func (*ImportFeatureValuesRequest) ProtoMessage

func (*ImportFeatureValuesRequest) ProtoMessage()

func (*ImportFeatureValuesRequest) ProtoReflect

func (*ImportFeatureValuesRequest) Reset

func (x *ImportFeatureValuesRequest) Reset()

func (*ImportFeatureValuesRequest) String

func (x *ImportFeatureValuesRequest) String() string

type ImportFeatureValuesRequest_AvroSource

type ImportFeatureValuesRequest_AvroSource struct {
	AvroSource *AvroSource `protobuf:"bytes,2,opt,name=avro_source,json=avroSource,proto3,oneof"`
}

type ImportFeatureValuesRequest_BigquerySource

type ImportFeatureValuesRequest_BigquerySource struct {
	BigquerySource *BigQuerySource `protobuf:"bytes,3,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}

type ImportFeatureValuesRequest_CsvSource

type ImportFeatureValuesRequest_CsvSource struct {
	CsvSource *CsvSource `protobuf:"bytes,4,opt,name=csv_source,json=csvSource,proto3,oneof"`
}

type ImportFeatureValuesRequest_FeatureSpec

type ImportFeatureValuesRequest_FeatureSpec struct {

	// Required. ID of the Feature to import values of. This Feature must exist
	// in the target EntityType, or the request will fail.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Source column to get the Feature values from. If not set, uses the column
	// with the same name as the Feature ID.
	SourceField string `protobuf:"bytes,2,opt,name=source_field,json=sourceField,proto3" json:"source_field,omitempty"`
	// contains filtered or unexported fields
}

Defines the Feature value(s) to import.

func (*ImportFeatureValuesRequest_FeatureSpec) Descriptor deprecated

func (*ImportFeatureValuesRequest_FeatureSpec) Descriptor() ([]byte, []int)

Deprecated: Use ImportFeatureValuesRequest_FeatureSpec.ProtoReflect.Descriptor instead.

func (*ImportFeatureValuesRequest_FeatureSpec) GetId

func (*ImportFeatureValuesRequest_FeatureSpec) GetSourceField

func (x *ImportFeatureValuesRequest_FeatureSpec) GetSourceField() string

func (*ImportFeatureValuesRequest_FeatureSpec) ProtoMessage

func (*ImportFeatureValuesRequest_FeatureSpec) ProtoReflect

func (*ImportFeatureValuesRequest_FeatureSpec) Reset

func (*ImportFeatureValuesRequest_FeatureSpec) String

type ImportFeatureValuesRequest_FeatureTime

type ImportFeatureValuesRequest_FeatureTime struct {
	// Single Feature timestamp for all entities being imported. The
	// timestamp must not have higher than millisecond precision.
	FeatureTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=feature_time,json=featureTime,proto3,oneof"`
}

type ImportFeatureValuesRequest_FeatureTimeField

type ImportFeatureValuesRequest_FeatureTimeField struct {
	// Source column that holds the Feature timestamp for all Feature
	// values in each entity.
	FeatureTimeField string `protobuf:"bytes,6,opt,name=feature_time_field,json=featureTimeField,proto3,oneof"`
}

type ImportFeatureValuesResponse

type ImportFeatureValuesResponse struct {

	// Number of entities that have been imported by the operation.
	ImportedEntityCount int64 `protobuf:"varint,1,opt,name=imported_entity_count,json=importedEntityCount,proto3" json:"imported_entity_count,omitempty"`
	// Number of Feature values that have been imported by the operation.
	ImportedFeatureValueCount int64 `` /* 141-byte string literal not displayed */
	// The number of rows in input source that weren't imported due to either
	// * Not having any featureValues.
	// * Having a null entityId.
	// * Having a null timestamp.
	// * Not being parsable (applicable for CSV sources).
	InvalidRowCount int64 `protobuf:"varint,6,opt,name=invalid_row_count,json=invalidRowCount,proto3" json:"invalid_row_count,omitempty"`
	// The number rows that weren't ingested due to having feature timestamps
	// outside the retention boundary.
	TimestampOutsideRetentionRowsCount int64 `` /* 170-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message for [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues].

func (*ImportFeatureValuesResponse) Descriptor deprecated

func (*ImportFeatureValuesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportFeatureValuesResponse.ProtoReflect.Descriptor instead.

func (*ImportFeatureValuesResponse) GetImportedEntityCount

func (x *ImportFeatureValuesResponse) GetImportedEntityCount() int64

func (*ImportFeatureValuesResponse) GetImportedFeatureValueCount

func (x *ImportFeatureValuesResponse) GetImportedFeatureValueCount() int64

func (*ImportFeatureValuesResponse) GetInvalidRowCount

func (x *ImportFeatureValuesResponse) GetInvalidRowCount() int64

func (*ImportFeatureValuesResponse) GetTimestampOutsideRetentionRowsCount

func (x *ImportFeatureValuesResponse) GetTimestampOutsideRetentionRowsCount() int64

func (*ImportFeatureValuesResponse) ProtoMessage

func (*ImportFeatureValuesResponse) ProtoMessage()

func (*ImportFeatureValuesResponse) ProtoReflect

func (*ImportFeatureValuesResponse) Reset

func (x *ImportFeatureValuesResponse) Reset()

func (*ImportFeatureValuesResponse) String

func (x *ImportFeatureValuesResponse) String() string

type ImportModelEvaluationRequest

type ImportModelEvaluationRequest struct {

	// Required. The name of the parent model resource.
	// Format: `projects/{project}/locations/{location}/models/{model}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Model evaluation resource to be imported.
	ModelEvaluation *ModelEvaluation `protobuf:"bytes,2,opt,name=model_evaluation,json=modelEvaluation,proto3" json:"model_evaluation,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.ImportModelEvaluation][google.cloud.aiplatform.v1.ModelService.ImportModelEvaluation]

func (*ImportModelEvaluationRequest) Descriptor deprecated

func (*ImportModelEvaluationRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportModelEvaluationRequest.ProtoReflect.Descriptor instead.

func (*ImportModelEvaluationRequest) GetModelEvaluation

func (x *ImportModelEvaluationRequest) GetModelEvaluation() *ModelEvaluation

func (*ImportModelEvaluationRequest) GetParent

func (x *ImportModelEvaluationRequest) GetParent() string

func (*ImportModelEvaluationRequest) ProtoMessage

func (*ImportModelEvaluationRequest) ProtoMessage()

func (*ImportModelEvaluationRequest) ProtoReflect

func (*ImportModelEvaluationRequest) Reset

func (x *ImportModelEvaluationRequest) Reset()

func (*ImportModelEvaluationRequest) String

type Index

type Index struct {

	// Output only. The resource name of the Index.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The display name of the Index.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The description of the Index.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Immutable. Points to a YAML file stored on Google Cloud Storage describing
	// additional information about the Index, that is specific to it. Unset if
	// the Index does not have any additional information. The schema is defined
	// as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	// Note: The URI given on output will be immutable and probably different,
	// including the URI scheme, than the one given on input. The output URI will
	// point to a location where the user only has a read access.
	MetadataSchemaUri string `protobuf:"bytes,4,opt,name=metadata_schema_uri,json=metadataSchemaUri,proto3" json:"metadata_schema_uri,omitempty"`
	// An additional information about the Index; the schema of the metadata can
	// be found in
	// [metadata_schema][google.cloud.aiplatform.v1.Index.metadata_schema_uri].
	Metadata *structpb.Value `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Output only. The pointers to DeployedIndexes created from this Index.
	// An Index can be only deleted if all its DeployedIndexes had been undeployed
	// first.
	DeployedIndexes []*DeployedIndexRef `protobuf:"bytes,7,rep,name=deployed_indexes,json=deployedIndexes,proto3" json:"deployed_indexes,omitempty"`
	// Used to perform consistent read-modify-write updates. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
	// The labels with user-defined metadata to organize your Indexes.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Output only. Timestamp when this Index was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Index was most recently updated.
	// This also includes any update to the contents of the Index.
	// Note that Operations working on this Index may have their
	// [Operations.metadata.generic_metadata.update_time]
	// [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little
	// after the value of this timestamp, yet that does not mean their results are
	// not already reflected in the Index. Result of any successfully completed
	// Operation on the Index is reflected in it.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Stats of the index resource.
	IndexStats *IndexStats `protobuf:"bytes,14,opt,name=index_stats,json=indexStats,proto3" json:"index_stats,omitempty"`
	// Immutable. The update method to use with this Index. If not set,
	// BATCH_UPDATE will be used by default.
	IndexUpdateMethod Index_IndexUpdateMethod `` /* 172-byte string literal not displayed */
	// Immutable. Customer-managed encryption key spec for an Index. If set, this
	// Index and all sub-resources of this Index will be secured by this key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,17,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// contains filtered or unexported fields
}

A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.

func (*Index) Descriptor deprecated

func (*Index) Descriptor() ([]byte, []int)

Deprecated: Use Index.ProtoReflect.Descriptor instead.

func (*Index) GetCreateTime

func (x *Index) GetCreateTime() *timestamppb.Timestamp

func (*Index) GetDeployedIndexes

func (x *Index) GetDeployedIndexes() []*DeployedIndexRef

func (*Index) GetDescription

func (x *Index) GetDescription() string

func (*Index) GetDisplayName

func (x *Index) GetDisplayName() string

func (*Index) GetEncryptionSpec added in v1.50.0

func (x *Index) GetEncryptionSpec() *EncryptionSpec

func (*Index) GetEtag

func (x *Index) GetEtag() string

func (*Index) GetIndexStats

func (x *Index) GetIndexStats() *IndexStats

func (*Index) GetIndexUpdateMethod

func (x *Index) GetIndexUpdateMethod() Index_IndexUpdateMethod

func (*Index) GetLabels

func (x *Index) GetLabels() map[string]string

func (*Index) GetMetadata

func (x *Index) GetMetadata() *structpb.Value

func (*Index) GetMetadataSchemaUri

func (x *Index) GetMetadataSchemaUri() string

func (*Index) GetName

func (x *Index) GetName() string

func (*Index) GetUpdateTime

func (x *Index) GetUpdateTime() *timestamppb.Timestamp

func (*Index) ProtoMessage

func (*Index) ProtoMessage()

func (*Index) ProtoReflect

func (x *Index) ProtoReflect() protoreflect.Message

func (*Index) Reset

func (x *Index) Reset()

func (*Index) String

func (x *Index) String() string

type IndexDatapoint

type IndexDatapoint struct {

	// Required. Unique identifier of the datapoint.
	DatapointId string `protobuf:"bytes,1,opt,name=datapoint_id,json=datapointId,proto3" json:"datapoint_id,omitempty"`
	// Required. Feature embedding vector. An array of numbers with the length of
	// [NearestNeighborSearchConfig.dimensions].
	FeatureVector []float32 `protobuf:"fixed32,2,rep,packed,name=feature_vector,json=featureVector,proto3" json:"feature_vector,omitempty"`
	// Optional. List of Restrict of the datapoint, used to perform "restricted
	// searches" where boolean rule are used to filter the subset of the database
	// eligible for matching. This uses categorical tokens. See:
	// https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
	Restricts []*IndexDatapoint_Restriction `protobuf:"bytes,4,rep,name=restricts,proto3" json:"restricts,omitempty"`
	// Optional. List of Restrict of the datapoint, used to perform "restricted
	// searches" where boolean rule are used to filter the subset of the database
	// eligible for matching. This uses numeric comparisons.
	NumericRestricts []*IndexDatapoint_NumericRestriction `protobuf:"bytes,6,rep,name=numeric_restricts,json=numericRestricts,proto3" json:"numeric_restricts,omitempty"`
	// Optional. CrowdingTag of the datapoint, the number of neighbors to return
	// in each crowding can be configured during query.
	CrowdingTag *IndexDatapoint_CrowdingTag `protobuf:"bytes,5,opt,name=crowding_tag,json=crowdingTag,proto3" json:"crowding_tag,omitempty"`
	// contains filtered or unexported fields
}

A datapoint of Index.

func (*IndexDatapoint) Descriptor deprecated

func (*IndexDatapoint) Descriptor() ([]byte, []int)

Deprecated: Use IndexDatapoint.ProtoReflect.Descriptor instead.

func (*IndexDatapoint) GetCrowdingTag

func (x *IndexDatapoint) GetCrowdingTag() *IndexDatapoint_CrowdingTag

func (*IndexDatapoint) GetDatapointId

func (x *IndexDatapoint) GetDatapointId() string

func (*IndexDatapoint) GetFeatureVector

func (x *IndexDatapoint) GetFeatureVector() []float32

func (*IndexDatapoint) GetNumericRestricts added in v1.54.0

func (x *IndexDatapoint) GetNumericRestricts() []*IndexDatapoint_NumericRestriction

func (*IndexDatapoint) GetRestricts

func (x *IndexDatapoint) GetRestricts() []*IndexDatapoint_Restriction

func (*IndexDatapoint) ProtoMessage

func (*IndexDatapoint) ProtoMessage()

func (*IndexDatapoint) ProtoReflect

func (x *IndexDatapoint) ProtoReflect() protoreflect.Message

func (*IndexDatapoint) Reset

func (x *IndexDatapoint) Reset()

func (*IndexDatapoint) String

func (x *IndexDatapoint) String() string

type IndexDatapoint_CrowdingTag

type IndexDatapoint_CrowdingTag struct {

	// The attribute value used for crowding.  The maximum number of neighbors
	// to return per crowding attribute value
	// (per_crowding_attribute_num_neighbors) is configured per-query. This
	// field is ignored if per_crowding_attribute_num_neighbors is larger than
	// the total number of neighbors to return for a given query.
	CrowdingAttribute string `protobuf:"bytes,1,opt,name=crowding_attribute,json=crowdingAttribute,proto3" json:"crowding_attribute,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*IndexDatapoint_CrowdingTag) Descriptor deprecated

func (*IndexDatapoint_CrowdingTag) Descriptor() ([]byte, []int)

Deprecated: Use IndexDatapoint_CrowdingTag.ProtoReflect.Descriptor instead.

func (*IndexDatapoint_CrowdingTag) GetCrowdingAttribute

func (x *IndexDatapoint_CrowdingTag) GetCrowdingAttribute() string

func (*IndexDatapoint_CrowdingTag) ProtoMessage

func (*IndexDatapoint_CrowdingTag) ProtoMessage()

func (*IndexDatapoint_CrowdingTag) ProtoReflect

func (*IndexDatapoint_CrowdingTag) Reset

func (x *IndexDatapoint_CrowdingTag) Reset()

func (*IndexDatapoint_CrowdingTag) String

func (x *IndexDatapoint_CrowdingTag) String() string

type IndexDatapoint_NumericRestriction added in v1.54.0

type IndexDatapoint_NumericRestriction struct {

	// The type of Value must be consistent for all datapoints with a given
	// namespace name. This is verified at runtime.
	//
	// Types that are assignable to Value:
	//
	//	*IndexDatapoint_NumericRestriction_ValueInt
	//	*IndexDatapoint_NumericRestriction_ValueFloat
	//	*IndexDatapoint_NumericRestriction_ValueDouble
	Value isIndexDatapoint_NumericRestriction_Value `protobuf_oneof:"Value"`
	// The namespace of this restriction. e.g.: cost.
	Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// This MUST be specified for queries and must NOT be specified for
	// datapoints.
	Op IndexDatapoint_NumericRestriction_Operator `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

This field allows restricts to be based on numeric comparisons rather than categorical tokens.

func (*IndexDatapoint_NumericRestriction) Descriptor deprecated added in v1.54.0

func (*IndexDatapoint_NumericRestriction) Descriptor() ([]byte, []int)

Deprecated: Use IndexDatapoint_NumericRestriction.ProtoReflect.Descriptor instead.

func (*IndexDatapoint_NumericRestriction) GetNamespace added in v1.54.0

func (x *IndexDatapoint_NumericRestriction) GetNamespace() string

func (*IndexDatapoint_NumericRestriction) GetOp added in v1.54.0

func (*IndexDatapoint_NumericRestriction) GetValue added in v1.54.0

func (m *IndexDatapoint_NumericRestriction) GetValue() isIndexDatapoint_NumericRestriction_Value

func (*IndexDatapoint_NumericRestriction) GetValueDouble added in v1.54.0

func (x *IndexDatapoint_NumericRestriction) GetValueDouble() float64

func (*IndexDatapoint_NumericRestriction) GetValueFloat added in v1.54.0

func (x *IndexDatapoint_NumericRestriction) GetValueFloat() float32

func (*IndexDatapoint_NumericRestriction) GetValueInt added in v1.54.0

func (x *IndexDatapoint_NumericRestriction) GetValueInt() int64

func (*IndexDatapoint_NumericRestriction) ProtoMessage added in v1.54.0

func (*IndexDatapoint_NumericRestriction) ProtoMessage()

func (*IndexDatapoint_NumericRestriction) ProtoReflect added in v1.54.0

func (*IndexDatapoint_NumericRestriction) Reset added in v1.54.0

func (*IndexDatapoint_NumericRestriction) String added in v1.54.0

type IndexDatapoint_NumericRestriction_Operator added in v1.54.0

type IndexDatapoint_NumericRestriction_Operator int32

Which comparison operator to use. Should be specified for queries only; specifying this for a datapoint is an error.

Datapoints for which Operator is true relative to the query's Value field will be allowlisted.

const (
	// Default value of the enum.
	IndexDatapoint_NumericRestriction_OPERATOR_UNSPECIFIED IndexDatapoint_NumericRestriction_Operator = 0
	// Datapoints are eligible iff their value is < the query's.
	IndexDatapoint_NumericRestriction_LESS IndexDatapoint_NumericRestriction_Operator = 1
	// Datapoints are eligible iff their value is <= the query's.
	IndexDatapoint_NumericRestriction_LESS_EQUAL IndexDatapoint_NumericRestriction_Operator = 2
	// Datapoints are eligible iff their value is == the query's.
	IndexDatapoint_NumericRestriction_EQUAL IndexDatapoint_NumericRestriction_Operator = 3
	// Datapoints are eligible iff their value is >= the query's.
	IndexDatapoint_NumericRestriction_GREATER_EQUAL IndexDatapoint_NumericRestriction_Operator = 4
	// Datapoints are eligible iff their value is > the query's.
	IndexDatapoint_NumericRestriction_GREATER IndexDatapoint_NumericRestriction_Operator = 5
	// Datapoints are eligible iff their value is != the query's.
	IndexDatapoint_NumericRestriction_NOT_EQUAL IndexDatapoint_NumericRestriction_Operator = 6
)

func (IndexDatapoint_NumericRestriction_Operator) Descriptor added in v1.54.0

func (IndexDatapoint_NumericRestriction_Operator) Enum added in v1.54.0

func (IndexDatapoint_NumericRestriction_Operator) EnumDescriptor deprecated added in v1.54.0

func (IndexDatapoint_NumericRestriction_Operator) EnumDescriptor() ([]byte, []int)

Deprecated: Use IndexDatapoint_NumericRestriction_Operator.Descriptor instead.

func (IndexDatapoint_NumericRestriction_Operator) Number added in v1.54.0

func (IndexDatapoint_NumericRestriction_Operator) String added in v1.54.0

func (IndexDatapoint_NumericRestriction_Operator) Type added in v1.54.0

type IndexDatapoint_NumericRestriction_ValueDouble added in v1.54.0

type IndexDatapoint_NumericRestriction_ValueDouble struct {
	// Represents 64 bit float.
	ValueDouble float64 `protobuf:"fixed64,4,opt,name=value_double,json=valueDouble,proto3,oneof"`
}

type IndexDatapoint_NumericRestriction_ValueFloat added in v1.54.0

type IndexDatapoint_NumericRestriction_ValueFloat struct {
	// Represents 32 bit float.
	ValueFloat float32 `protobuf:"fixed32,3,opt,name=value_float,json=valueFloat,proto3,oneof"`
}

type IndexDatapoint_NumericRestriction_ValueInt added in v1.54.0

type IndexDatapoint_NumericRestriction_ValueInt struct {
	// Represents 64 bit integer.
	ValueInt int64 `protobuf:"varint,2,opt,name=value_int,json=valueInt,proto3,oneof"`
}

type IndexDatapoint_Restriction

type IndexDatapoint_Restriction struct {

	// The namespace of this restriction. e.g.: color.
	Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// The attributes to allow in this namespace. e.g.: 'red'
	AllowList []string `protobuf:"bytes,2,rep,name=allow_list,json=allowList,proto3" json:"allow_list,omitempty"`
	// The attributes to deny in this namespace. e.g.: 'blue'
	DenyList []string `protobuf:"bytes,3,rep,name=deny_list,json=denyList,proto3" json:"deny_list,omitempty"`
	// contains filtered or unexported fields
}

Restriction of a datapoint which describe its attributes(tokens) from each of several attribute categories(namespaces).

func (*IndexDatapoint_Restriction) Descriptor deprecated

func (*IndexDatapoint_Restriction) Descriptor() ([]byte, []int)

Deprecated: Use IndexDatapoint_Restriction.ProtoReflect.Descriptor instead.

func (*IndexDatapoint_Restriction) GetAllowList

func (x *IndexDatapoint_Restriction) GetAllowList() []string

func (*IndexDatapoint_Restriction) GetDenyList

func (x *IndexDatapoint_Restriction) GetDenyList() []string

func (*IndexDatapoint_Restriction) GetNamespace

func (x *IndexDatapoint_Restriction) GetNamespace() string

func (*IndexDatapoint_Restriction) ProtoMessage

func (*IndexDatapoint_Restriction) ProtoMessage()

func (*IndexDatapoint_Restriction) ProtoReflect

func (*IndexDatapoint_Restriction) Reset

func (x *IndexDatapoint_Restriction) Reset()

func (*IndexDatapoint_Restriction) String

func (x *IndexDatapoint_Restriction) String() string

type IndexEndpoint

type IndexEndpoint struct {

	// Output only. The resource name of the IndexEndpoint.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The display name of the IndexEndpoint.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The description of the IndexEndpoint.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. The indexes deployed in this endpoint.
	DeployedIndexes []*DeployedIndex `protobuf:"bytes,4,rep,name=deployed_indexes,json=deployedIndexes,proto3" json:"deployed_indexes,omitempty"`
	// Used to perform consistent read-modify-write updates. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,5,opt,name=etag,proto3" json:"etag,omitempty"`
	// The labels with user-defined metadata to organize your IndexEndpoints.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Output only. Timestamp when this IndexEndpoint was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this IndexEndpoint was last updated.
	// This timestamp is not updated when the endpoint's DeployedIndexes are
	// updated, e.g. due to updates of the original Indexes they are the
	// deployments of.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. The full name of the Google Compute Engine
	// [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
	// to which the IndexEndpoint should be peered.
	//
	// Private services access must already be configured for the network. If left
	// unspecified, the Endpoint is not peered with any network.
	//
	// [network][google.cloud.aiplatform.v1.IndexEndpoint.network] and
	// [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config]
	// are mutually exclusive.
	//
	// [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert):
	// `projects/{project}/global/networks/{network}`.
	// Where {project} is a project number, as in '12345', and {network} is
	// network name.
	Network string `protobuf:"bytes,9,opt,name=network,proto3" json:"network,omitempty"`
	// Optional. Deprecated: If true, expose the IndexEndpoint via private service
	// connect.
	//
	// Only one of the fields,
	// [network][google.cloud.aiplatform.v1.IndexEndpoint.network] or
	// [enable_private_service_connect][google.cloud.aiplatform.v1.IndexEndpoint.enable_private_service_connect],
	// can be set.
	//
	// Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/index_endpoint.proto.
	EnablePrivateServiceConnect bool `` /* 148-byte string literal not displayed */
	// Optional. Configuration for private service connect.
	//
	// [network][google.cloud.aiplatform.v1.IndexEndpoint.network] and
	// [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config]
	// are mutually exclusive.
	PrivateServiceConnectConfig *PrivateServiceConnectConfig `` /* 147-byte string literal not displayed */
	// Optional. If true, the deployed index will be accessible through public
	// endpoint.
	PublicEndpointEnabled bool `` /* 128-byte string literal not displayed */
	// Output only. If
	// [public_endpoint_enabled][google.cloud.aiplatform.v1.IndexEndpoint.public_endpoint_enabled]
	// is true, this field will be populated with the domain name to use for this
	// index endpoint.
	PublicEndpointDomainName string `` /* 138-byte string literal not displayed */
	// Immutable. Customer-managed encryption key spec for an IndexEndpoint. If
	// set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be
	// secured by this key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,15,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// contains filtered or unexported fields
}

Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

func (*IndexEndpoint) Descriptor deprecated

func (*IndexEndpoint) Descriptor() ([]byte, []int)

Deprecated: Use IndexEndpoint.ProtoReflect.Descriptor instead.

func (*IndexEndpoint) GetCreateTime

func (x *IndexEndpoint) GetCreateTime() *timestamppb.Timestamp

func (*IndexEndpoint) GetDeployedIndexes

func (x *IndexEndpoint) GetDeployedIndexes() []*DeployedIndex

func (*IndexEndpoint) GetDescription

func (x *IndexEndpoint) GetDescription() string

func (*IndexEndpoint) GetDisplayName

func (x *IndexEndpoint) GetDisplayName() string

func (*IndexEndpoint) GetEnablePrivateServiceConnect deprecated

func (x *IndexEndpoint) GetEnablePrivateServiceConnect() bool

Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/index_endpoint.proto.

func (*IndexEndpoint) GetEncryptionSpec added in v1.50.0

func (x *IndexEndpoint) GetEncryptionSpec() *EncryptionSpec

func (*IndexEndpoint) GetEtag

func (x *IndexEndpoint) GetEtag() string

func (*IndexEndpoint) GetLabels

func (x *IndexEndpoint) GetLabels() map[string]string

func (*IndexEndpoint) GetName

func (x *IndexEndpoint) GetName() string

func (*IndexEndpoint) GetNetwork

func (x *IndexEndpoint) GetNetwork() string

func (*IndexEndpoint) GetPrivateServiceConnectConfig added in v1.34.0

func (x *IndexEndpoint) GetPrivateServiceConnectConfig() *PrivateServiceConnectConfig

func (*IndexEndpoint) GetPublicEndpointDomainName added in v1.37.0

func (x *IndexEndpoint) GetPublicEndpointDomainName() string

func (*IndexEndpoint) GetPublicEndpointEnabled added in v1.37.0

func (x *IndexEndpoint) GetPublicEndpointEnabled() bool

func (*IndexEndpoint) GetUpdateTime

func (x *IndexEndpoint) GetUpdateTime() *timestamppb.Timestamp

func (*IndexEndpoint) ProtoMessage

func (*IndexEndpoint) ProtoMessage()

func (*IndexEndpoint) ProtoReflect

func (x *IndexEndpoint) ProtoReflect() protoreflect.Message

func (*IndexEndpoint) Reset

func (x *IndexEndpoint) Reset()

func (*IndexEndpoint) String

func (x *IndexEndpoint) String() string

type IndexEndpointServiceClient

type IndexEndpointServiceClient interface {
	// Creates an IndexEndpoint.
	CreateIndexEndpoint(ctx context.Context, in *CreateIndexEndpointRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets an IndexEndpoint.
	GetIndexEndpoint(ctx context.Context, in *GetIndexEndpointRequest, opts ...grpc.CallOption) (*IndexEndpoint, error)
	// Lists IndexEndpoints in a Location.
	ListIndexEndpoints(ctx context.Context, in *ListIndexEndpointsRequest, opts ...grpc.CallOption) (*ListIndexEndpointsResponse, error)
	// Updates an IndexEndpoint.
	UpdateIndexEndpoint(ctx context.Context, in *UpdateIndexEndpointRequest, opts ...grpc.CallOption) (*IndexEndpoint, error)
	// Deletes an IndexEndpoint.
	DeleteIndexEndpoint(ctx context.Context, in *DeleteIndexEndpointRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deploys an Index into this IndexEndpoint, creating a DeployedIndex within
	// it.
	// Only non-empty Indexes can be deployed.
	DeployIndex(ctx context.Context, in *DeployIndexRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it,
	// and freeing all resources it's using.
	UndeployIndex(ctx context.Context, in *UndeployIndexRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Update an existing DeployedIndex under an IndexEndpoint.
	MutateDeployedIndex(ctx context.Context, in *MutateDeployedIndexRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

IndexEndpointServiceClient is the client API for IndexEndpointService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type IndexEndpointServiceServer

type IndexEndpointServiceServer interface {
	// Creates an IndexEndpoint.
	CreateIndexEndpoint(context.Context, *CreateIndexEndpointRequest) (*longrunningpb.Operation, error)
	// Gets an IndexEndpoint.
	GetIndexEndpoint(context.Context, *GetIndexEndpointRequest) (*IndexEndpoint, error)
	// Lists IndexEndpoints in a Location.
	ListIndexEndpoints(context.Context, *ListIndexEndpointsRequest) (*ListIndexEndpointsResponse, error)
	// Updates an IndexEndpoint.
	UpdateIndexEndpoint(context.Context, *UpdateIndexEndpointRequest) (*IndexEndpoint, error)
	// Deletes an IndexEndpoint.
	DeleteIndexEndpoint(context.Context, *DeleteIndexEndpointRequest) (*longrunningpb.Operation, error)
	// Deploys an Index into this IndexEndpoint, creating a DeployedIndex within
	// it.
	// Only non-empty Indexes can be deployed.
	DeployIndex(context.Context, *DeployIndexRequest) (*longrunningpb.Operation, error)
	// Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it,
	// and freeing all resources it's using.
	UndeployIndex(context.Context, *UndeployIndexRequest) (*longrunningpb.Operation, error)
	// Update an existing DeployedIndex under an IndexEndpoint.
	MutateDeployedIndex(context.Context, *MutateDeployedIndexRequest) (*longrunningpb.Operation, error)
}

IndexEndpointServiceServer is the server API for IndexEndpointService service.

type IndexPrivateEndpoints

type IndexPrivateEndpoints struct {

	// Output only. The ip address used to send match gRPC requests.
	MatchGrpcAddress string `protobuf:"bytes,1,opt,name=match_grpc_address,json=matchGrpcAddress,proto3" json:"match_grpc_address,omitempty"`
	// Output only. The name of the service attachment resource. Populated if
	// private service connect is enabled.
	ServiceAttachment string `protobuf:"bytes,2,opt,name=service_attachment,json=serviceAttachment,proto3" json:"service_attachment,omitempty"`
	// Output only. PscAutomatedEndpoints is populated if private service connect
	// is enabled if PscAutomatedConfig is set.
	PscAutomatedEndpoints []*PscAutomatedEndpoints `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

IndexPrivateEndpoints proto is used to provide paths for users to send requests via private endpoints (e.g. private service access, private service connect). To send request via private service access, use match_grpc_address. To send request via private service connect, use service_attachment.

func (*IndexPrivateEndpoints) Descriptor deprecated

func (*IndexPrivateEndpoints) Descriptor() ([]byte, []int)

Deprecated: Use IndexPrivateEndpoints.ProtoReflect.Descriptor instead.

func (*IndexPrivateEndpoints) GetMatchGrpcAddress

func (x *IndexPrivateEndpoints) GetMatchGrpcAddress() string

func (*IndexPrivateEndpoints) GetPscAutomatedEndpoints added in v1.60.0

func (x *IndexPrivateEndpoints) GetPscAutomatedEndpoints() []*PscAutomatedEndpoints

func (*IndexPrivateEndpoints) GetServiceAttachment

func (x *IndexPrivateEndpoints) GetServiceAttachment() string

func (*IndexPrivateEndpoints) ProtoMessage

func (*IndexPrivateEndpoints) ProtoMessage()

func (*IndexPrivateEndpoints) ProtoReflect

func (x *IndexPrivateEndpoints) ProtoReflect() protoreflect.Message

func (*IndexPrivateEndpoints) Reset

func (x *IndexPrivateEndpoints) Reset()

func (*IndexPrivateEndpoints) String

func (x *IndexPrivateEndpoints) String() string

type IndexServiceClient

type IndexServiceClient interface {
	// Creates an Index.
	CreateIndex(ctx context.Context, in *CreateIndexRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets an Index.
	GetIndex(ctx context.Context, in *GetIndexRequest, opts ...grpc.CallOption) (*Index, error)
	// Lists Indexes in a Location.
	ListIndexes(ctx context.Context, in *ListIndexesRequest, opts ...grpc.CallOption) (*ListIndexesResponse, error)
	// Updates an Index.
	UpdateIndex(ctx context.Context, in *UpdateIndexRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes an Index.
	// An Index can only be deleted when all its
	// [DeployedIndexes][google.cloud.aiplatform.v1.Index.deployed_indexes] had
	// been undeployed.
	DeleteIndex(ctx context.Context, in *DeleteIndexRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Add/update Datapoints into an Index.
	UpsertDatapoints(ctx context.Context, in *UpsertDatapointsRequest, opts ...grpc.CallOption) (*UpsertDatapointsResponse, error)
	// Remove Datapoints from an Index.
	RemoveDatapoints(ctx context.Context, in *RemoveDatapointsRequest, opts ...grpc.CallOption) (*RemoveDatapointsResponse, error)
}

IndexServiceClient is the client API for IndexService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type IndexServiceServer

type IndexServiceServer interface {
	// Creates an Index.
	CreateIndex(context.Context, *CreateIndexRequest) (*longrunningpb.Operation, error)
	// Gets an Index.
	GetIndex(context.Context, *GetIndexRequest) (*Index, error)
	// Lists Indexes in a Location.
	ListIndexes(context.Context, *ListIndexesRequest) (*ListIndexesResponse, error)
	// Updates an Index.
	UpdateIndex(context.Context, *UpdateIndexRequest) (*longrunningpb.Operation, error)
	// Deletes an Index.
	// An Index can only be deleted when all its
	// [DeployedIndexes][google.cloud.aiplatform.v1.Index.deployed_indexes] had
	// been undeployed.
	DeleteIndex(context.Context, *DeleteIndexRequest) (*longrunningpb.Operation, error)
	// Add/update Datapoints into an Index.
	UpsertDatapoints(context.Context, *UpsertDatapointsRequest) (*UpsertDatapointsResponse, error)
	// Remove Datapoints from an Index.
	RemoveDatapoints(context.Context, *RemoveDatapointsRequest) (*RemoveDatapointsResponse, error)
}

IndexServiceServer is the server API for IndexService service.

type IndexStats

type IndexStats struct {

	// Output only. The number of vectors in the Index.
	VectorsCount int64 `protobuf:"varint,1,opt,name=vectors_count,json=vectorsCount,proto3" json:"vectors_count,omitempty"`
	// Output only. The number of shards in the Index.
	ShardsCount int32 `protobuf:"varint,2,opt,name=shards_count,json=shardsCount,proto3" json:"shards_count,omitempty"`
	// contains filtered or unexported fields
}

Stats of the Index.

func (*IndexStats) Descriptor deprecated

func (*IndexStats) Descriptor() ([]byte, []int)

Deprecated: Use IndexStats.ProtoReflect.Descriptor instead.

func (*IndexStats) GetShardsCount

func (x *IndexStats) GetShardsCount() int32

func (*IndexStats) GetVectorsCount

func (x *IndexStats) GetVectorsCount() int64

func (*IndexStats) ProtoMessage

func (*IndexStats) ProtoMessage()

func (*IndexStats) ProtoReflect

func (x *IndexStats) ProtoReflect() protoreflect.Message

func (*IndexStats) Reset

func (x *IndexStats) Reset()

func (*IndexStats) String

func (x *IndexStats) String() string

type Index_IndexUpdateMethod

type Index_IndexUpdateMethod int32

The update method of an Index.

const (
	// Should not be used.
	Index_INDEX_UPDATE_METHOD_UNSPECIFIED Index_IndexUpdateMethod = 0
	// BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
	// Datapoints to update.
	Index_BATCH_UPDATE Index_IndexUpdateMethod = 1
	// StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
	// the Index and the updates will be applied in corresponding
	// DeployedIndexes in nearly real-time.
	Index_STREAM_UPDATE Index_IndexUpdateMethod = 2
)

func (Index_IndexUpdateMethod) Descriptor

func (Index_IndexUpdateMethod) Enum

func (Index_IndexUpdateMethod) EnumDescriptor deprecated

func (Index_IndexUpdateMethod) EnumDescriptor() ([]byte, []int)

Deprecated: Use Index_IndexUpdateMethod.Descriptor instead.

func (Index_IndexUpdateMethod) Number

func (Index_IndexUpdateMethod) String

func (x Index_IndexUpdateMethod) String() string

func (Index_IndexUpdateMethod) Type

type InputDataConfig

type InputDataConfig struct {

	// The instructions how the input data should be split between the
	// training, validation and test sets.
	// If no split type is provided, the
	// [fraction_split][google.cloud.aiplatform.v1.InputDataConfig.fraction_split]
	// is used by default.
	//
	// Types that are assignable to Split:
	//
	//	*InputDataConfig_FractionSplit
	//	*InputDataConfig_FilterSplit
	//	*InputDataConfig_PredefinedSplit
	//	*InputDataConfig_TimestampSplit
	//	*InputDataConfig_StratifiedSplit
	Split isInputDataConfig_Split `protobuf_oneof:"split"`
	// Only applicable to Custom and Hyperparameter Tuning TrainingPipelines.
	//
	// The destination of the training data to be written to.
	//
	// Supported destination file formats:
	//   - For non-tabular data: "jsonl".
	//   - For tabular data: "csv" and "bigquery".
	//
	// The following Vertex AI environment variables are passed to containers
	// or python modules of the training task when this field is set:
	//
	// * AIP_DATA_FORMAT : Exported data format.
	// * AIP_TRAINING_DATA_URI : Sharded exported training data uris.
	// * AIP_VALIDATION_DATA_URI : Sharded exported validation data uris.
	// * AIP_TEST_DATA_URI : Sharded exported test data uris.
	//
	// Types that are assignable to Destination:
	//
	//	*InputDataConfig_GcsDestination
	//	*InputDataConfig_BigqueryDestination
	Destination isInputDataConfig_Destination `protobuf_oneof:"destination"`
	// Required. The ID of the Dataset in the same Project and Location which data
	// will be used to train the Model. The Dataset must use schema compatible
	// with Model being trained, and what is compatible should be described in the
	// used TrainingPipeline's [training_task_definition]
	// [google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition].
	// For tabular Datasets, all their data is exported to training, to pick
	// and choose from.
	DatasetId string `protobuf:"bytes,1,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
	// Applicable only to Datasets that have DataItems and Annotations.
	//
	// A filter on Annotations of the Dataset. Only Annotations that both
	// match this filter and belong to DataItems not ignored by the split method
	// are used in respectively training, validation or test role, depending on
	// the role of the DataItem they are on (for the auto-assigned that role is
	// decided by Vertex AI). A filter with same syntax as the one used in
	// [ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations]
	// may be used, but note here it filters across all Annotations of the
	// Dataset, and not just within a single DataItem.
	AnnotationsFilter string `protobuf:"bytes,6,opt,name=annotations_filter,json=annotationsFilter,proto3" json:"annotations_filter,omitempty"`
	// Applicable only to custom training with Datasets that have DataItems and
	// Annotations.
	//
	// Cloud Storage URI that points to a YAML file describing the annotation
	// schema. The schema is defined as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	// The schema files that can be used here are found in
	// gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the
	// chosen schema must be consistent with
	// [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] of the
	// Dataset specified by
	// [dataset_id][google.cloud.aiplatform.v1.InputDataConfig.dataset_id].
	//
	// Only Annotations that both match this schema and belong to DataItems not
	// ignored by the split method are used in respectively training, validation
	// or test role, depending on the role of the DataItem they are on.
	//
	// When used in conjunction with
	// [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter],
	// the Annotations used for training are filtered by both
	// [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter]
	// and
	// [annotation_schema_uri][google.cloud.aiplatform.v1.InputDataConfig.annotation_schema_uri].
	AnnotationSchemaUri string `protobuf:"bytes,9,opt,name=annotation_schema_uri,json=annotationSchemaUri,proto3" json:"annotation_schema_uri,omitempty"`
	// Only applicable to Datasets that have SavedQueries.
	//
	// The ID of a SavedQuery (annotation set) under the Dataset specified by
	// [dataset_id][google.cloud.aiplatform.v1.InputDataConfig.dataset_id] used
	// for filtering Annotations for training.
	//
	// Only Annotations that are associated with this SavedQuery are used in
	// respectively training. When used in conjunction with
	// [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter],
	// the Annotations used for training are filtered by both
	// [saved_query_id][google.cloud.aiplatform.v1.InputDataConfig.saved_query_id]
	// and
	// [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter].
	//
	// Only one of
	// [saved_query_id][google.cloud.aiplatform.v1.InputDataConfig.saved_query_id]
	// and
	// [annotation_schema_uri][google.cloud.aiplatform.v1.InputDataConfig.annotation_schema_uri]
	// should be specified as both of them represent the same thing: problem type.
	SavedQueryId string `protobuf:"bytes,7,opt,name=saved_query_id,json=savedQueryId,proto3" json:"saved_query_id,omitempty"`
	// Whether to persist the ML use assignment to data item system labels.
	PersistMlUseAssignment bool `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model.

func (*InputDataConfig) Descriptor deprecated

func (*InputDataConfig) Descriptor() ([]byte, []int)

Deprecated: Use InputDataConfig.ProtoReflect.Descriptor instead.

func (*InputDataConfig) GetAnnotationSchemaUri

func (x *InputDataConfig) GetAnnotationSchemaUri() string

func (*InputDataConfig) GetAnnotationsFilter

func (x *InputDataConfig) GetAnnotationsFilter() string

func (*InputDataConfig) GetBigqueryDestination

func (x *InputDataConfig) GetBigqueryDestination() *BigQueryDestination

func (*InputDataConfig) GetDatasetId

func (x *InputDataConfig) GetDatasetId() string

func (*InputDataConfig) GetDestination

func (m *InputDataConfig) GetDestination() isInputDataConfig_Destination

func (*InputDataConfig) GetFilterSplit

func (x *InputDataConfig) GetFilterSplit() *FilterSplit

func (*InputDataConfig) GetFractionSplit

func (x *InputDataConfig) GetFractionSplit() *FractionSplit

func (*InputDataConfig) GetGcsDestination

func (x *InputDataConfig) GetGcsDestination() *GcsDestination

func (*InputDataConfig) GetPersistMlUseAssignment

func (x *InputDataConfig) GetPersistMlUseAssignment() bool

func (*InputDataConfig) GetPredefinedSplit

func (x *InputDataConfig) GetPredefinedSplit() *PredefinedSplit

func (*InputDataConfig) GetSavedQueryId

func (x *InputDataConfig) GetSavedQueryId() string

func (*InputDataConfig) GetSplit

func (m *InputDataConfig) GetSplit() isInputDataConfig_Split

func (*InputDataConfig) GetStratifiedSplit

func (x *InputDataConfig) GetStratifiedSplit() *StratifiedSplit

func (*InputDataConfig) GetTimestampSplit

func (x *InputDataConfig) GetTimestampSplit() *TimestampSplit

func (*InputDataConfig) ProtoMessage

func (*InputDataConfig) ProtoMessage()

func (*InputDataConfig) ProtoReflect

func (x *InputDataConfig) ProtoReflect() protoreflect.Message

func (*InputDataConfig) Reset

func (x *InputDataConfig) Reset()

func (*InputDataConfig) String

func (x *InputDataConfig) String() string

type InputDataConfig_BigqueryDestination

type InputDataConfig_BigqueryDestination struct {
	// Only applicable to custom training with tabular Dataset with BigQuery
	// source.
	//
	// The BigQuery project location where the training data is to be written
	// to. In the given project a new dataset is created with name
	// `dataset_<dataset-id>_<annotation-type>_<timestamp-of-training-call>`
	// where timestamp is in YYYY_MM_DDThh_mm_ss_sssZ format. All training
	// input data is written into that dataset. In the dataset three
	// tables are created, `training`, `validation` and `test`.
	//
	// * AIP_DATA_FORMAT = "bigquery".
	// * AIP_TRAINING_DATA_URI  =
	// "bigquery_destination.dataset_<dataset-id>_<annotation-type>_<time>.training"
	//
	// * AIP_VALIDATION_DATA_URI =
	// "bigquery_destination.dataset_<dataset-id>_<annotation-type>_<time>.validation"
	//
	// * AIP_TEST_DATA_URI =
	// "bigquery_destination.dataset_<dataset-id>_<annotation-type>_<time>.test"
	BigqueryDestination *BigQueryDestination `protobuf:"bytes,10,opt,name=bigquery_destination,json=bigqueryDestination,proto3,oneof"`
}

type InputDataConfig_FilterSplit

type InputDataConfig_FilterSplit struct {
	// Split based on the provided filters for each set.
	FilterSplit *FilterSplit `protobuf:"bytes,3,opt,name=filter_split,json=filterSplit,proto3,oneof"`
}

type InputDataConfig_FractionSplit

type InputDataConfig_FractionSplit struct {
	// Split based on fractions defining the size of each set.
	FractionSplit *FractionSplit `protobuf:"bytes,2,opt,name=fraction_split,json=fractionSplit,proto3,oneof"`
}

type InputDataConfig_GcsDestination

type InputDataConfig_GcsDestination struct {
	// The Cloud Storage location where the training data is to be
	// written to. In the given directory a new directory is created with
	// name:
	// `dataset-<dataset-id>-<annotation-type>-<timestamp-of-training-call>`
	// where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format.
	// All training input data is written into that directory.
	//
	// The Vertex AI environment variables representing Cloud Storage
	// data URIs are represented in the Cloud Storage wildcard
	// format to support sharded data. e.g.: "gs://.../training-*.jsonl"
	//
	// * AIP_DATA_FORMAT = "jsonl" for non-tabular data, "csv" for tabular data
	// * AIP_TRAINING_DATA_URI =
	// "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/training-*.${AIP_DATA_FORMAT}"
	//
	// * AIP_VALIDATION_DATA_URI =
	// "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/validation-*.${AIP_DATA_FORMAT}"
	//
	// * AIP_TEST_DATA_URI =
	// "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/test-*.${AIP_DATA_FORMAT}"
	GcsDestination *GcsDestination `protobuf:"bytes,8,opt,name=gcs_destination,json=gcsDestination,proto3,oneof"`
}

type InputDataConfig_PredefinedSplit

type InputDataConfig_PredefinedSplit struct {
	// Supported only for tabular Datasets.
	//
	// Split based on a predefined key.
	PredefinedSplit *PredefinedSplit `protobuf:"bytes,4,opt,name=predefined_split,json=predefinedSplit,proto3,oneof"`
}

type InputDataConfig_StratifiedSplit

type InputDataConfig_StratifiedSplit struct {
	// Supported only for tabular Datasets.
	//
	// Split based on the distribution of the specified column.
	StratifiedSplit *StratifiedSplit `protobuf:"bytes,12,opt,name=stratified_split,json=stratifiedSplit,proto3,oneof"`
}

type InputDataConfig_TimestampSplit

type InputDataConfig_TimestampSplit struct {
	// Supported only for tabular Datasets.
	//
	// Split based on the timestamp of the input data pieces.
	TimestampSplit *TimestampSplit `protobuf:"bytes,5,opt,name=timestamp_split,json=timestampSplit,proto3,oneof"`
}

type Int64Array

type Int64Array struct {

	// A list of int64 values.
	Values []int64 `protobuf:"varint,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

A list of int64 values.

func (*Int64Array) Descriptor deprecated

func (*Int64Array) Descriptor() ([]byte, []int)

Deprecated: Use Int64Array.ProtoReflect.Descriptor instead.

func (*Int64Array) GetValues

func (x *Int64Array) GetValues() []int64

func (*Int64Array) ProtoMessage

func (*Int64Array) ProtoMessage()

func (*Int64Array) ProtoReflect

func (x *Int64Array) ProtoReflect() protoreflect.Message

func (*Int64Array) Reset

func (x *Int64Array) Reset()

func (*Int64Array) String

func (x *Int64Array) String() string

type IntegratedGradientsAttribution

type IntegratedGradientsAttribution struct {

	// Required. The number of steps for approximating the path integral.
	// A good value to start is 50 and gradually increase until the
	// sum to diff property is within the desired error range.
	//
	// Valid range of its value is [1, 100], inclusively.
	StepCount int32 `protobuf:"varint,1,opt,name=step_count,json=stepCount,proto3" json:"step_count,omitempty"`
	// Config for SmoothGrad approximation of gradients.
	//
	// When enabled, the gradients are approximated by averaging the gradients
	// from noisy samples in the vicinity of the inputs. Adding
	// noise can help improve the computed gradients. Refer to this paper for more
	// details: https://arxiv.org/pdf/1706.03825.pdf
	SmoothGradConfig *SmoothGradConfig `protobuf:"bytes,2,opt,name=smooth_grad_config,json=smoothGradConfig,proto3" json:"smooth_grad_config,omitempty"`
	// Config for IG with blur baseline.
	//
	// When enabled, a linear path from the maximally blurred image to the input
	// image is created. Using a blurred baseline instead of zero (black image) is
	// motivated by the BlurIG approach explained here:
	// https://arxiv.org/abs/2004.03383
	BlurBaselineConfig *BlurBaselineConfig `protobuf:"bytes,3,opt,name=blur_baseline_config,json=blurBaselineConfig,proto3" json:"blur_baseline_config,omitempty"`
	// contains filtered or unexported fields
}

An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365

func (*IntegratedGradientsAttribution) Descriptor deprecated

func (*IntegratedGradientsAttribution) Descriptor() ([]byte, []int)

Deprecated: Use IntegratedGradientsAttribution.ProtoReflect.Descriptor instead.

func (*IntegratedGradientsAttribution) GetBlurBaselineConfig

func (x *IntegratedGradientsAttribution) GetBlurBaselineConfig() *BlurBaselineConfig

func (*IntegratedGradientsAttribution) GetSmoothGradConfig

func (x *IntegratedGradientsAttribution) GetSmoothGradConfig() *SmoothGradConfig

func (*IntegratedGradientsAttribution) GetStepCount

func (x *IntegratedGradientsAttribution) GetStepCount() int32

func (*IntegratedGradientsAttribution) ProtoMessage

func (*IntegratedGradientsAttribution) ProtoMessage()

func (*IntegratedGradientsAttribution) ProtoReflect

func (*IntegratedGradientsAttribution) Reset

func (x *IntegratedGradientsAttribution) Reset()

func (*IntegratedGradientsAttribution) String

type JobServiceClient

type JobServiceClient interface {
	// Creates a CustomJob. A created CustomJob right away
	// will be attempted to be run.
	CreateCustomJob(ctx context.Context, in *CreateCustomJobRequest, opts ...grpc.CallOption) (*CustomJob, error)
	// Gets a CustomJob.
	GetCustomJob(ctx context.Context, in *GetCustomJobRequest, opts ...grpc.CallOption) (*CustomJob, error)
	// Lists CustomJobs in a Location.
	ListCustomJobs(ctx context.Context, in *ListCustomJobsRequest, opts ...grpc.CallOption) (*ListCustomJobsResponse, error)
	// Deletes a CustomJob.
	DeleteCustomJob(ctx context.Context, in *DeleteCustomJobRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Cancels a CustomJob.
	// Starts asynchronous cancellation on the CustomJob. The server
	// makes a best effort to cancel the job, but success is not
	// guaranteed. Clients can use
	// [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob]
	// or other methods to check whether the cancellation succeeded or whether the
	// job completed despite cancellation. On successful cancellation,
	// the CustomJob is not deleted; instead it becomes a job with
	// a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with
	// a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
	// `Code.CANCELLED`, and
	// [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to
	// `CANCELLED`.
	CancelCustomJob(ctx context.Context, in *CancelCustomJobRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Creates a DataLabelingJob.
	CreateDataLabelingJob(ctx context.Context, in *CreateDataLabelingJobRequest, opts ...grpc.CallOption) (*DataLabelingJob, error)
	// Gets a DataLabelingJob.
	GetDataLabelingJob(ctx context.Context, in *GetDataLabelingJobRequest, opts ...grpc.CallOption) (*DataLabelingJob, error)
	// Lists DataLabelingJobs in a Location.
	ListDataLabelingJobs(ctx context.Context, in *ListDataLabelingJobsRequest, opts ...grpc.CallOption) (*ListDataLabelingJobsResponse, error)
	// Deletes a DataLabelingJob.
	DeleteDataLabelingJob(ctx context.Context, in *DeleteDataLabelingJobRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
	CancelDataLabelingJob(ctx context.Context, in *CancelDataLabelingJobRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Creates a HyperparameterTuningJob
	CreateHyperparameterTuningJob(ctx context.Context, in *CreateHyperparameterTuningJobRequest, opts ...grpc.CallOption) (*HyperparameterTuningJob, error)
	// Gets a HyperparameterTuningJob
	GetHyperparameterTuningJob(ctx context.Context, in *GetHyperparameterTuningJobRequest, opts ...grpc.CallOption) (*HyperparameterTuningJob, error)
	// Lists HyperparameterTuningJobs in a Location.
	ListHyperparameterTuningJobs(ctx context.Context, in *ListHyperparameterTuningJobsRequest, opts ...grpc.CallOption) (*ListHyperparameterTuningJobsResponse, error)
	// Deletes a HyperparameterTuningJob.
	DeleteHyperparameterTuningJob(ctx context.Context, in *DeleteHyperparameterTuningJobRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Cancels a HyperparameterTuningJob.
	// Starts asynchronous cancellation on the HyperparameterTuningJob. The server
	// makes a best effort to cancel the job, but success is not
	// guaranteed. Clients can use
	// [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob]
	// or other methods to check whether the cancellation succeeded or whether the
	// job completed despite cancellation. On successful cancellation,
	// the HyperparameterTuningJob is not deleted; instead it becomes a job with
	// a
	// [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error]
	// value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
	// corresponding to `Code.CANCELLED`, and
	// [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state]
	// is set to `CANCELLED`.
	CancelHyperparameterTuningJob(ctx context.Context, in *CancelHyperparameterTuningJobRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Creates a NasJob
	CreateNasJob(ctx context.Context, in *CreateNasJobRequest, opts ...grpc.CallOption) (*NasJob, error)
	// Gets a NasJob
	GetNasJob(ctx context.Context, in *GetNasJobRequest, opts ...grpc.CallOption) (*NasJob, error)
	// Lists NasJobs in a Location.
	ListNasJobs(ctx context.Context, in *ListNasJobsRequest, opts ...grpc.CallOption) (*ListNasJobsResponse, error)
	// Deletes a NasJob.
	DeleteNasJob(ctx context.Context, in *DeleteNasJobRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Cancels a NasJob.
	// Starts asynchronous cancellation on the NasJob. The server
	// makes a best effort to cancel the job, but success is not
	// guaranteed. Clients can use
	// [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob] or
	// other methods to check whether the cancellation succeeded or whether the
	// job completed despite cancellation. On successful cancellation,
	// the NasJob is not deleted; instead it becomes a job with
	// a [NasJob.error][google.cloud.aiplatform.v1.NasJob.error] value with a
	// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
	// `Code.CANCELLED`, and
	// [NasJob.state][google.cloud.aiplatform.v1.NasJob.state] is set to
	// `CANCELLED`.
	CancelNasJob(ctx context.Context, in *CancelNasJobRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Gets a NasTrialDetail.
	GetNasTrialDetail(ctx context.Context, in *GetNasTrialDetailRequest, opts ...grpc.CallOption) (*NasTrialDetail, error)
	// List top NasTrialDetails of a NasJob.
	ListNasTrialDetails(ctx context.Context, in *ListNasTrialDetailsRequest, opts ...grpc.CallOption) (*ListNasTrialDetailsResponse, error)
	// Creates a BatchPredictionJob. A BatchPredictionJob once created will
	// right away be attempted to start.
	CreateBatchPredictionJob(ctx context.Context, in *CreateBatchPredictionJobRequest, opts ...grpc.CallOption) (*BatchPredictionJob, error)
	// Gets a BatchPredictionJob
	GetBatchPredictionJob(ctx context.Context, in *GetBatchPredictionJobRequest, opts ...grpc.CallOption) (*BatchPredictionJob, error)
	// Lists BatchPredictionJobs in a Location.
	ListBatchPredictionJobs(ctx context.Context, in *ListBatchPredictionJobsRequest, opts ...grpc.CallOption) (*ListBatchPredictionJobsResponse, error)
	// Deletes a BatchPredictionJob. Can only be called on jobs that already
	// finished.
	DeleteBatchPredictionJob(ctx context.Context, in *DeleteBatchPredictionJobRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Cancels a BatchPredictionJob.
	//
	// Starts asynchronous cancellation on the BatchPredictionJob. The server
	// makes the best effort to cancel the job, but success is not
	// guaranteed. Clients can use
	// [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob]
	// or other methods to check whether the cancellation succeeded or whether the
	// job completed despite cancellation. On a successful cancellation,
	// the BatchPredictionJob is not deleted;instead its
	// [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state]
	// is set to `CANCELLED`. Any files already outputted by the job are not
	// deleted.
	CancelBatchPredictionJob(ctx context.Context, in *CancelBatchPredictionJobRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Creates a ModelDeploymentMonitoringJob. It will run periodically on a
	// configured interval.
	CreateModelDeploymentMonitoringJob(ctx context.Context, in *CreateModelDeploymentMonitoringJobRequest, opts ...grpc.CallOption) (*ModelDeploymentMonitoringJob, error)
	// Searches Model Monitoring Statistics generated within a given time window.
	SearchModelDeploymentMonitoringStatsAnomalies(ctx context.Context, in *SearchModelDeploymentMonitoringStatsAnomaliesRequest, opts ...grpc.CallOption) (*SearchModelDeploymentMonitoringStatsAnomaliesResponse, error)
	// Gets a ModelDeploymentMonitoringJob.
	GetModelDeploymentMonitoringJob(ctx context.Context, in *GetModelDeploymentMonitoringJobRequest, opts ...grpc.CallOption) (*ModelDeploymentMonitoringJob, error)
	// Lists ModelDeploymentMonitoringJobs in a Location.
	ListModelDeploymentMonitoringJobs(ctx context.Context, in *ListModelDeploymentMonitoringJobsRequest, opts ...grpc.CallOption) (*ListModelDeploymentMonitoringJobsResponse, error)
	// Updates a ModelDeploymentMonitoringJob.
	UpdateModelDeploymentMonitoringJob(ctx context.Context, in *UpdateModelDeploymentMonitoringJobRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a ModelDeploymentMonitoringJob.
	DeleteModelDeploymentMonitoringJob(ctx context.Context, in *DeleteModelDeploymentMonitoringJobRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Pauses a ModelDeploymentMonitoringJob. If the job is running, the server
	// makes a best effort to cancel the job. Will mark
	// [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state]
	// to 'PAUSED'.
	PauseModelDeploymentMonitoringJob(ctx context.Context, in *PauseModelDeploymentMonitoringJobRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Resumes a paused ModelDeploymentMonitoringJob. It will start to run from
	// next scheduled time. A deleted ModelDeploymentMonitoringJob can't be
	// resumed.
	ResumeModelDeploymentMonitoringJob(ctx context.Context, in *ResumeModelDeploymentMonitoringJobRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

JobServiceClient is the client API for JobService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewJobServiceClient

func NewJobServiceClient(cc grpc.ClientConnInterface) JobServiceClient

type JobServiceServer

type JobServiceServer interface {
	// Creates a CustomJob. A created CustomJob right away
	// will be attempted to be run.
	CreateCustomJob(context.Context, *CreateCustomJobRequest) (*CustomJob, error)
	// Gets a CustomJob.
	GetCustomJob(context.Context, *GetCustomJobRequest) (*CustomJob, error)
	// Lists CustomJobs in a Location.
	ListCustomJobs(context.Context, *ListCustomJobsRequest) (*ListCustomJobsResponse, error)
	// Deletes a CustomJob.
	DeleteCustomJob(context.Context, *DeleteCustomJobRequest) (*longrunningpb.Operation, error)
	// Cancels a CustomJob.
	// Starts asynchronous cancellation on the CustomJob. The server
	// makes a best effort to cancel the job, but success is not
	// guaranteed. Clients can use
	// [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob]
	// or other methods to check whether the cancellation succeeded or whether the
	// job completed despite cancellation. On successful cancellation,
	// the CustomJob is not deleted; instead it becomes a job with
	// a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with
	// a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
	// `Code.CANCELLED`, and
	// [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to
	// `CANCELLED`.
	CancelCustomJob(context.Context, *CancelCustomJobRequest) (*emptypb.Empty, error)
	// Creates a DataLabelingJob.
	CreateDataLabelingJob(context.Context, *CreateDataLabelingJobRequest) (*DataLabelingJob, error)
	// Gets a DataLabelingJob.
	GetDataLabelingJob(context.Context, *GetDataLabelingJobRequest) (*DataLabelingJob, error)
	// Lists DataLabelingJobs in a Location.
	ListDataLabelingJobs(context.Context, *ListDataLabelingJobsRequest) (*ListDataLabelingJobsResponse, error)
	// Deletes a DataLabelingJob.
	DeleteDataLabelingJob(context.Context, *DeleteDataLabelingJobRequest) (*longrunningpb.Operation, error)
	// Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
	CancelDataLabelingJob(context.Context, *CancelDataLabelingJobRequest) (*emptypb.Empty, error)
	// Creates a HyperparameterTuningJob
	CreateHyperparameterTuningJob(context.Context, *CreateHyperparameterTuningJobRequest) (*HyperparameterTuningJob, error)
	// Gets a HyperparameterTuningJob
	GetHyperparameterTuningJob(context.Context, *GetHyperparameterTuningJobRequest) (*HyperparameterTuningJob, error)
	// Lists HyperparameterTuningJobs in a Location.
	ListHyperparameterTuningJobs(context.Context, *ListHyperparameterTuningJobsRequest) (*ListHyperparameterTuningJobsResponse, error)
	// Deletes a HyperparameterTuningJob.
	DeleteHyperparameterTuningJob(context.Context, *DeleteHyperparameterTuningJobRequest) (*longrunningpb.Operation, error)
	// Cancels a HyperparameterTuningJob.
	// Starts asynchronous cancellation on the HyperparameterTuningJob. The server
	// makes a best effort to cancel the job, but success is not
	// guaranteed. Clients can use
	// [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob]
	// or other methods to check whether the cancellation succeeded or whether the
	// job completed despite cancellation. On successful cancellation,
	// the HyperparameterTuningJob is not deleted; instead it becomes a job with
	// a
	// [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error]
	// value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
	// corresponding to `Code.CANCELLED`, and
	// [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state]
	// is set to `CANCELLED`.
	CancelHyperparameterTuningJob(context.Context, *CancelHyperparameterTuningJobRequest) (*emptypb.Empty, error)
	// Creates a NasJob
	CreateNasJob(context.Context, *CreateNasJobRequest) (*NasJob, error)
	// Gets a NasJob
	GetNasJob(context.Context, *GetNasJobRequest) (*NasJob, error)
	// Lists NasJobs in a Location.
	ListNasJobs(context.Context, *ListNasJobsRequest) (*ListNasJobsResponse, error)
	// Deletes a NasJob.
	DeleteNasJob(context.Context, *DeleteNasJobRequest) (*longrunningpb.Operation, error)
	// Cancels a NasJob.
	// Starts asynchronous cancellation on the NasJob. The server
	// makes a best effort to cancel the job, but success is not
	// guaranteed. Clients can use
	// [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob] or
	// other methods to check whether the cancellation succeeded or whether the
	// job completed despite cancellation. On successful cancellation,
	// the NasJob is not deleted; instead it becomes a job with
	// a [NasJob.error][google.cloud.aiplatform.v1.NasJob.error] value with a
	// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
	// `Code.CANCELLED`, and
	// [NasJob.state][google.cloud.aiplatform.v1.NasJob.state] is set to
	// `CANCELLED`.
	CancelNasJob(context.Context, *CancelNasJobRequest) (*emptypb.Empty, error)
	// Gets a NasTrialDetail.
	GetNasTrialDetail(context.Context, *GetNasTrialDetailRequest) (*NasTrialDetail, error)
	// List top NasTrialDetails of a NasJob.
	ListNasTrialDetails(context.Context, *ListNasTrialDetailsRequest) (*ListNasTrialDetailsResponse, error)
	// Creates a BatchPredictionJob. A BatchPredictionJob once created will
	// right away be attempted to start.
	CreateBatchPredictionJob(context.Context, *CreateBatchPredictionJobRequest) (*BatchPredictionJob, error)
	// Gets a BatchPredictionJob
	GetBatchPredictionJob(context.Context, *GetBatchPredictionJobRequest) (*BatchPredictionJob, error)
	// Lists BatchPredictionJobs in a Location.
	ListBatchPredictionJobs(context.Context, *ListBatchPredictionJobsRequest) (*ListBatchPredictionJobsResponse, error)
	// Deletes a BatchPredictionJob. Can only be called on jobs that already
	// finished.
	DeleteBatchPredictionJob(context.Context, *DeleteBatchPredictionJobRequest) (*longrunningpb.Operation, error)
	// Cancels a BatchPredictionJob.
	//
	// Starts asynchronous cancellation on the BatchPredictionJob. The server
	// makes the best effort to cancel the job, but success is not
	// guaranteed. Clients can use
	// [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob]
	// or other methods to check whether the cancellation succeeded or whether the
	// job completed despite cancellation. On a successful cancellation,
	// the BatchPredictionJob is not deleted;instead its
	// [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state]
	// is set to `CANCELLED`. Any files already outputted by the job are not
	// deleted.
	CancelBatchPredictionJob(context.Context, *CancelBatchPredictionJobRequest) (*emptypb.Empty, error)
	// Creates a ModelDeploymentMonitoringJob. It will run periodically on a
	// configured interval.
	CreateModelDeploymentMonitoringJob(context.Context, *CreateModelDeploymentMonitoringJobRequest) (*ModelDeploymentMonitoringJob, error)
	// Searches Model Monitoring Statistics generated within a given time window.
	SearchModelDeploymentMonitoringStatsAnomalies(context.Context, *SearchModelDeploymentMonitoringStatsAnomaliesRequest) (*SearchModelDeploymentMonitoringStatsAnomaliesResponse, error)
	// Gets a ModelDeploymentMonitoringJob.
	GetModelDeploymentMonitoringJob(context.Context, *GetModelDeploymentMonitoringJobRequest) (*ModelDeploymentMonitoringJob, error)
	// Lists ModelDeploymentMonitoringJobs in a Location.
	ListModelDeploymentMonitoringJobs(context.Context, *ListModelDeploymentMonitoringJobsRequest) (*ListModelDeploymentMonitoringJobsResponse, error)
	// Updates a ModelDeploymentMonitoringJob.
	UpdateModelDeploymentMonitoringJob(context.Context, *UpdateModelDeploymentMonitoringJobRequest) (*longrunningpb.Operation, error)
	// Deletes a ModelDeploymentMonitoringJob.
	DeleteModelDeploymentMonitoringJob(context.Context, *DeleteModelDeploymentMonitoringJobRequest) (*longrunningpb.Operation, error)
	// Pauses a ModelDeploymentMonitoringJob. If the job is running, the server
	// makes a best effort to cancel the job. Will mark
	// [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state]
	// to 'PAUSED'.
	PauseModelDeploymentMonitoringJob(context.Context, *PauseModelDeploymentMonitoringJobRequest) (*emptypb.Empty, error)
	// Resumes a paused ModelDeploymentMonitoringJob. It will start to run from
	// next scheduled time. A deleted ModelDeploymentMonitoringJob can't be
	// resumed.
	ResumeModelDeploymentMonitoringJob(context.Context, *ResumeModelDeploymentMonitoringJobRequest) (*emptypb.Empty, error)
}

JobServiceServer is the server API for JobService service.

type JobState

type JobState int32

Describes the state of a job.

const (
	// The job state is unspecified.
	JobState_JOB_STATE_UNSPECIFIED JobState = 0
	// The job has been just created or resumed and processing has not yet begun.
	JobState_JOB_STATE_QUEUED JobState = 1
	// The service is preparing to run the job.
	JobState_JOB_STATE_PENDING JobState = 2
	// The job is in progress.
	JobState_JOB_STATE_RUNNING JobState = 3
	// The job completed successfully.
	JobState_JOB_STATE_SUCCEEDED JobState = 4
	// The job failed.
	JobState_JOB_STATE_FAILED JobState = 5
	// The job is being cancelled. From this state the job may only go to
	// either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
	JobState_JOB_STATE_CANCELLING JobState = 6
	// The job has been cancelled.
	JobState_JOB_STATE_CANCELLED JobState = 7
	// The job has been stopped, and can be resumed.
	JobState_JOB_STATE_PAUSED JobState = 8
	// The job has expired.
	JobState_JOB_STATE_EXPIRED JobState = 9
	// The job is being updated. Only jobs in the `RUNNING` state can be updated.
	// After updating, the job goes back to the `RUNNING` state.
	JobState_JOB_STATE_UPDATING JobState = 10
	// The job is partially succeeded, some results may be missing due to errors.
	JobState_JOB_STATE_PARTIALLY_SUCCEEDED JobState = 11
)

func (JobState) Descriptor

func (JobState) Descriptor() protoreflect.EnumDescriptor

func (JobState) Enum

func (x JobState) Enum() *JobState

func (JobState) EnumDescriptor deprecated

func (JobState) EnumDescriptor() ([]byte, []int)

Deprecated: Use JobState.Descriptor instead.

func (JobState) Number

func (x JobState) Number() protoreflect.EnumNumber

func (JobState) String

func (x JobState) String() string

func (JobState) Type

type LargeModelReference added in v1.44.0

type LargeModelReference struct {

	// Required. The unique name of the large Foundation or pre-built model. Like
	// "chat-bison", "text-bison". Or model name with version ID, like
	// "chat-bison@001", "text-bison@005", etc.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Contains information about the Large Model.

func (*LargeModelReference) Descriptor deprecated added in v1.44.0

func (*LargeModelReference) Descriptor() ([]byte, []int)

Deprecated: Use LargeModelReference.ProtoReflect.Descriptor instead.

func (*LargeModelReference) GetName added in v1.44.0

func (x *LargeModelReference) GetName() string

func (*LargeModelReference) ProtoMessage added in v1.44.0

func (*LargeModelReference) ProtoMessage()

func (*LargeModelReference) ProtoReflect added in v1.44.0

func (x *LargeModelReference) ProtoReflect() protoreflect.Message

func (*LargeModelReference) Reset added in v1.44.0

func (x *LargeModelReference) Reset()

func (*LargeModelReference) String added in v1.44.0

func (x *LargeModelReference) String() string

type LineageSubgraph

type LineageSubgraph struct {

	// The Artifact nodes in the subgraph.
	Artifacts []*Artifact `protobuf:"bytes,1,rep,name=artifacts,proto3" json:"artifacts,omitempty"`
	// The Execution nodes in the subgraph.
	Executions []*Execution `protobuf:"bytes,2,rep,name=executions,proto3" json:"executions,omitempty"`
	// The Event edges between Artifacts and Executions in the subgraph.
	Events []*Event `protobuf:"bytes,3,rep,name=events,proto3" json:"events,omitempty"`
	// contains filtered or unexported fields
}

A subgraph of the overall lineage graph. Event edges connect Artifact and Execution nodes.

func (*LineageSubgraph) Descriptor deprecated

func (*LineageSubgraph) Descriptor() ([]byte, []int)

Deprecated: Use LineageSubgraph.ProtoReflect.Descriptor instead.

func (*LineageSubgraph) GetArtifacts

func (x *LineageSubgraph) GetArtifacts() []*Artifact

func (*LineageSubgraph) GetEvents

func (x *LineageSubgraph) GetEvents() []*Event

func (*LineageSubgraph) GetExecutions

func (x *LineageSubgraph) GetExecutions() []*Execution

func (*LineageSubgraph) ProtoMessage

func (*LineageSubgraph) ProtoMessage()

func (*LineageSubgraph) ProtoReflect

func (x *LineageSubgraph) ProtoReflect() protoreflect.Message

func (*LineageSubgraph) Reset

func (x *LineageSubgraph) Reset()

func (*LineageSubgraph) String

func (x *LineageSubgraph) String() string

type ListAnnotationsRequest

type ListAnnotationsRequest struct {

	// Required. The resource name of the DataItem to list Annotations from.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].

func (*ListAnnotationsRequest) Descriptor deprecated

func (*ListAnnotationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListAnnotationsRequest.ProtoReflect.Descriptor instead.

func (*ListAnnotationsRequest) GetFilter

func (x *ListAnnotationsRequest) GetFilter() string

func (*ListAnnotationsRequest) GetOrderBy

func (x *ListAnnotationsRequest) GetOrderBy() string

func (*ListAnnotationsRequest) GetPageSize

func (x *ListAnnotationsRequest) GetPageSize() int32

func (*ListAnnotationsRequest) GetPageToken

func (x *ListAnnotationsRequest) GetPageToken() string

func (*ListAnnotationsRequest) GetParent

func (x *ListAnnotationsRequest) GetParent() string

func (*ListAnnotationsRequest) GetReadMask

func (x *ListAnnotationsRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListAnnotationsRequest) ProtoMessage

func (*ListAnnotationsRequest) ProtoMessage()

func (*ListAnnotationsRequest) ProtoReflect

func (x *ListAnnotationsRequest) ProtoReflect() protoreflect.Message

func (*ListAnnotationsRequest) Reset

func (x *ListAnnotationsRequest) Reset()

func (*ListAnnotationsRequest) String

func (x *ListAnnotationsRequest) String() string

type ListAnnotationsResponse

type ListAnnotationsResponse struct {

	// A list of Annotations that matches the specified filter in the request.
	Annotations []*Annotation `protobuf:"bytes,1,rep,name=annotations,proto3" json:"annotations,omitempty"`
	// The standard List next-page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [DatasetService.ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].

func (*ListAnnotationsResponse) Descriptor deprecated

func (*ListAnnotationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListAnnotationsResponse.ProtoReflect.Descriptor instead.

func (*ListAnnotationsResponse) GetAnnotations

func (x *ListAnnotationsResponse) GetAnnotations() []*Annotation

func (*ListAnnotationsResponse) GetNextPageToken

func (x *ListAnnotationsResponse) GetNextPageToken() string

func (*ListAnnotationsResponse) ProtoMessage

func (*ListAnnotationsResponse) ProtoMessage()

func (*ListAnnotationsResponse) ProtoReflect

func (x *ListAnnotationsResponse) ProtoReflect() protoreflect.Message

func (*ListAnnotationsResponse) Reset

func (x *ListAnnotationsResponse) Reset()

func (*ListAnnotationsResponse) String

func (x *ListAnnotationsResponse) String() string

type ListArtifactsRequest

type ListArtifactsRequest struct {

	// Required. The MetadataStore whose Artifacts should be listed.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of Artifacts to return. The service may return fewer.
	// Must be in range 1-1000, inclusive. Defaults to 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other provided parameters must match the call that
	// provided the page token. (Otherwise the request will fail with
	// INVALID_ARGUMENT error.)
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter specifying the boolean condition for the Artifacts to satisfy in
	// order to be part of the result set.
	// The syntax to define filter query is based on https://google.aip.dev/160.
	// The supported set of filters include the following:
	//
	//   - **Attribute filtering**:
	//     For example: `display_name = "test"`.
	//     Supported fields include: `name`, `display_name`, `uri`, `state`,
	//     `schema_title`, `create_time`, and `update_time`.
	//     Time fields, such as `create_time` and `update_time`, require values
	//     specified in RFC-3339 format.
	//     For example: `create_time = "2020-11-19T11:30:00-04:00"`
	//   - **Metadata field**:
	//     To filter on metadata fields use traversal operation as follows:
	//     `metadata.<field_name>.<type_value>`.
	//     For example: `metadata.field_1.number_value = 10.0`
	//     In case the field name contains special characters (such as colon), one
	//     can embed it inside double quote.
	//     For example: `metadata."field:1".number_value = 10.0`
	//   - **Context based filtering**:
	//     To filter Artifacts based on the contexts to which they belong, use the
	//     function operator with the full resource name
	//     `in_context(<context-name>)`.
	//     For example:
	//     `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`
	//
	// Each of the above supported filter types can be combined together using
	// logical operators (`AND` & `OR`). Maximum nested expression depth allowed
	// is 5.
	//
	// For example: `display_name = "test" AND metadata.field1.bool_value = true`.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// How the list of messages is ordered. Specify the values to order by and an
	// ordering operation. The default sorting order is ascending. To specify
	// descending order for a field, users append a " desc" suffix; for example:
	// "foo desc, bar".
	// Subfields are specified with a `.` character, such as foo.bar.
	// see https://google.aip.dev/132#ordering for more details.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts].

func (*ListArtifactsRequest) Descriptor deprecated

func (*ListArtifactsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListArtifactsRequest.ProtoReflect.Descriptor instead.

func (*ListArtifactsRequest) GetFilter

func (x *ListArtifactsRequest) GetFilter() string

func (*ListArtifactsRequest) GetOrderBy

func (x *ListArtifactsRequest) GetOrderBy() string

func (*ListArtifactsRequest) GetPageSize

func (x *ListArtifactsRequest) GetPageSize() int32

func (*ListArtifactsRequest) GetPageToken

func (x *ListArtifactsRequest) GetPageToken() string

func (*ListArtifactsRequest) GetParent

func (x *ListArtifactsRequest) GetParent() string

func (*ListArtifactsRequest) ProtoMessage

func (*ListArtifactsRequest) ProtoMessage()

func (*ListArtifactsRequest) ProtoReflect

func (x *ListArtifactsRequest) ProtoReflect() protoreflect.Message

func (*ListArtifactsRequest) Reset

func (x *ListArtifactsRequest) Reset()

func (*ListArtifactsRequest) String

func (x *ListArtifactsRequest) String() string

type ListArtifactsResponse

type ListArtifactsResponse struct {

	// The Artifacts retrieved from the MetadataStore.
	Artifacts []*Artifact `protobuf:"bytes,1,rep,name=artifacts,proto3" json:"artifacts,omitempty"`
	// A token, which can be sent as
	// [ListArtifactsRequest.page_token][google.cloud.aiplatform.v1.ListArtifactsRequest.page_token]
	// to retrieve the next page.
	// If this field is not populated, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts].

func (*ListArtifactsResponse) Descriptor deprecated

func (*ListArtifactsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListArtifactsResponse.ProtoReflect.Descriptor instead.

func (*ListArtifactsResponse) GetArtifacts

func (x *ListArtifactsResponse) GetArtifacts() []*Artifact

func (*ListArtifactsResponse) GetNextPageToken

func (x *ListArtifactsResponse) GetNextPageToken() string

func (*ListArtifactsResponse) ProtoMessage

func (*ListArtifactsResponse) ProtoMessage()

func (*ListArtifactsResponse) ProtoReflect

func (x *ListArtifactsResponse) ProtoReflect() protoreflect.Message

func (*ListArtifactsResponse) Reset

func (x *ListArtifactsResponse) Reset()

func (*ListArtifactsResponse) String

func (x *ListArtifactsResponse) String() string

type ListBatchPredictionJobsRequest

type ListBatchPredictionJobsRequest struct {

	// Required. The resource name of the Location to list the BatchPredictionJobs
	// from. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	//
	// Supported fields:
	//
	//   - `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
	//   - `model_display_name` supports `=`, `!=` comparisons.
	//   - `state` supports `=`, `!=` comparisons.
	//   - `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
	//     `create_time` must be in RFC 3339 format.
	//   - `labels` supports general map functions that is:
	//     `labels.key=value` - key:value equality
	//     `labels.key:* - key existence
	//
	// Some examples of using the filter are:
	//
	//   - `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
	//   - `state!="JOB_STATE_FAILED" OR display_name="my_job"`
	//   - `NOT display_name="my_job"`
	//   - `create_time>"2021-05-18T00:00:00Z"`
	//   - `labels.keyA=valueA`
	//   - `labels.keyB:*`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token]
	// of the previous
	// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs].

func (*ListBatchPredictionJobsRequest) Descriptor deprecated

func (*ListBatchPredictionJobsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListBatchPredictionJobsRequest.ProtoReflect.Descriptor instead.

func (*ListBatchPredictionJobsRequest) GetFilter

func (x *ListBatchPredictionJobsRequest) GetFilter() string

func (*ListBatchPredictionJobsRequest) GetPageSize

func (x *ListBatchPredictionJobsRequest) GetPageSize() int32

func (*ListBatchPredictionJobsRequest) GetPageToken

func (x *ListBatchPredictionJobsRequest) GetPageToken() string

func (*ListBatchPredictionJobsRequest) GetParent

func (x *ListBatchPredictionJobsRequest) GetParent() string

func (*ListBatchPredictionJobsRequest) GetReadMask

func (*ListBatchPredictionJobsRequest) ProtoMessage

func (*ListBatchPredictionJobsRequest) ProtoMessage()

func (*ListBatchPredictionJobsRequest) ProtoReflect

func (*ListBatchPredictionJobsRequest) Reset

func (x *ListBatchPredictionJobsRequest) Reset()

func (*ListBatchPredictionJobsRequest) String

type ListBatchPredictionJobsResponse

type ListBatchPredictionJobsResponse struct {

	// List of BatchPredictionJobs in the requested page.
	BatchPredictionJobs []*BatchPredictionJob `protobuf:"bytes,1,rep,name=batch_prediction_jobs,json=batchPredictionJobs,proto3" json:"batch_prediction_jobs,omitempty"`
	// A token to retrieve the next page of results.
	// Pass to
	// [ListBatchPredictionJobsRequest.page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs]

func (*ListBatchPredictionJobsResponse) Descriptor deprecated

func (*ListBatchPredictionJobsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListBatchPredictionJobsResponse.ProtoReflect.Descriptor instead.

func (*ListBatchPredictionJobsResponse) GetBatchPredictionJobs

func (x *ListBatchPredictionJobsResponse) GetBatchPredictionJobs() []*BatchPredictionJob

func (*ListBatchPredictionJobsResponse) GetNextPageToken

func (x *ListBatchPredictionJobsResponse) GetNextPageToken() string

func (*ListBatchPredictionJobsResponse) ProtoMessage

func (*ListBatchPredictionJobsResponse) ProtoMessage()

func (*ListBatchPredictionJobsResponse) ProtoReflect

func (*ListBatchPredictionJobsResponse) Reset

func (*ListBatchPredictionJobsResponse) String

type ListContextsRequest

type ListContextsRequest struct {

	// Required. The MetadataStore whose Contexts should be listed.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of Contexts to return. The service may return fewer.
	// Must be in range 1-1000, inclusive. Defaults to 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other provided parameters must match the call that
	// provided the page token. (Otherwise the request will fail with
	// INVALID_ARGUMENT error.)
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter specifying the boolean condition for the Contexts to satisfy in
	// order to be part of the result set.
	// The syntax to define filter query is based on https://google.aip.dev/160.
	// Following are the supported set of filters:
	//
	//   - **Attribute filtering**:
	//     For example: `display_name = "test"`.
	//     Supported fields include: `name`, `display_name`, `schema_title`,
	//     `create_time`, and `update_time`.
	//     Time fields, such as `create_time` and `update_time`, require values
	//     specified in RFC-3339 format.
	//     For example: `create_time = "2020-11-19T11:30:00-04:00"`.
	//
	//   - **Metadata field**:
	//     To filter on metadata fields use traversal operation as follows:
	//     `metadata.<field_name>.<type_value>`.
	//     For example: `metadata.field_1.number_value = 10.0`.
	//     In case the field name contains special characters (such as colon), one
	//     can embed it inside double quote.
	//     For example: `metadata."field:1".number_value = 10.0`
	//
	//   - **Parent Child filtering**:
	//     To filter Contexts based on parent-child relationship use the HAS
	//     operator as follows:
	//
	//     “`
	//     parent_contexts:
	//     "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
	//     child_contexts:
	//     "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
	//     “`
	//
	// Each of the above supported filters can be combined together using
	// logical operators (`AND` & `OR`). Maximum nested expression depth allowed
	// is 5.
	//
	// For example: `display_name = "test" AND metadata.field1.bool_value = true`.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// How the list of messages is ordered. Specify the values to order by and an
	// ordering operation. The default sorting order is ascending. To specify
	// descending order for a field, users append a " desc" suffix; for example:
	// "foo desc, bar".
	// Subfields are specified with a `.` character, such as foo.bar.
	// see https://google.aip.dev/132#ordering for more details.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]

func (*ListContextsRequest) Descriptor deprecated

func (*ListContextsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListContextsRequest.ProtoReflect.Descriptor instead.

func (*ListContextsRequest) GetFilter

func (x *ListContextsRequest) GetFilter() string

func (*ListContextsRequest) GetOrderBy

func (x *ListContextsRequest) GetOrderBy() string

func (*ListContextsRequest) GetPageSize

func (x *ListContextsRequest) GetPageSize() int32

func (*ListContextsRequest) GetPageToken

func (x *ListContextsRequest) GetPageToken() string

func (*ListContextsRequest) GetParent

func (x *ListContextsRequest) GetParent() string

func (*ListContextsRequest) ProtoMessage

func (*ListContextsRequest) ProtoMessage()

func (*ListContextsRequest) ProtoReflect

func (x *ListContextsRequest) ProtoReflect() protoreflect.Message

func (*ListContextsRequest) Reset

func (x *ListContextsRequest) Reset()

func (*ListContextsRequest) String

func (x *ListContextsRequest) String() string

type ListContextsResponse

type ListContextsResponse struct {

	// The Contexts retrieved from the MetadataStore.
	Contexts []*Context `protobuf:"bytes,1,rep,name=contexts,proto3" json:"contexts,omitempty"`
	// A token, which can be sent as
	// [ListContextsRequest.page_token][google.cloud.aiplatform.v1.ListContextsRequest.page_token]
	// to retrieve the next page.
	// If this field is not populated, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts].

func (*ListContextsResponse) Descriptor deprecated

func (*ListContextsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListContextsResponse.ProtoReflect.Descriptor instead.

func (*ListContextsResponse) GetContexts

func (x *ListContextsResponse) GetContexts() []*Context

func (*ListContextsResponse) GetNextPageToken

func (x *ListContextsResponse) GetNextPageToken() string

func (*ListContextsResponse) ProtoMessage

func (*ListContextsResponse) ProtoMessage()

func (*ListContextsResponse) ProtoReflect

func (x *ListContextsResponse) ProtoReflect() protoreflect.Message

func (*ListContextsResponse) Reset

func (x *ListContextsResponse) Reset()

func (*ListContextsResponse) String

func (x *ListContextsResponse) String() string

type ListCustomJobsRequest

type ListCustomJobsRequest struct {

	// Required. The resource name of the Location to list the CustomJobs from.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	//
	// Supported fields:
	//
	//   - `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
	//   - `state` supports `=`, `!=` comparisons.
	//   - `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
	//     `create_time` must be in RFC 3339 format.
	//   - `labels` supports general map functions that is:
	//     `labels.key=value` - key:value equality
	//     `labels.key:* - key existence
	//
	// Some examples of using the filter are:
	//
	//   - `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
	//   - `state!="JOB_STATE_FAILED" OR display_name="my_job"`
	//   - `NOT display_name="my_job"`
	//   - `create_time>"2021-05-18T00:00:00Z"`
	//   - `labels.keyA=valueA`
	//   - `labels.keyB:*`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token]
	// of the previous
	// [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs].

func (*ListCustomJobsRequest) Descriptor deprecated

func (*ListCustomJobsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListCustomJobsRequest.ProtoReflect.Descriptor instead.

func (*ListCustomJobsRequest) GetFilter

func (x *ListCustomJobsRequest) GetFilter() string

func (*ListCustomJobsRequest) GetPageSize

func (x *ListCustomJobsRequest) GetPageSize() int32

func (*ListCustomJobsRequest) GetPageToken

func (x *ListCustomJobsRequest) GetPageToken() string

func (*ListCustomJobsRequest) GetParent

func (x *ListCustomJobsRequest) GetParent() string

func (*ListCustomJobsRequest) GetReadMask

func (x *ListCustomJobsRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListCustomJobsRequest) ProtoMessage

func (*ListCustomJobsRequest) ProtoMessage()

func (*ListCustomJobsRequest) ProtoReflect

func (x *ListCustomJobsRequest) ProtoReflect() protoreflect.Message

func (*ListCustomJobsRequest) Reset

func (x *ListCustomJobsRequest) Reset()

func (*ListCustomJobsRequest) String

func (x *ListCustomJobsRequest) String() string

type ListCustomJobsResponse

type ListCustomJobsResponse struct {

	// List of CustomJobs in the requested page.
	CustomJobs []*CustomJob `protobuf:"bytes,1,rep,name=custom_jobs,json=customJobs,proto3" json:"custom_jobs,omitempty"`
	// A token to retrieve the next page of results.
	// Pass to
	// [ListCustomJobsRequest.page_token][google.cloud.aiplatform.v1.ListCustomJobsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]

func (*ListCustomJobsResponse) Descriptor deprecated

func (*ListCustomJobsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListCustomJobsResponse.ProtoReflect.Descriptor instead.

func (*ListCustomJobsResponse) GetCustomJobs

func (x *ListCustomJobsResponse) GetCustomJobs() []*CustomJob

func (*ListCustomJobsResponse) GetNextPageToken

func (x *ListCustomJobsResponse) GetNextPageToken() string

func (*ListCustomJobsResponse) ProtoMessage

func (*ListCustomJobsResponse) ProtoMessage()

func (*ListCustomJobsResponse) ProtoReflect

func (x *ListCustomJobsResponse) ProtoReflect() protoreflect.Message

func (*ListCustomJobsResponse) Reset

func (x *ListCustomJobsResponse) Reset()

func (*ListCustomJobsResponse) String

func (x *ListCustomJobsResponse) String() string

type ListDataItemsRequest

type ListDataItemsRequest struct {

	// Required. The resource name of the Dataset to list DataItems from.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems].

func (*ListDataItemsRequest) Descriptor deprecated

func (*ListDataItemsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDataItemsRequest.ProtoReflect.Descriptor instead.

func (*ListDataItemsRequest) GetFilter

func (x *ListDataItemsRequest) GetFilter() string

func (*ListDataItemsRequest) GetOrderBy

func (x *ListDataItemsRequest) GetOrderBy() string

func (*ListDataItemsRequest) GetPageSize

func (x *ListDataItemsRequest) GetPageSize() int32

func (*ListDataItemsRequest) GetPageToken

func (x *ListDataItemsRequest) GetPageToken() string

func (*ListDataItemsRequest) GetParent

func (x *ListDataItemsRequest) GetParent() string

func (*ListDataItemsRequest) GetReadMask

func (x *ListDataItemsRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListDataItemsRequest) ProtoMessage

func (*ListDataItemsRequest) ProtoMessage()

func (*ListDataItemsRequest) ProtoReflect

func (x *ListDataItemsRequest) ProtoReflect() protoreflect.Message

func (*ListDataItemsRequest) Reset

func (x *ListDataItemsRequest) Reset()

func (*ListDataItemsRequest) String

func (x *ListDataItemsRequest) String() string

type ListDataItemsResponse

type ListDataItemsResponse struct {

	// A list of DataItems that matches the specified filter in the request.
	DataItems []*DataItem `protobuf:"bytes,1,rep,name=data_items,json=dataItems,proto3" json:"data_items,omitempty"`
	// The standard List next-page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems].

func (*ListDataItemsResponse) Descriptor deprecated

func (*ListDataItemsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDataItemsResponse.ProtoReflect.Descriptor instead.

func (*ListDataItemsResponse) GetDataItems

func (x *ListDataItemsResponse) GetDataItems() []*DataItem

func (*ListDataItemsResponse) GetNextPageToken

func (x *ListDataItemsResponse) GetNextPageToken() string

func (*ListDataItemsResponse) ProtoMessage

func (*ListDataItemsResponse) ProtoMessage()

func (*ListDataItemsResponse) ProtoReflect

func (x *ListDataItemsResponse) ProtoReflect() protoreflect.Message

func (*ListDataItemsResponse) Reset

func (x *ListDataItemsResponse) Reset()

func (*ListDataItemsResponse) String

func (x *ListDataItemsResponse) String() string

type ListDataLabelingJobsRequest

type ListDataLabelingJobsRequest struct {

	// Required. The parent of the DataLabelingJob.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	//
	// Supported fields:
	//
	//   - `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
	//   - `state` supports `=`, `!=` comparisons.
	//   - `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
	//     `create_time` must be in RFC 3339 format.
	//   - `labels` supports general map functions that is:
	//     `labels.key=value` - key:value equality
	//     `labels.key:* - key existence
	//
	// Some examples of using the filter are:
	//
	//   - `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
	//   - `state!="JOB_STATE_FAILED" OR display_name="my_job"`
	//   - `NOT display_name="my_job"`
	//   - `create_time>"2021-05-18T00:00:00Z"`
	//   - `labels.keyA=valueA`
	//   - `labels.keyB:*`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read. FieldMask represents a set of
	// symbolic field paths. For example, the mask can be `paths: "name"`. The
	// "name" here is a field in DataLabelingJob.
	// If this field is not set, all fields of the DataLabelingJob are returned.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order by
	// default.
	// Use `desc` after a field name for descending.
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs].

func (*ListDataLabelingJobsRequest) Descriptor deprecated

func (*ListDataLabelingJobsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDataLabelingJobsRequest.ProtoReflect.Descriptor instead.

func (*ListDataLabelingJobsRequest) GetFilter

func (x *ListDataLabelingJobsRequest) GetFilter() string

func (*ListDataLabelingJobsRequest) GetOrderBy

func (x *ListDataLabelingJobsRequest) GetOrderBy() string

func (*ListDataLabelingJobsRequest) GetPageSize

func (x *ListDataLabelingJobsRequest) GetPageSize() int32

func (*ListDataLabelingJobsRequest) GetPageToken

func (x *ListDataLabelingJobsRequest) GetPageToken() string

func (*ListDataLabelingJobsRequest) GetParent

func (x *ListDataLabelingJobsRequest) GetParent() string

func (*ListDataLabelingJobsRequest) GetReadMask

func (*ListDataLabelingJobsRequest) ProtoMessage

func (*ListDataLabelingJobsRequest) ProtoMessage()

func (*ListDataLabelingJobsRequest) ProtoReflect

func (*ListDataLabelingJobsRequest) Reset

func (x *ListDataLabelingJobsRequest) Reset()

func (*ListDataLabelingJobsRequest) String

func (x *ListDataLabelingJobsRequest) String() string

type ListDataLabelingJobsResponse

type ListDataLabelingJobsResponse struct {

	// A list of DataLabelingJobs that matches the specified filter in the
	// request.
	DataLabelingJobs []*DataLabelingJob `protobuf:"bytes,1,rep,name=data_labeling_jobs,json=dataLabelingJobs,proto3" json:"data_labeling_jobs,omitempty"`
	// The standard List next-page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs].

func (*ListDataLabelingJobsResponse) Descriptor deprecated

func (*ListDataLabelingJobsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDataLabelingJobsResponse.ProtoReflect.Descriptor instead.

func (*ListDataLabelingJobsResponse) GetDataLabelingJobs

func (x *ListDataLabelingJobsResponse) GetDataLabelingJobs() []*DataLabelingJob

func (*ListDataLabelingJobsResponse) GetNextPageToken

func (x *ListDataLabelingJobsResponse) GetNextPageToken() string

func (*ListDataLabelingJobsResponse) ProtoMessage

func (*ListDataLabelingJobsResponse) ProtoMessage()

func (*ListDataLabelingJobsResponse) ProtoReflect

func (*ListDataLabelingJobsResponse) Reset

func (x *ListDataLabelingJobsResponse) Reset()

func (*ListDataLabelingJobsResponse) String

type ListDatasetVersionsRequest added in v1.51.0

type ListDatasetVersionsRequest struct {

	// Required. The resource name of the Dataset to list DatasetVersions from.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The standard list filter.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The standard list page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// Optional. A comma-separated list of fields to order by, sorted in ascending
	// order. Use "desc" after a field name for descending.
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.ListDatasetVersions][google.cloud.aiplatform.v1.DatasetService.ListDatasetVersions].

func (*ListDatasetVersionsRequest) Descriptor deprecated added in v1.51.0

func (*ListDatasetVersionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDatasetVersionsRequest.ProtoReflect.Descriptor instead.

func (*ListDatasetVersionsRequest) GetFilter added in v1.51.0

func (x *ListDatasetVersionsRequest) GetFilter() string

func (*ListDatasetVersionsRequest) GetOrderBy added in v1.51.0

func (x *ListDatasetVersionsRequest) GetOrderBy() string

func (*ListDatasetVersionsRequest) GetPageSize added in v1.51.0

func (x *ListDatasetVersionsRequest) GetPageSize() int32

func (*ListDatasetVersionsRequest) GetPageToken added in v1.51.0

func (x *ListDatasetVersionsRequest) GetPageToken() string

func (*ListDatasetVersionsRequest) GetParent added in v1.51.0

func (x *ListDatasetVersionsRequest) GetParent() string

func (*ListDatasetVersionsRequest) GetReadMask added in v1.51.0

func (*ListDatasetVersionsRequest) ProtoMessage added in v1.51.0

func (*ListDatasetVersionsRequest) ProtoMessage()

func (*ListDatasetVersionsRequest) ProtoReflect added in v1.51.0

func (*ListDatasetVersionsRequest) Reset added in v1.51.0

func (x *ListDatasetVersionsRequest) Reset()

func (*ListDatasetVersionsRequest) String added in v1.51.0

func (x *ListDatasetVersionsRequest) String() string

type ListDatasetVersionsResponse added in v1.51.0

type ListDatasetVersionsResponse struct {

	// A list of DatasetVersions that matches the specified filter in the request.
	DatasetVersions []*DatasetVersion `protobuf:"bytes,1,rep,name=dataset_versions,json=datasetVersions,proto3" json:"dataset_versions,omitempty"`
	// The standard List next-page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [DatasetService.ListDatasetVersions][google.cloud.aiplatform.v1.DatasetService.ListDatasetVersions].

func (*ListDatasetVersionsResponse) Descriptor deprecated added in v1.51.0

func (*ListDatasetVersionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDatasetVersionsResponse.ProtoReflect.Descriptor instead.

func (*ListDatasetVersionsResponse) GetDatasetVersions added in v1.51.0

func (x *ListDatasetVersionsResponse) GetDatasetVersions() []*DatasetVersion

func (*ListDatasetVersionsResponse) GetNextPageToken added in v1.51.0

func (x *ListDatasetVersionsResponse) GetNextPageToken() string

func (*ListDatasetVersionsResponse) ProtoMessage added in v1.51.0

func (*ListDatasetVersionsResponse) ProtoMessage()

func (*ListDatasetVersionsResponse) ProtoReflect added in v1.51.0

func (*ListDatasetVersionsResponse) Reset added in v1.51.0

func (x *ListDatasetVersionsResponse) Reset()

func (*ListDatasetVersionsResponse) String added in v1.51.0

func (x *ListDatasetVersionsResponse) String() string

type ListDatasetsRequest

type ListDatasetsRequest struct {

	// Required. The name of the Dataset's parent resource.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// An expression for filtering the results of the request. For field names
	// both snake_case and camelCase are supported.
	//
	//   - `display_name`: supports = and !=
	//   - `metadata_schema_uri`: supports = and !=
	//   - `labels` supports general map functions that is:
	//   - `labels.key=value` - key:value equality
	//   - `labels.key:* or labels:key - key existence
	//   - A key including a space must be quoted. `labels."a key"`.
	//
	// Some examples:
	//
	//   - `displayName="myDisplayName"`
	//   - `labels.myKey="myValue"`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	// Supported fields:
	//
	//   - `display_name`
	//   - `create_time`
	//   - `update_time`
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.ListDatasets][google.cloud.aiplatform.v1.DatasetService.ListDatasets].

func (*ListDatasetsRequest) Descriptor deprecated

func (*ListDatasetsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDatasetsRequest.ProtoReflect.Descriptor instead.

func (*ListDatasetsRequest) GetFilter

func (x *ListDatasetsRequest) GetFilter() string

func (*ListDatasetsRequest) GetOrderBy

func (x *ListDatasetsRequest) GetOrderBy() string

func (*ListDatasetsRequest) GetPageSize

func (x *ListDatasetsRequest) GetPageSize() int32

func (*ListDatasetsRequest) GetPageToken

func (x *ListDatasetsRequest) GetPageToken() string

func (*ListDatasetsRequest) GetParent

func (x *ListDatasetsRequest) GetParent() string

func (*ListDatasetsRequest) GetReadMask

func (x *ListDatasetsRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListDatasetsRequest) ProtoMessage

func (*ListDatasetsRequest) ProtoMessage()

func (*ListDatasetsRequest) ProtoReflect

func (x *ListDatasetsRequest) ProtoReflect() protoreflect.Message

func (*ListDatasetsRequest) Reset

func (x *ListDatasetsRequest) Reset()

func (*ListDatasetsRequest) String

func (x *ListDatasetsRequest) String() string

type ListDatasetsResponse

type ListDatasetsResponse struct {

	// A list of Datasets that matches the specified filter in the request.
	Datasets []*Dataset `protobuf:"bytes,1,rep,name=datasets,proto3" json:"datasets,omitempty"`
	// The standard List next-page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [DatasetService.ListDatasets][google.cloud.aiplatform.v1.DatasetService.ListDatasets].

func (*ListDatasetsResponse) Descriptor deprecated

func (*ListDatasetsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDatasetsResponse.ProtoReflect.Descriptor instead.

func (*ListDatasetsResponse) GetDatasets

func (x *ListDatasetsResponse) GetDatasets() []*Dataset

func (*ListDatasetsResponse) GetNextPageToken

func (x *ListDatasetsResponse) GetNextPageToken() string

func (*ListDatasetsResponse) ProtoMessage

func (*ListDatasetsResponse) ProtoMessage()

func (*ListDatasetsResponse) ProtoReflect

func (x *ListDatasetsResponse) ProtoReflect() protoreflect.Message

func (*ListDatasetsResponse) Reset

func (x *ListDatasetsResponse) Reset()

func (*ListDatasetsResponse) String

func (x *ListDatasetsResponse) String() string

type ListDeploymentResourcePoolsRequest added in v1.57.0

type ListDeploymentResourcePoolsRequest struct {

	// Required. The parent Location which owns this collection of
	// DeploymentResourcePools. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of DeploymentResourcePools to return. The service may
	// return fewer than this value.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListDeploymentResourcePools` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// `ListDeploymentResourcePools` must match the call that provided the page
	// token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for ListDeploymentResourcePools method.

func (*ListDeploymentResourcePoolsRequest) Descriptor deprecated added in v1.57.0

func (*ListDeploymentResourcePoolsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDeploymentResourcePoolsRequest.ProtoReflect.Descriptor instead.

func (*ListDeploymentResourcePoolsRequest) GetPageSize added in v1.57.0

func (x *ListDeploymentResourcePoolsRequest) GetPageSize() int32

func (*ListDeploymentResourcePoolsRequest) GetPageToken added in v1.57.0

func (x *ListDeploymentResourcePoolsRequest) GetPageToken() string

func (*ListDeploymentResourcePoolsRequest) GetParent added in v1.57.0

func (*ListDeploymentResourcePoolsRequest) ProtoMessage added in v1.57.0

func (*ListDeploymentResourcePoolsRequest) ProtoMessage()

func (*ListDeploymentResourcePoolsRequest) ProtoReflect added in v1.57.0

func (*ListDeploymentResourcePoolsRequest) Reset added in v1.57.0

func (*ListDeploymentResourcePoolsRequest) String added in v1.57.0

type ListDeploymentResourcePoolsResponse added in v1.57.0

type ListDeploymentResourcePoolsResponse struct {

	// The DeploymentResourcePools from the specified location.
	DeploymentResourcePools []*DeploymentResourcePool `` /* 132-byte string literal not displayed */
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for ListDeploymentResourcePools method.

func (*ListDeploymentResourcePoolsResponse) Descriptor deprecated added in v1.57.0

func (*ListDeploymentResourcePoolsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDeploymentResourcePoolsResponse.ProtoReflect.Descriptor instead.

func (*ListDeploymentResourcePoolsResponse) GetDeploymentResourcePools added in v1.57.0

func (x *ListDeploymentResourcePoolsResponse) GetDeploymentResourcePools() []*DeploymentResourcePool

func (*ListDeploymentResourcePoolsResponse) GetNextPageToken added in v1.57.0

func (x *ListDeploymentResourcePoolsResponse) GetNextPageToken() string

func (*ListDeploymentResourcePoolsResponse) ProtoMessage added in v1.57.0

func (*ListDeploymentResourcePoolsResponse) ProtoMessage()

func (*ListDeploymentResourcePoolsResponse) ProtoReflect added in v1.57.0

func (*ListDeploymentResourcePoolsResponse) Reset added in v1.57.0

func (*ListDeploymentResourcePoolsResponse) String added in v1.57.0

type ListEndpointsRequest

type ListEndpointsRequest struct {

	// Required. The resource name of the Location from which to list the
	// Endpoints. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. An expression for filtering the results of the request. For field
	// names both snake_case and camelCase are supported.
	//
	//   - `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint
	//     ID, i.e. the last segment of the Endpoint's
	//     [resource name][google.cloud.aiplatform.v1.Endpoint.name].
	//   - `display_name` supports `=` and `!=`.
	//   - `labels` supports general map functions that is:
	//   - `labels.key=value` - key:value equality
	//   - `labels.key:*` or `labels:key` - key existence
	//   - A key including a space must be quoted. `labels."a key"`.
	//   - `base_model_name` only supports `=`.
	//
	// Some examples:
	//
	//   - `endpoint=1`
	//   - `displayName="myDisplayName"`
	//   - `labels.myKey="myValue"`
	//   - `baseModelName="text-bison"`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The standard list page token.
	// Typically obtained via
	// [ListEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token]
	// of the previous
	// [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	// Supported fields:
	//
	//   - `display_name`
	//   - `create_time`
	//   - `update_time`
	//
	// Example: `display_name, create_time desc`.
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints].

func (*ListEndpointsRequest) Descriptor deprecated

func (*ListEndpointsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListEndpointsRequest.ProtoReflect.Descriptor instead.

func (*ListEndpointsRequest) GetFilter

func (x *ListEndpointsRequest) GetFilter() string

func (*ListEndpointsRequest) GetOrderBy

func (x *ListEndpointsRequest) GetOrderBy() string

func (*ListEndpointsRequest) GetPageSize

func (x *ListEndpointsRequest) GetPageSize() int32

func (*ListEndpointsRequest) GetPageToken

func (x *ListEndpointsRequest) GetPageToken() string

func (*ListEndpointsRequest) GetParent

func (x *ListEndpointsRequest) GetParent() string

func (*ListEndpointsRequest) GetReadMask

func (x *ListEndpointsRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListEndpointsRequest) ProtoMessage

func (*ListEndpointsRequest) ProtoMessage()

func (*ListEndpointsRequest) ProtoReflect

func (x *ListEndpointsRequest) ProtoReflect() protoreflect.Message

func (*ListEndpointsRequest) Reset

func (x *ListEndpointsRequest) Reset()

func (*ListEndpointsRequest) String

func (x *ListEndpointsRequest) String() string

type ListEndpointsResponse

type ListEndpointsResponse struct {

	// List of Endpoints in the requested page.
	Endpoints []*Endpoint `protobuf:"bytes,1,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
	// A token to retrieve the next page of results.
	// Pass to
	// [ListEndpointsRequest.page_token][google.cloud.aiplatform.v1.ListEndpointsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints].

func (*ListEndpointsResponse) Descriptor deprecated

func (*ListEndpointsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListEndpointsResponse.ProtoReflect.Descriptor instead.

func (*ListEndpointsResponse) GetEndpoints

func (x *ListEndpointsResponse) GetEndpoints() []*Endpoint

func (*ListEndpointsResponse) GetNextPageToken

func (x *ListEndpointsResponse) GetNextPageToken() string

func (*ListEndpointsResponse) ProtoMessage

func (*ListEndpointsResponse) ProtoMessage()

func (*ListEndpointsResponse) ProtoReflect

func (x *ListEndpointsResponse) ProtoReflect() protoreflect.Message

func (*ListEndpointsResponse) Reset

func (x *ListEndpointsResponse) Reset()

func (*ListEndpointsResponse) String

func (x *ListEndpointsResponse) String() string

type ListEntityTypesRequest

type ListEntityTypesRequest struct {

	// Required. The resource name of the Featurestore to list EntityTypes.
	// Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the EntityTypes that match the filter expression. The following
	// filters are supported:
	//
	// * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
	// Values must be in RFC 3339 format.
	// * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
	// Values must be in RFC 3339 format.
	// * `labels`: Supports key-value equality as well as key presence.
	//
	// Examples:
	//
	//   - `create_time > \"2020-01-31T15:30:00.000000Z\" OR
	//     update_time > \"2020-01-31T15:30:00.000000Z\"` --> EntityTypes created
	//     or updated after 2020-01-31T15:30:00.000000Z.
	//   - `labels.active = yes AND labels.env = prod` --> EntityTypes having both
	//     (active: yes) and (env: prod) labels.
	//   - `labels.env: *` --> Any EntityType which has a label with 'env' as the
	//     key.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of EntityTypes to return. The service may return fewer
	// than this value. If unspecified, at most 1000 EntityTypes will be returned.
	// The maximum value is 1000; any value greater than 1000 will be coerced to
	// 1000.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	//
	// Supported fields:
	//
	//   - `entity_type_id`
	//   - `create_time`
	//   - `update_time`
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes].

func (*ListEntityTypesRequest) Descriptor deprecated

func (*ListEntityTypesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListEntityTypesRequest.ProtoReflect.Descriptor instead.

func (*ListEntityTypesRequest) GetFilter

func (x *ListEntityTypesRequest) GetFilter() string

func (*ListEntityTypesRequest) GetOrderBy

func (x *ListEntityTypesRequest) GetOrderBy() string

func (*ListEntityTypesRequest) GetPageSize

func (x *ListEntityTypesRequest) GetPageSize() int32

func (*ListEntityTypesRequest) GetPageToken

func (x *ListEntityTypesRequest) GetPageToken() string

func (*ListEntityTypesRequest) GetParent

func (x *ListEntityTypesRequest) GetParent() string

func (*ListEntityTypesRequest) GetReadMask

func (x *ListEntityTypesRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListEntityTypesRequest) ProtoMessage

func (*ListEntityTypesRequest) ProtoMessage()

func (*ListEntityTypesRequest) ProtoReflect

func (x *ListEntityTypesRequest) ProtoReflect() protoreflect.Message

func (*ListEntityTypesRequest) Reset

func (x *ListEntityTypesRequest) Reset()

func (*ListEntityTypesRequest) String

func (x *ListEntityTypesRequest) String() string

type ListEntityTypesResponse

type ListEntityTypesResponse struct {

	// The EntityTypes matching the request.
	EntityTypes []*EntityType `protobuf:"bytes,1,rep,name=entity_types,json=entityTypes,proto3" json:"entity_types,omitempty"`
	// A token, which can be sent as
	// [ListEntityTypesRequest.page_token][google.cloud.aiplatform.v1.ListEntityTypesRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes].

func (*ListEntityTypesResponse) Descriptor deprecated

func (*ListEntityTypesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListEntityTypesResponse.ProtoReflect.Descriptor instead.

func (*ListEntityTypesResponse) GetEntityTypes

func (x *ListEntityTypesResponse) GetEntityTypes() []*EntityType

func (*ListEntityTypesResponse) GetNextPageToken

func (x *ListEntityTypesResponse) GetNextPageToken() string

func (*ListEntityTypesResponse) ProtoMessage

func (*ListEntityTypesResponse) ProtoMessage()

func (*ListEntityTypesResponse) ProtoReflect

func (x *ListEntityTypesResponse) ProtoReflect() protoreflect.Message

func (*ListEntityTypesResponse) Reset

func (x *ListEntityTypesResponse) Reset()

func (*ListEntityTypesResponse) String

func (x *ListEntityTypesResponse) String() string

type ListExecutionsRequest

type ListExecutionsRequest struct {

	// Required. The MetadataStore whose Executions should be listed.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of Executions to return. The service may return fewer.
	// Must be in range 1-1000, inclusive. Defaults to 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other provided parameters must match the call that
	// provided the page token. (Otherwise the request will fail with an
	// INVALID_ARGUMENT error.)
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter specifying the boolean condition for the Executions to satisfy in
	// order to be part of the result set.
	// The syntax to define filter query is based on https://google.aip.dev/160.
	// Following are the supported set of filters:
	//
	//   - **Attribute filtering**:
	//     For example: `display_name = "test"`.
	//     Supported fields include: `name`, `display_name`, `state`,
	//     `schema_title`, `create_time`, and `update_time`.
	//     Time fields, such as `create_time` and `update_time`, require values
	//     specified in RFC-3339 format.
	//     For example: `create_time = "2020-11-19T11:30:00-04:00"`.
	//   - **Metadata field**:
	//     To filter on metadata fields use traversal operation as follows:
	//     `metadata.<field_name>.<type_value>`
	//     For example: `metadata.field_1.number_value = 10.0`
	//     In case the field name contains special characters (such as colon), one
	//     can embed it inside double quote.
	//     For example: `metadata."field:1".number_value = 10.0`
	//   - **Context based filtering**:
	//     To filter Executions based on the contexts to which they belong use
	//     the function operator with the full resource name:
	//     `in_context(<context-name>)`.
	//     For example:
	//     `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`
	//
	// Each of the above supported filters can be combined together using
	// logical operators (`AND` & `OR`). Maximum nested expression depth allowed
	// is 5.
	//
	// For example: `display_name = "test" AND metadata.field1.bool_value = true`.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// How the list of messages is ordered. Specify the values to order by and an
	// ordering operation. The default sorting order is ascending. To specify
	// descending order for a field, users append a " desc" suffix; for example:
	// "foo desc, bar".
	// Subfields are specified with a `.` character, such as foo.bar.
	// see https://google.aip.dev/132#ordering for more details.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions].

func (*ListExecutionsRequest) Descriptor deprecated

func (*ListExecutionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListExecutionsRequest.ProtoReflect.Descriptor instead.

func (*ListExecutionsRequest) GetFilter

func (x *ListExecutionsRequest) GetFilter() string

func (*ListExecutionsRequest) GetOrderBy

func (x *ListExecutionsRequest) GetOrderBy() string

func (*ListExecutionsRequest) GetPageSize

func (x *ListExecutionsRequest) GetPageSize() int32

func (*ListExecutionsRequest) GetPageToken

func (x *ListExecutionsRequest) GetPageToken() string

func (*ListExecutionsRequest) GetParent

func (x *ListExecutionsRequest) GetParent() string

func (*ListExecutionsRequest) ProtoMessage

func (*ListExecutionsRequest) ProtoMessage()

func (*ListExecutionsRequest) ProtoReflect

func (x *ListExecutionsRequest) ProtoReflect() protoreflect.Message

func (*ListExecutionsRequest) Reset

func (x *ListExecutionsRequest) Reset()

func (*ListExecutionsRequest) String

func (x *ListExecutionsRequest) String() string

type ListExecutionsResponse

type ListExecutionsResponse struct {

	// The Executions retrieved from the MetadataStore.
	Executions []*Execution `protobuf:"bytes,1,rep,name=executions,proto3" json:"executions,omitempty"`
	// A token, which can be sent as
	// [ListExecutionsRequest.page_token][google.cloud.aiplatform.v1.ListExecutionsRequest.page_token]
	// to retrieve the next page.
	// If this field is not populated, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions].

func (*ListExecutionsResponse) Descriptor deprecated

func (*ListExecutionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListExecutionsResponse.ProtoReflect.Descriptor instead.

func (*ListExecutionsResponse) GetExecutions

func (x *ListExecutionsResponse) GetExecutions() []*Execution

func (*ListExecutionsResponse) GetNextPageToken

func (x *ListExecutionsResponse) GetNextPageToken() string

func (*ListExecutionsResponse) ProtoMessage

func (*ListExecutionsResponse) ProtoMessage()

func (*ListExecutionsResponse) ProtoReflect

func (x *ListExecutionsResponse) ProtoReflect() protoreflect.Message

func (*ListExecutionsResponse) Reset

func (x *ListExecutionsResponse) Reset()

func (*ListExecutionsResponse) String

func (x *ListExecutionsResponse) String() string

type ListFeatureGroupsRequest added in v1.54.0

type ListFeatureGroupsRequest struct {

	// Required. The resource name of the Location to list FeatureGroups.
	// Format:
	// `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the FeatureGroups that match the filter expression. The
	// following fields are supported:
	//
	// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
	// Values must be
	//
	//	in RFC 3339 format.
	//
	// * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
	// Values must be
	//
	//	in RFC 3339 format.
	//
	// * `labels`: Supports key-value equality and key presence.
	//
	// Examples:
	//
	//   - `create_time > "2020-01-01" OR update_time > "2020-01-01"`
	//     FeatureGroups created or updated after 2020-01-01.
	//   - `labels.env = "prod"`
	//     FeatureGroups with label "env" set to "prod".
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of FeatureGroups to return. The service may return
	// fewer than this value. If unspecified, at most 100 FeatureGroups will
	// be returned. The maximum value is 100; any value greater than 100 will be
	// coerced to 100.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [FeatureGroupAdminService.ListFeatureGroups][] call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [FeatureGroupAdminService.ListFeatureGroups][] must
	// match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	// Supported Fields:
	//
	//   - `create_time`
	//   - `update_time`
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureRegistryService.ListFeatureGroups][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatureGroups].

func (*ListFeatureGroupsRequest) Descriptor deprecated added in v1.54.0

func (*ListFeatureGroupsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListFeatureGroupsRequest.ProtoReflect.Descriptor instead.

func (*ListFeatureGroupsRequest) GetFilter added in v1.54.0

func (x *ListFeatureGroupsRequest) GetFilter() string

func (*ListFeatureGroupsRequest) GetOrderBy added in v1.54.0

func (x *ListFeatureGroupsRequest) GetOrderBy() string

func (*ListFeatureGroupsRequest) GetPageSize added in v1.54.0

func (x *ListFeatureGroupsRequest) GetPageSize() int32

func (*ListFeatureGroupsRequest) GetPageToken added in v1.54.0

func (x *ListFeatureGroupsRequest) GetPageToken() string

func (*ListFeatureGroupsRequest) GetParent added in v1.54.0

func (x *ListFeatureGroupsRequest) GetParent() string

func (*ListFeatureGroupsRequest) ProtoMessage added in v1.54.0

func (*ListFeatureGroupsRequest) ProtoMessage()

func (*ListFeatureGroupsRequest) ProtoReflect added in v1.54.0

func (x *ListFeatureGroupsRequest) ProtoReflect() protoreflect.Message

func (*ListFeatureGroupsRequest) Reset added in v1.54.0

func (x *ListFeatureGroupsRequest) Reset()

func (*ListFeatureGroupsRequest) String added in v1.54.0

func (x *ListFeatureGroupsRequest) String() string

type ListFeatureGroupsResponse added in v1.54.0

type ListFeatureGroupsResponse struct {

	// The FeatureGroups matching the request.
	FeatureGroups []*FeatureGroup `protobuf:"bytes,1,rep,name=feature_groups,json=featureGroups,proto3" json:"feature_groups,omitempty"`
	// A token, which can be sent as
	// [ListFeatureGroupsRequest.page_token][google.cloud.aiplatform.v1.ListFeatureGroupsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [FeatureRegistryService.ListFeatureGroups][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatureGroups].

func (*ListFeatureGroupsResponse) Descriptor deprecated added in v1.54.0

func (*ListFeatureGroupsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListFeatureGroupsResponse.ProtoReflect.Descriptor instead.

func (*ListFeatureGroupsResponse) GetFeatureGroups added in v1.54.0

func (x *ListFeatureGroupsResponse) GetFeatureGroups() []*FeatureGroup

func (*ListFeatureGroupsResponse) GetNextPageToken added in v1.54.0

func (x *ListFeatureGroupsResponse) GetNextPageToken() string

func (*ListFeatureGroupsResponse) ProtoMessage added in v1.54.0

func (*ListFeatureGroupsResponse) ProtoMessage()

func (*ListFeatureGroupsResponse) ProtoReflect added in v1.54.0

func (*ListFeatureGroupsResponse) Reset added in v1.54.0

func (x *ListFeatureGroupsResponse) Reset()

func (*ListFeatureGroupsResponse) String added in v1.54.0

func (x *ListFeatureGroupsResponse) String() string

type ListFeatureOnlineStoresRequest added in v1.54.0

type ListFeatureOnlineStoresRequest struct {

	// Required. The resource name of the Location to list FeatureOnlineStores.
	// Format:
	// `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the FeatureOnlineStores that match the filter expression. The
	// following fields are supported:
	//
	// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
	// Values must be
	//
	//	in RFC 3339 format.
	//
	// * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
	// Values must be
	//
	//	in RFC 3339 format.
	//
	// * `labels`: Supports key-value equality and key presence.
	//
	// Examples:
	//
	//   - `create_time > "2020-01-01" OR update_time > "2020-01-01"`
	//     FeatureOnlineStores created or updated after 2020-01-01.
	//   - `labels.env = "prod"`
	//     FeatureOnlineStores with label "env" set to "prod".
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of FeatureOnlineStores to return. The service may return
	// fewer than this value. If unspecified, at most 100 FeatureOnlineStores will
	// be returned. The maximum value is 100; any value greater than 100 will be
	// coerced to 100.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [FeatureOnlineStoreAdminService.ListFeatureOnlineStores][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureOnlineStores]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [FeatureOnlineStoreAdminService.ListFeatureOnlineStores][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureOnlineStores]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	// Supported Fields:
	//
	//   - `create_time`
	//   - `update_time`
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.ListFeatureOnlineStores][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureOnlineStores].

func (*ListFeatureOnlineStoresRequest) Descriptor deprecated added in v1.54.0

func (*ListFeatureOnlineStoresRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListFeatureOnlineStoresRequest.ProtoReflect.Descriptor instead.

func (*ListFeatureOnlineStoresRequest) GetFilter added in v1.54.0

func (x *ListFeatureOnlineStoresRequest) GetFilter() string

func (*ListFeatureOnlineStoresRequest) GetOrderBy added in v1.54.0

func (x *ListFeatureOnlineStoresRequest) GetOrderBy() string

func (*ListFeatureOnlineStoresRequest) GetPageSize added in v1.54.0

func (x *ListFeatureOnlineStoresRequest) GetPageSize() int32

func (*ListFeatureOnlineStoresRequest) GetPageToken added in v1.54.0

func (x *ListFeatureOnlineStoresRequest) GetPageToken() string

func (*ListFeatureOnlineStoresRequest) GetParent added in v1.54.0

func (x *ListFeatureOnlineStoresRequest) GetParent() string

func (*ListFeatureOnlineStoresRequest) ProtoMessage added in v1.54.0

func (*ListFeatureOnlineStoresRequest) ProtoMessage()

func (*ListFeatureOnlineStoresRequest) ProtoReflect added in v1.54.0

func (*ListFeatureOnlineStoresRequest) Reset added in v1.54.0

func (x *ListFeatureOnlineStoresRequest) Reset()

func (*ListFeatureOnlineStoresRequest) String added in v1.54.0

type ListFeatureOnlineStoresResponse added in v1.54.0

type ListFeatureOnlineStoresResponse struct {

	// The FeatureOnlineStores matching the request.
	FeatureOnlineStores []*FeatureOnlineStore `protobuf:"bytes,1,rep,name=feature_online_stores,json=featureOnlineStores,proto3" json:"feature_online_stores,omitempty"`
	// A token, which can be sent as
	// [ListFeatureOnlineStoresRequest.page_token][google.cloud.aiplatform.v1.ListFeatureOnlineStoresRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [FeatureOnlineStoreAdminService.ListFeatureOnlineStores][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureOnlineStores].

func (*ListFeatureOnlineStoresResponse) Descriptor deprecated added in v1.54.0

func (*ListFeatureOnlineStoresResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListFeatureOnlineStoresResponse.ProtoReflect.Descriptor instead.

func (*ListFeatureOnlineStoresResponse) GetFeatureOnlineStores added in v1.54.0

func (x *ListFeatureOnlineStoresResponse) GetFeatureOnlineStores() []*FeatureOnlineStore

func (*ListFeatureOnlineStoresResponse) GetNextPageToken added in v1.54.0

func (x *ListFeatureOnlineStoresResponse) GetNextPageToken() string

func (*ListFeatureOnlineStoresResponse) ProtoMessage added in v1.54.0

func (*ListFeatureOnlineStoresResponse) ProtoMessage()

func (*ListFeatureOnlineStoresResponse) ProtoReflect added in v1.54.0

func (*ListFeatureOnlineStoresResponse) Reset added in v1.54.0

func (*ListFeatureOnlineStoresResponse) String added in v1.54.0

type ListFeatureViewSyncsRequest added in v1.54.0

type ListFeatureViewSyncsRequest struct {

	// Required. The resource name of the FeatureView to list FeatureViewSyncs.
	// Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the FeatureViewSyncs that match the filter expression. The following
	// filters are supported:
	//
	// * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
	// Values must be in RFC 3339 format.
	//
	// Examples:
	//
	//   - `create_time > \"2020-01-31T15:30:00.000000Z\"` --> FeatureViewSyncs
	//     created after 2020-01-31T15:30:00.000000Z.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of FeatureViewSyncs to return. The service may return
	// fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will
	// be returned. The maximum value is 1000; any value greater than 1000 will be
	// coerced to 1000.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [FeatureOnlineStoreAdminService.ListFeatureViewSyncs][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViewSyncs]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [FeatureOnlineStoreAdminService.ListFeatureViewSyncs][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViewSyncs]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	//
	// Supported fields:
	//
	//   - `create_time`
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.ListFeatureViewSyncs][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViewSyncs].

func (*ListFeatureViewSyncsRequest) Descriptor deprecated added in v1.54.0

func (*ListFeatureViewSyncsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListFeatureViewSyncsRequest.ProtoReflect.Descriptor instead.

func (*ListFeatureViewSyncsRequest) GetFilter added in v1.54.0

func (x *ListFeatureViewSyncsRequest) GetFilter() string

func (*ListFeatureViewSyncsRequest) GetOrderBy added in v1.54.0

func (x *ListFeatureViewSyncsRequest) GetOrderBy() string

func (*ListFeatureViewSyncsRequest) GetPageSize added in v1.54.0

func (x *ListFeatureViewSyncsRequest) GetPageSize() int32

func (*ListFeatureViewSyncsRequest) GetPageToken added in v1.54.0

func (x *ListFeatureViewSyncsRequest) GetPageToken() string

func (*ListFeatureViewSyncsRequest) GetParent added in v1.54.0

func (x *ListFeatureViewSyncsRequest) GetParent() string

func (*ListFeatureViewSyncsRequest) ProtoMessage added in v1.54.0

func (*ListFeatureViewSyncsRequest) ProtoMessage()

func (*ListFeatureViewSyncsRequest) ProtoReflect added in v1.54.0

func (*ListFeatureViewSyncsRequest) Reset added in v1.54.0

func (x *ListFeatureViewSyncsRequest) Reset()

func (*ListFeatureViewSyncsRequest) String added in v1.54.0

func (x *ListFeatureViewSyncsRequest) String() string

type ListFeatureViewSyncsResponse added in v1.54.0

type ListFeatureViewSyncsResponse struct {

	// The FeatureViewSyncs matching the request.
	FeatureViewSyncs []*FeatureViewSync `protobuf:"bytes,1,rep,name=feature_view_syncs,json=featureViewSyncs,proto3" json:"feature_view_syncs,omitempty"`
	// A token, which can be sent as
	// [ListFeatureViewSyncsRequest.page_token][google.cloud.aiplatform.v1.ListFeatureViewSyncsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [FeatureOnlineStoreAdminService.ListFeatureViewSyncs][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViewSyncs].

func (*ListFeatureViewSyncsResponse) Descriptor deprecated added in v1.54.0

func (*ListFeatureViewSyncsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListFeatureViewSyncsResponse.ProtoReflect.Descriptor instead.

func (*ListFeatureViewSyncsResponse) GetFeatureViewSyncs added in v1.54.0

func (x *ListFeatureViewSyncsResponse) GetFeatureViewSyncs() []*FeatureViewSync

func (*ListFeatureViewSyncsResponse) GetNextPageToken added in v1.54.0

func (x *ListFeatureViewSyncsResponse) GetNextPageToken() string

func (*ListFeatureViewSyncsResponse) ProtoMessage added in v1.54.0

func (*ListFeatureViewSyncsResponse) ProtoMessage()

func (*ListFeatureViewSyncsResponse) ProtoReflect added in v1.54.0

func (*ListFeatureViewSyncsResponse) Reset added in v1.54.0

func (x *ListFeatureViewSyncsResponse) Reset()

func (*ListFeatureViewSyncsResponse) String added in v1.54.0

type ListFeatureViewsRequest added in v1.54.0

type ListFeatureViewsRequest struct {

	// Required. The resource name of the FeatureOnlineStore to list FeatureViews.
	// Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the FeatureViews that match the filter expression. The following
	// filters are supported:
	//
	// * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
	// Values must be in RFC 3339 format.
	// * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
	// Values must be in RFC 3339 format.
	// * `labels`: Supports key-value equality as well as key presence.
	//
	// Examples:
	//
	//   - `create_time > \"2020-01-31T15:30:00.000000Z\" OR
	//     update_time > \"2020-01-31T15:30:00.000000Z\"` --> FeatureViews
	//     created or updated after 2020-01-31T15:30:00.000000Z.
	//   - `labels.active = yes AND labels.env = prod` --> FeatureViews having both
	//     (active: yes) and (env: prod) labels.
	//   - `labels.env: *` --> Any FeatureView which has a label with 'env' as the
	//     key.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of FeatureViews to return. The service may return fewer
	// than this value. If unspecified, at most 1000 FeatureViews will be
	// returned. The maximum value is 1000; any value greater than 1000 will be
	// coerced to 1000.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [FeatureOnlineStoreAdminService.ListFeatureViews][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViews]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [FeatureOnlineStoreAdminService.ListFeatureViews][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViews]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	//
	// Supported fields:
	//
	//   - `feature_view_id`
	//   - `create_time`
	//   - `update_time`
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.ListFeatureViews][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViews].

func (*ListFeatureViewsRequest) Descriptor deprecated added in v1.54.0

func (*ListFeatureViewsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListFeatureViewsRequest.ProtoReflect.Descriptor instead.

func (*ListFeatureViewsRequest) GetFilter added in v1.54.0

func (x *ListFeatureViewsRequest) GetFilter() string

func (*ListFeatureViewsRequest) GetOrderBy added in v1.54.0

func (x *ListFeatureViewsRequest) GetOrderBy() string

func (*ListFeatureViewsRequest) GetPageSize added in v1.54.0

func (x *ListFeatureViewsRequest) GetPageSize() int32

func (*ListFeatureViewsRequest) GetPageToken added in v1.54.0

func (x *ListFeatureViewsRequest) GetPageToken() string

func (*ListFeatureViewsRequest) GetParent added in v1.54.0

func (x *ListFeatureViewsRequest) GetParent() string

func (*ListFeatureViewsRequest) ProtoMessage added in v1.54.0

func (*ListFeatureViewsRequest) ProtoMessage()

func (*ListFeatureViewsRequest) ProtoReflect added in v1.54.0

func (x *ListFeatureViewsRequest) ProtoReflect() protoreflect.Message

func (*ListFeatureViewsRequest) Reset added in v1.54.0

func (x *ListFeatureViewsRequest) Reset()

func (*ListFeatureViewsRequest) String added in v1.54.0

func (x *ListFeatureViewsRequest) String() string

type ListFeatureViewsResponse added in v1.54.0

type ListFeatureViewsResponse struct {

	// The FeatureViews matching the request.
	FeatureViews []*FeatureView `protobuf:"bytes,1,rep,name=feature_views,json=featureViews,proto3" json:"feature_views,omitempty"`
	// A token, which can be sent as
	// [ListFeatureViewsRequest.page_token][google.cloud.aiplatform.v1.ListFeatureViewsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [FeatureOnlineStoreAdminService.ListFeatureViews][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViews].

func (*ListFeatureViewsResponse) Descriptor deprecated added in v1.54.0

func (*ListFeatureViewsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListFeatureViewsResponse.ProtoReflect.Descriptor instead.

func (*ListFeatureViewsResponse) GetFeatureViews added in v1.54.0

func (x *ListFeatureViewsResponse) GetFeatureViews() []*FeatureView

func (*ListFeatureViewsResponse) GetNextPageToken added in v1.54.0

func (x *ListFeatureViewsResponse) GetNextPageToken() string

func (*ListFeatureViewsResponse) ProtoMessage added in v1.54.0

func (*ListFeatureViewsResponse) ProtoMessage()

func (*ListFeatureViewsResponse) ProtoReflect added in v1.54.0

func (x *ListFeatureViewsResponse) ProtoReflect() protoreflect.Message

func (*ListFeatureViewsResponse) Reset added in v1.54.0

func (x *ListFeatureViewsResponse) Reset()

func (*ListFeatureViewsResponse) String added in v1.54.0

func (x *ListFeatureViewsResponse) String() string

type ListFeaturesRequest

type ListFeaturesRequest struct {

	// Required. The resource name of the Location to list Features.
	// Format for entity_type as parent:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
	// Format for feature_group as parent:
	// `projects/{project}/locations/{location}/featureGroups/{feature_group}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the Features that match the filter expression. The following
	// filters are supported:
	//
	// * `value_type`: Supports = and != comparisons.
	// * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must
	// be in RFC 3339 format.
	// * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must
	// be in RFC 3339 format.
	// * `labels`: Supports key-value equality as well as key presence.
	//
	// Examples:
	//
	//   - `value_type = DOUBLE` --> Features whose type is DOUBLE.
	//   - `create_time > \"2020-01-31T15:30:00.000000Z\" OR
	//     update_time > \"2020-01-31T15:30:00.000000Z\"` --> EntityTypes created
	//     or updated after 2020-01-31T15:30:00.000000Z.
	//   - `labels.active = yes AND labels.env = prod` --> Features having both
	//     (active: yes) and (env: prod) labels.
	//   - `labels.env: *` --> Any Feature which has a label with 'env' as the
	//     key.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of Features to return. The service may return fewer
	// than this value. If unspecified, at most 1000 Features will be returned.
	// The maximum value is 1000; any value greater than 1000 will be coerced to
	// 1000.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
	// call or
	// [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
	// or
	// [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	// Supported fields:
	//
	//   - `feature_id`
	//   - `value_type` (Not supported for FeatureRegistry Feature)
	//   - `create_time`
	//   - `update_time`
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// Only applicable for Vertex AI Feature Store (Legacy).
	// If set, return the most recent
	// [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count]
	// of stats for each Feature in response. Valid value is [0, 10]. If number of
	// stats exists <
	// [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count],
	// return all existing stats.
	LatestStatsCount int32 `protobuf:"varint,7,opt,name=latest_stats_count,json=latestStatsCount,proto3" json:"latest_stats_count,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]. Request message for [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures].

func (*ListFeaturesRequest) Descriptor deprecated

func (*ListFeaturesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListFeaturesRequest.ProtoReflect.Descriptor instead.

func (*ListFeaturesRequest) GetFilter

func (x *ListFeaturesRequest) GetFilter() string

func (*ListFeaturesRequest) GetLatestStatsCount

func (x *ListFeaturesRequest) GetLatestStatsCount() int32

func (*ListFeaturesRequest) GetOrderBy

func (x *ListFeaturesRequest) GetOrderBy() string

func (*ListFeaturesRequest) GetPageSize

func (x *ListFeaturesRequest) GetPageSize() int32

func (*ListFeaturesRequest) GetPageToken

func (x *ListFeaturesRequest) GetPageToken() string

func (*ListFeaturesRequest) GetParent

func (x *ListFeaturesRequest) GetParent() string

func (*ListFeaturesRequest) GetReadMask

func (x *ListFeaturesRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListFeaturesRequest) ProtoMessage

func (*ListFeaturesRequest) ProtoMessage()

func (*ListFeaturesRequest) ProtoReflect

func (x *ListFeaturesRequest) ProtoReflect() protoreflect.Message

func (*ListFeaturesRequest) Reset

func (x *ListFeaturesRequest) Reset()

func (*ListFeaturesRequest) String

func (x *ListFeaturesRequest) String() string

type ListFeaturesResponse

type ListFeaturesResponse struct {

	// The Features matching the request.
	Features []*Feature `protobuf:"bytes,1,rep,name=features,proto3" json:"features,omitempty"`
	// A token, which can be sent as
	// [ListFeaturesRequest.page_token][google.cloud.aiplatform.v1.ListFeaturesRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]. Response message for [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures].

func (*ListFeaturesResponse) Descriptor deprecated

func (*ListFeaturesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListFeaturesResponse.ProtoReflect.Descriptor instead.

func (*ListFeaturesResponse) GetFeatures

func (x *ListFeaturesResponse) GetFeatures() []*Feature

func (*ListFeaturesResponse) GetNextPageToken

func (x *ListFeaturesResponse) GetNextPageToken() string

func (*ListFeaturesResponse) ProtoMessage

func (*ListFeaturesResponse) ProtoMessage()

func (*ListFeaturesResponse) ProtoReflect

func (x *ListFeaturesResponse) ProtoReflect() protoreflect.Message

func (*ListFeaturesResponse) Reset

func (x *ListFeaturesResponse) Reset()

func (*ListFeaturesResponse) String

func (x *ListFeaturesResponse) String() string

type ListFeaturestoresRequest

type ListFeaturestoresRequest struct {

	// Required. The resource name of the Location to list Featurestores.
	// Format:
	// `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the featurestores that match the filter expression. The following
	// fields are supported:
	//
	// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
	// Values must be
	//
	//	in RFC 3339 format.
	//
	// * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
	// Values must be
	//
	//	in RFC 3339 format.
	//
	// * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`,
	// `<=`, and `>=` comparisons.
	// * `labels`: Supports key-value equality and key presence.
	//
	// Examples:
	//
	//   - `create_time > "2020-01-01" OR update_time > "2020-01-01"`
	//     Featurestores created or updated after 2020-01-01.
	//   - `labels.env = "prod"`
	//     Featurestores with label "env" set to "prod".
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of Featurestores to return. The service may return fewer
	// than this value. If unspecified, at most 100 Featurestores will be
	// returned. The maximum value is 100; any value greater than 100 will be
	// coerced to 100.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	// Supported Fields:
	//
	//   - `create_time`
	//   - `update_time`
	//   - `online_serving_config.fixed_node_count`
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores].

func (*ListFeaturestoresRequest) Descriptor deprecated

func (*ListFeaturestoresRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListFeaturestoresRequest.ProtoReflect.Descriptor instead.

func (*ListFeaturestoresRequest) GetFilter

func (x *ListFeaturestoresRequest) GetFilter() string

func (*ListFeaturestoresRequest) GetOrderBy

func (x *ListFeaturestoresRequest) GetOrderBy() string

func (*ListFeaturestoresRequest) GetPageSize

func (x *ListFeaturestoresRequest) GetPageSize() int32

func (*ListFeaturestoresRequest) GetPageToken

func (x *ListFeaturestoresRequest) GetPageToken() string

func (*ListFeaturestoresRequest) GetParent

func (x *ListFeaturestoresRequest) GetParent() string

func (*ListFeaturestoresRequest) GetReadMask

func (*ListFeaturestoresRequest) ProtoMessage

func (*ListFeaturestoresRequest) ProtoMessage()

func (*ListFeaturestoresRequest) ProtoReflect

func (x *ListFeaturestoresRequest) ProtoReflect() protoreflect.Message

func (*ListFeaturestoresRequest) Reset

func (x *ListFeaturestoresRequest) Reset()

func (*ListFeaturestoresRequest) String

func (x *ListFeaturestoresRequest) String() string

type ListFeaturestoresResponse

type ListFeaturestoresResponse struct {

	// The Featurestores matching the request.
	Featurestores []*Featurestore `protobuf:"bytes,1,rep,name=featurestores,proto3" json:"featurestores,omitempty"`
	// A token, which can be sent as
	// [ListFeaturestoresRequest.page_token][google.cloud.aiplatform.v1.ListFeaturestoresRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores].

func (*ListFeaturestoresResponse) Descriptor deprecated

func (*ListFeaturestoresResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListFeaturestoresResponse.ProtoReflect.Descriptor instead.

func (*ListFeaturestoresResponse) GetFeaturestores

func (x *ListFeaturestoresResponse) GetFeaturestores() []*Featurestore

func (*ListFeaturestoresResponse) GetNextPageToken

func (x *ListFeaturestoresResponse) GetNextPageToken() string

func (*ListFeaturestoresResponse) ProtoMessage

func (*ListFeaturestoresResponse) ProtoMessage()

func (*ListFeaturestoresResponse) ProtoReflect

func (*ListFeaturestoresResponse) Reset

func (x *ListFeaturestoresResponse) Reset()

func (*ListFeaturestoresResponse) String

func (x *ListFeaturestoresResponse) String() string

type ListHyperparameterTuningJobsRequest

type ListHyperparameterTuningJobsRequest struct {

	// Required. The resource name of the Location to list the
	// HyperparameterTuningJobs from. Format:
	// `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	//
	// Supported fields:
	//
	//   - `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
	//   - `state` supports `=`, `!=` comparisons.
	//   - `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
	//     `create_time` must be in RFC 3339 format.
	//   - `labels` supports general map functions that is:
	//     `labels.key=value` - key:value equality
	//     `labels.key:* - key existence
	//
	// Some examples of using the filter are:
	//
	//   - `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
	//   - `state!="JOB_STATE_FAILED" OR display_name="my_job"`
	//   - `NOT display_name="my_job"`
	//   - `create_time>"2021-05-18T00:00:00Z"`
	//   - `labels.keyA=valueA`
	//   - `labels.keyB:*`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token]
	// of the previous
	// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs].

func (*ListHyperparameterTuningJobsRequest) Descriptor deprecated

func (*ListHyperparameterTuningJobsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListHyperparameterTuningJobsRequest.ProtoReflect.Descriptor instead.

func (*ListHyperparameterTuningJobsRequest) GetFilter

func (*ListHyperparameterTuningJobsRequest) GetPageSize

func (x *ListHyperparameterTuningJobsRequest) GetPageSize() int32

func (*ListHyperparameterTuningJobsRequest) GetPageToken

func (x *ListHyperparameterTuningJobsRequest) GetPageToken() string

func (*ListHyperparameterTuningJobsRequest) GetParent

func (*ListHyperparameterTuningJobsRequest) GetReadMask

func (*ListHyperparameterTuningJobsRequest) ProtoMessage

func (*ListHyperparameterTuningJobsRequest) ProtoMessage()

func (*ListHyperparameterTuningJobsRequest) ProtoReflect

func (*ListHyperparameterTuningJobsRequest) Reset

func (*ListHyperparameterTuningJobsRequest) String

type ListHyperparameterTuningJobsResponse

type ListHyperparameterTuningJobsResponse struct {

	// List of HyperparameterTuningJobs in the requested page.
	// [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]
	// of the jobs will be not be returned.
	HyperparameterTuningJobs []*HyperparameterTuningJob `` /* 135-byte string literal not displayed */
	// A token to retrieve the next page of results.
	// Pass to
	// [ListHyperparameterTuningJobsRequest.page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]

func (*ListHyperparameterTuningJobsResponse) Descriptor deprecated

func (*ListHyperparameterTuningJobsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListHyperparameterTuningJobsResponse.ProtoReflect.Descriptor instead.

func (*ListHyperparameterTuningJobsResponse) GetHyperparameterTuningJobs

func (x *ListHyperparameterTuningJobsResponse) GetHyperparameterTuningJobs() []*HyperparameterTuningJob

func (*ListHyperparameterTuningJobsResponse) GetNextPageToken

func (x *ListHyperparameterTuningJobsResponse) GetNextPageToken() string

func (*ListHyperparameterTuningJobsResponse) ProtoMessage

func (*ListHyperparameterTuningJobsResponse) ProtoMessage()

func (*ListHyperparameterTuningJobsResponse) ProtoReflect

func (*ListHyperparameterTuningJobsResponse) Reset

func (*ListHyperparameterTuningJobsResponse) String

type ListIndexEndpointsRequest

type ListIndexEndpointsRequest struct {

	// Required. The resource name of the Location from which to list the
	// IndexEndpoints. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. An expression for filtering the results of the request. For field
	// names both snake_case and camelCase are supported.
	//
	//   - `index_endpoint` supports = and !=. `index_endpoint` represents the
	//     IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
	//     [resourcename][google.cloud.aiplatform.v1.IndexEndpoint.name].
	//   - `display_name` supports =, != and regex()
	//     (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax)
	//   - `labels` supports general map functions that is:
	//     `labels.key=value` - key:value equality
	//     `labels.key:* or labels:key - key existence
	//     A key including a space must be quoted. `labels."a key"`.
	//
	// Some examples:
	//   - `index_endpoint="1"`
	//   - `display_name="myDisplayName"`
	//   - `regex(display_name, "^A") -> The display name starts with an A.
	//   - `labels.myKey="myValue"`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The standard list page token.
	// Typically obtained via
	// [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token]
	// of the previous
	// [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].

func (*ListIndexEndpointsRequest) Descriptor deprecated

func (*ListIndexEndpointsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListIndexEndpointsRequest.ProtoReflect.Descriptor instead.

func (*ListIndexEndpointsRequest) GetFilter

func (x *ListIndexEndpointsRequest) GetFilter() string

func (*ListIndexEndpointsRequest) GetPageSize

func (x *ListIndexEndpointsRequest) GetPageSize() int32

func (*ListIndexEndpointsRequest) GetPageToken

func (x *ListIndexEndpointsRequest) GetPageToken() string

func (*ListIndexEndpointsRequest) GetParent

func (x *ListIndexEndpointsRequest) GetParent() string

func (*ListIndexEndpointsRequest) GetReadMask

func (*ListIndexEndpointsRequest) ProtoMessage

func (*ListIndexEndpointsRequest) ProtoMessage()

func (*ListIndexEndpointsRequest) ProtoReflect

func (*ListIndexEndpointsRequest) Reset

func (x *ListIndexEndpointsRequest) Reset()

func (*ListIndexEndpointsRequest) String

func (x *ListIndexEndpointsRequest) String() string

type ListIndexEndpointsResponse

type ListIndexEndpointsResponse struct {

	// List of IndexEndpoints in the requested page.
	IndexEndpoints []*IndexEndpoint `protobuf:"bytes,1,rep,name=index_endpoints,json=indexEndpoints,proto3" json:"index_endpoints,omitempty"`
	// A token to retrieve next page of results.
	// Pass to
	// [ListIndexEndpointsRequest.page_token][google.cloud.aiplatform.v1.ListIndexEndpointsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].

func (*ListIndexEndpointsResponse) Descriptor deprecated

func (*ListIndexEndpointsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListIndexEndpointsResponse.ProtoReflect.Descriptor instead.

func (*ListIndexEndpointsResponse) GetIndexEndpoints

func (x *ListIndexEndpointsResponse) GetIndexEndpoints() []*IndexEndpoint

func (*ListIndexEndpointsResponse) GetNextPageToken

func (x *ListIndexEndpointsResponse) GetNextPageToken() string

func (*ListIndexEndpointsResponse) ProtoMessage

func (*ListIndexEndpointsResponse) ProtoMessage()

func (*ListIndexEndpointsResponse) ProtoReflect

func (*ListIndexEndpointsResponse) Reset

func (x *ListIndexEndpointsResponse) Reset()

func (*ListIndexEndpointsResponse) String

func (x *ListIndexEndpointsResponse) String() string

type ListIndexesRequest

type ListIndexesRequest struct {

	// Required. The resource name of the Location from which to list the Indexes.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [ListIndexesResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token]
	// of the previous
	// [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes].

func (*ListIndexesRequest) Descriptor deprecated

func (*ListIndexesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListIndexesRequest.ProtoReflect.Descriptor instead.

func (*ListIndexesRequest) GetFilter

func (x *ListIndexesRequest) GetFilter() string

func (*ListIndexesRequest) GetPageSize

func (x *ListIndexesRequest) GetPageSize() int32

func (*ListIndexesRequest) GetPageToken

func (x *ListIndexesRequest) GetPageToken() string

func (*ListIndexesRequest) GetParent

func (x *ListIndexesRequest) GetParent() string

func (*ListIndexesRequest) GetReadMask

func (x *ListIndexesRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListIndexesRequest) ProtoMessage

func (*ListIndexesRequest) ProtoMessage()

func (*ListIndexesRequest) ProtoReflect

func (x *ListIndexesRequest) ProtoReflect() protoreflect.Message

func (*ListIndexesRequest) Reset

func (x *ListIndexesRequest) Reset()

func (*ListIndexesRequest) String

func (x *ListIndexesRequest) String() string

type ListIndexesResponse

type ListIndexesResponse struct {

	// List of indexes in the requested page.
	Indexes []*Index `protobuf:"bytes,1,rep,name=indexes,proto3" json:"indexes,omitempty"`
	// A token to retrieve next page of results.
	// Pass to
	// [ListIndexesRequest.page_token][google.cloud.aiplatform.v1.ListIndexesRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes].

func (*ListIndexesResponse) Descriptor deprecated

func (*ListIndexesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListIndexesResponse.ProtoReflect.Descriptor instead.

func (*ListIndexesResponse) GetIndexes

func (x *ListIndexesResponse) GetIndexes() []*Index

func (*ListIndexesResponse) GetNextPageToken

func (x *ListIndexesResponse) GetNextPageToken() string

func (*ListIndexesResponse) ProtoMessage

func (*ListIndexesResponse) ProtoMessage()

func (*ListIndexesResponse) ProtoReflect

func (x *ListIndexesResponse) ProtoReflect() protoreflect.Message

func (*ListIndexesResponse) Reset

func (x *ListIndexesResponse) Reset()

func (*ListIndexesResponse) String

func (x *ListIndexesResponse) String() string

type ListMetadataSchemasRequest

type ListMetadataSchemasRequest struct {

	// Required. The MetadataStore whose MetadataSchemas should be listed.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of MetadataSchemas to return. The service may return
	// fewer.
	// Must be in range 1-1000, inclusive. Defaults to 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas]
	// call. Provide this to retrieve the next page.
	//
	// When paginating, all other provided parameters must match the call that
	// provided the page token. (Otherwise the request will fail with
	// INVALID_ARGUMENT error.)
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A query to filter available MetadataSchemas for matching results.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas].

func (*ListMetadataSchemasRequest) Descriptor deprecated

func (*ListMetadataSchemasRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListMetadataSchemasRequest.ProtoReflect.Descriptor instead.

func (*ListMetadataSchemasRequest) GetFilter

func (x *ListMetadataSchemasRequest) GetFilter() string

func (*ListMetadataSchemasRequest) GetPageSize

func (x *ListMetadataSchemasRequest) GetPageSize() int32

func (*ListMetadataSchemasRequest) GetPageToken

func (x *ListMetadataSchemasRequest) GetPageToken() string

func (*ListMetadataSchemasRequest) GetParent

func (x *ListMetadataSchemasRequest) GetParent() string

func (*ListMetadataSchemasRequest) ProtoMessage

func (*ListMetadataSchemasRequest) ProtoMessage()

func (*ListMetadataSchemasRequest) ProtoReflect

func (*ListMetadataSchemasRequest) Reset

func (x *ListMetadataSchemasRequest) Reset()

func (*ListMetadataSchemasRequest) String

func (x *ListMetadataSchemasRequest) String() string

type ListMetadataSchemasResponse

type ListMetadataSchemasResponse struct {

	// The MetadataSchemas found for the MetadataStore.
	MetadataSchemas []*MetadataSchema `protobuf:"bytes,1,rep,name=metadata_schemas,json=metadataSchemas,proto3" json:"metadata_schemas,omitempty"`
	// A token, which can be sent as
	// [ListMetadataSchemasRequest.page_token][google.cloud.aiplatform.v1.ListMetadataSchemasRequest.page_token]
	// to retrieve the next page. If this field is not populated, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas].

func (*ListMetadataSchemasResponse) Descriptor deprecated

func (*ListMetadataSchemasResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListMetadataSchemasResponse.ProtoReflect.Descriptor instead.

func (*ListMetadataSchemasResponse) GetMetadataSchemas

func (x *ListMetadataSchemasResponse) GetMetadataSchemas() []*MetadataSchema

func (*ListMetadataSchemasResponse) GetNextPageToken

func (x *ListMetadataSchemasResponse) GetNextPageToken() string

func (*ListMetadataSchemasResponse) ProtoMessage

func (*ListMetadataSchemasResponse) ProtoMessage()

func (*ListMetadataSchemasResponse) ProtoReflect

func (*ListMetadataSchemasResponse) Reset

func (x *ListMetadataSchemasResponse) Reset()

func (*ListMetadataSchemasResponse) String

func (x *ListMetadataSchemasResponse) String() string

type ListMetadataStoresRequest

type ListMetadataStoresRequest struct {

	// Required. The Location whose MetadataStores should be listed.
	// Format:
	// `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of Metadata Stores to return. The service may return
	// fewer.
	// Must be in range 1-1000, inclusive. Defaults to 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other provided parameters must match the call that
	// provided the page token. (Otherwise the request will fail with
	// INVALID_ARGUMENT error.)
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores].

func (*ListMetadataStoresRequest) Descriptor deprecated

func (*ListMetadataStoresRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListMetadataStoresRequest.ProtoReflect.Descriptor instead.

func (*ListMetadataStoresRequest) GetPageSize

func (x *ListMetadataStoresRequest) GetPageSize() int32

func (*ListMetadataStoresRequest) GetPageToken

func (x *ListMetadataStoresRequest) GetPageToken() string

func (*ListMetadataStoresRequest) GetParent

func (x *ListMetadataStoresRequest) GetParent() string

func (*ListMetadataStoresRequest) ProtoMessage

func (*ListMetadataStoresRequest) ProtoMessage()

func (*ListMetadataStoresRequest) ProtoReflect

func (*ListMetadataStoresRequest) Reset

func (x *ListMetadataStoresRequest) Reset()

func (*ListMetadataStoresRequest) String

func (x *ListMetadataStoresRequest) String() string

type ListMetadataStoresResponse

type ListMetadataStoresResponse struct {

	// The MetadataStores found for the Location.
	MetadataStores []*MetadataStore `protobuf:"bytes,1,rep,name=metadata_stores,json=metadataStores,proto3" json:"metadata_stores,omitempty"`
	// A token, which can be sent as
	// [ListMetadataStoresRequest.page_token][google.cloud.aiplatform.v1.ListMetadataStoresRequest.page_token]
	// to retrieve the next page. If this field is not populated, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores].

func (*ListMetadataStoresResponse) Descriptor deprecated

func (*ListMetadataStoresResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListMetadataStoresResponse.ProtoReflect.Descriptor instead.

func (*ListMetadataStoresResponse) GetMetadataStores

func (x *ListMetadataStoresResponse) GetMetadataStores() []*MetadataStore

func (*ListMetadataStoresResponse) GetNextPageToken

func (x *ListMetadataStoresResponse) GetNextPageToken() string

func (*ListMetadataStoresResponse) ProtoMessage

func (*ListMetadataStoresResponse) ProtoMessage()

func (*ListMetadataStoresResponse) ProtoReflect

func (*ListMetadataStoresResponse) Reset

func (x *ListMetadataStoresResponse) Reset()

func (*ListMetadataStoresResponse) String

func (x *ListMetadataStoresResponse) String() string

type ListModelDeploymentMonitoringJobsRequest

type ListModelDeploymentMonitoringJobsRequest struct {

	// Required. The parent of the ModelDeploymentMonitoringJob.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	//
	// Supported fields:
	//
	//   - `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
	//   - `state` supports `=`, `!=` comparisons.
	//   - `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
	//     `create_time` must be in RFC 3339 format.
	//   - `labels` supports general map functions that is:
	//     `labels.key=value` - key:value equality
	//     `labels.key:* - key existence
	//
	// Some examples of using the filter are:
	//
	//   - `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
	//   - `state!="JOB_STATE_FAILED" OR display_name="my_job"`
	//   - `NOT display_name="my_job"`
	//   - `create_time>"2021-05-18T00:00:00Z"`
	//   - `labels.keyA=valueA`
	//   - `labels.keyB:*`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.ListModelDeploymentMonitoringJobs][google.cloud.aiplatform.v1.JobService.ListModelDeploymentMonitoringJobs].

func (*ListModelDeploymentMonitoringJobsRequest) Descriptor deprecated

func (*ListModelDeploymentMonitoringJobsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListModelDeploymentMonitoringJobsRequest.ProtoReflect.Descriptor instead.

func (*ListModelDeploymentMonitoringJobsRequest) GetFilter

func (*ListModelDeploymentMonitoringJobsRequest) GetPageSize

func (*ListModelDeploymentMonitoringJobsRequest) GetPageToken

func (*ListModelDeploymentMonitoringJobsRequest) GetParent

func (*ListModelDeploymentMonitoringJobsRequest) GetReadMask

func (*ListModelDeploymentMonitoringJobsRequest) ProtoMessage

func (*ListModelDeploymentMonitoringJobsRequest) ProtoReflect

func (*ListModelDeploymentMonitoringJobsRequest) Reset

func (*ListModelDeploymentMonitoringJobsRequest) String

type ListModelDeploymentMonitoringJobsResponse

type ListModelDeploymentMonitoringJobsResponse struct {

	// A list of ModelDeploymentMonitoringJobs that matches the specified filter
	// in the request.
	ModelDeploymentMonitoringJobs []*ModelDeploymentMonitoringJob `` /* 152-byte string literal not displayed */
	// The standard List next-page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [JobService.ListModelDeploymentMonitoringJobs][google.cloud.aiplatform.v1.JobService.ListModelDeploymentMonitoringJobs].

func (*ListModelDeploymentMonitoringJobsResponse) Descriptor deprecated

func (*ListModelDeploymentMonitoringJobsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListModelDeploymentMonitoringJobsResponse.ProtoReflect.Descriptor instead.

func (*ListModelDeploymentMonitoringJobsResponse) GetModelDeploymentMonitoringJobs

func (x *ListModelDeploymentMonitoringJobsResponse) GetModelDeploymentMonitoringJobs() []*ModelDeploymentMonitoringJob

func (*ListModelDeploymentMonitoringJobsResponse) GetNextPageToken

func (x *ListModelDeploymentMonitoringJobsResponse) GetNextPageToken() string

func (*ListModelDeploymentMonitoringJobsResponse) ProtoMessage

func (*ListModelDeploymentMonitoringJobsResponse) ProtoReflect

func (*ListModelDeploymentMonitoringJobsResponse) Reset

func (*ListModelDeploymentMonitoringJobsResponse) String

type ListModelEvaluationSlicesRequest

type ListModelEvaluationSlicesRequest struct {

	// Required. The resource name of the ModelEvaluation to list the
	// ModelEvaluationSlices from. Format:
	// `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	//
	//   - `slice.dimension` - for =.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [ListModelEvaluationSlicesResponse.next_page_token][google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token]
	// of the previous
	// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices].

func (*ListModelEvaluationSlicesRequest) Descriptor deprecated

func (*ListModelEvaluationSlicesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListModelEvaluationSlicesRequest.ProtoReflect.Descriptor instead.

func (*ListModelEvaluationSlicesRequest) GetFilter

func (*ListModelEvaluationSlicesRequest) GetPageSize

func (x *ListModelEvaluationSlicesRequest) GetPageSize() int32

func (*ListModelEvaluationSlicesRequest) GetPageToken

func (x *ListModelEvaluationSlicesRequest) GetPageToken() string

func (*ListModelEvaluationSlicesRequest) GetParent

func (*ListModelEvaluationSlicesRequest) GetReadMask

func (*ListModelEvaluationSlicesRequest) ProtoMessage

func (*ListModelEvaluationSlicesRequest) ProtoMessage()

func (*ListModelEvaluationSlicesRequest) ProtoReflect

func (*ListModelEvaluationSlicesRequest) Reset

func (*ListModelEvaluationSlicesRequest) String

type ListModelEvaluationSlicesResponse

type ListModelEvaluationSlicesResponse struct {

	// List of ModelEvaluations in the requested page.
	ModelEvaluationSlices []*ModelEvaluationSlice `` /* 126-byte string literal not displayed */
	// A token to retrieve next page of results.
	// Pass to
	// [ListModelEvaluationSlicesRequest.page_token][google.cloud.aiplatform.v1.ListModelEvaluationSlicesRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices].

func (*ListModelEvaluationSlicesResponse) Descriptor deprecated

func (*ListModelEvaluationSlicesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListModelEvaluationSlicesResponse.ProtoReflect.Descriptor instead.

func (*ListModelEvaluationSlicesResponse) GetModelEvaluationSlices

func (x *ListModelEvaluationSlicesResponse) GetModelEvaluationSlices() []*ModelEvaluationSlice

func (*ListModelEvaluationSlicesResponse) GetNextPageToken

func (x *ListModelEvaluationSlicesResponse) GetNextPageToken() string

func (*ListModelEvaluationSlicesResponse) ProtoMessage

func (*ListModelEvaluationSlicesResponse) ProtoMessage()

func (*ListModelEvaluationSlicesResponse) ProtoReflect

func (*ListModelEvaluationSlicesResponse) Reset

func (*ListModelEvaluationSlicesResponse) String

type ListModelEvaluationsRequest

type ListModelEvaluationsRequest struct {

	// Required. The resource name of the Model to list the ModelEvaluations from.
	// Format: `projects/{project}/locations/{location}/models/{model}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [ListModelEvaluationsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token]
	// of the previous
	// [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations].

func (*ListModelEvaluationsRequest) Descriptor deprecated

func (*ListModelEvaluationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListModelEvaluationsRequest.ProtoReflect.Descriptor instead.

func (*ListModelEvaluationsRequest) GetFilter

func (x *ListModelEvaluationsRequest) GetFilter() string

func (*ListModelEvaluationsRequest) GetPageSize

func (x *ListModelEvaluationsRequest) GetPageSize() int32

func (*ListModelEvaluationsRequest) GetPageToken

func (x *ListModelEvaluationsRequest) GetPageToken() string

func (*ListModelEvaluationsRequest) GetParent

func (x *ListModelEvaluationsRequest) GetParent() string

func (*ListModelEvaluationsRequest) GetReadMask

func (*ListModelEvaluationsRequest) ProtoMessage

func (*ListModelEvaluationsRequest) ProtoMessage()

func (*ListModelEvaluationsRequest) ProtoReflect

func (*ListModelEvaluationsRequest) Reset

func (x *ListModelEvaluationsRequest) Reset()

func (*ListModelEvaluationsRequest) String

func (x *ListModelEvaluationsRequest) String() string

type ListModelEvaluationsResponse

type ListModelEvaluationsResponse struct {

	// List of ModelEvaluations in the requested page.
	ModelEvaluations []*ModelEvaluation `protobuf:"bytes,1,rep,name=model_evaluations,json=modelEvaluations,proto3" json:"model_evaluations,omitempty"`
	// A token to retrieve next page of results.
	// Pass to
	// [ListModelEvaluationsRequest.page_token][google.cloud.aiplatform.v1.ListModelEvaluationsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations].

func (*ListModelEvaluationsResponse) Descriptor deprecated

func (*ListModelEvaluationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListModelEvaluationsResponse.ProtoReflect.Descriptor instead.

func (*ListModelEvaluationsResponse) GetModelEvaluations

func (x *ListModelEvaluationsResponse) GetModelEvaluations() []*ModelEvaluation

func (*ListModelEvaluationsResponse) GetNextPageToken

func (x *ListModelEvaluationsResponse) GetNextPageToken() string

func (*ListModelEvaluationsResponse) ProtoMessage

func (*ListModelEvaluationsResponse) ProtoMessage()

func (*ListModelEvaluationsResponse) ProtoReflect

func (*ListModelEvaluationsResponse) Reset

func (x *ListModelEvaluationsResponse) Reset()

func (*ListModelEvaluationsResponse) String

type ListModelVersionsRequest

type ListModelVersionsRequest struct {

	// Required. The name of the model to list versions for.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [next_page_token][google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token]
	// of the previous
	// [ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions]
	// call.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// An expression for filtering the results of the request. For field names
	// both snake_case and camelCase are supported.
	//
	//   - `labels` supports general map functions that is:
	//   - `labels.key=value` - key:value equality
	//   - `labels.key:* or labels:key - key existence
	//   - A key including a space must be quoted. `labels."a key"`.
	//
	// Some examples:
	//
	//   - `labels.myKey="myValue"`
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	// Supported fields:
	//
	//   - `create_time`
	//   - `update_time`
	//
	// Example: `update_time asc, create_time desc`.
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions].

func (*ListModelVersionsRequest) Descriptor deprecated

func (*ListModelVersionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListModelVersionsRequest.ProtoReflect.Descriptor instead.

func (*ListModelVersionsRequest) GetFilter

func (x *ListModelVersionsRequest) GetFilter() string

func (*ListModelVersionsRequest) GetName

func (x *ListModelVersionsRequest) GetName() string

func (*ListModelVersionsRequest) GetOrderBy added in v1.30.0

func (x *ListModelVersionsRequest) GetOrderBy() string

func (*ListModelVersionsRequest) GetPageSize

func (x *ListModelVersionsRequest) GetPageSize() int32

func (*ListModelVersionsRequest) GetPageToken

func (x *ListModelVersionsRequest) GetPageToken() string

func (*ListModelVersionsRequest) GetReadMask

func (*ListModelVersionsRequest) ProtoMessage

func (*ListModelVersionsRequest) ProtoMessage()

func (*ListModelVersionsRequest) ProtoReflect

func (x *ListModelVersionsRequest) ProtoReflect() protoreflect.Message

func (*ListModelVersionsRequest) Reset

func (x *ListModelVersionsRequest) Reset()

func (*ListModelVersionsRequest) String

func (x *ListModelVersionsRequest) String() string

type ListModelVersionsResponse

type ListModelVersionsResponse struct {

	// List of Model versions in the requested page.
	// In the returned Model name field, version ID instead of regvision tag will
	// be included.
	Models []*Model `protobuf:"bytes,1,rep,name=models,proto3" json:"models,omitempty"`
	// A token to retrieve the next page of results.
	// Pass to
	// [ListModelVersionsRequest.page_token][google.cloud.aiplatform.v1.ListModelVersionsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ModelService.ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions]

func (*ListModelVersionsResponse) Descriptor deprecated

func (*ListModelVersionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListModelVersionsResponse.ProtoReflect.Descriptor instead.

func (*ListModelVersionsResponse) GetModels

func (x *ListModelVersionsResponse) GetModels() []*Model

func (*ListModelVersionsResponse) GetNextPageToken

func (x *ListModelVersionsResponse) GetNextPageToken() string

func (*ListModelVersionsResponse) ProtoMessage

func (*ListModelVersionsResponse) ProtoMessage()

func (*ListModelVersionsResponse) ProtoReflect

func (*ListModelVersionsResponse) Reset

func (x *ListModelVersionsResponse) Reset()

func (*ListModelVersionsResponse) String

func (x *ListModelVersionsResponse) String() string

type ListModelsRequest

type ListModelsRequest struct {

	// Required. The resource name of the Location to list the Models from.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// An expression for filtering the results of the request. For field names
	// both snake_case and camelCase are supported.
	//
	//   - `model` supports = and !=. `model` represents the Model ID,
	//     i.e. the last segment of the Model's [resource
	//     name][google.cloud.aiplatform.v1.Model.name].
	//   - `display_name` supports = and !=
	//   - `labels` supports general map functions that is:
	//   - `labels.key=value` - key:value equality
	//   - `labels.key:* or labels:key - key existence
	//   - A key including a space must be quoted. `labels."a key"`.
	//   - `base_model_name` only supports =
	//
	// Some examples:
	//
	//   - `model=1234`
	//   - `displayName="myDisplayName"`
	//   - `labels.myKey="myValue"`
	//   - `baseModelName="text-bison"`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelsResponse.next_page_token]
	// of the previous
	// [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	// Supported fields:
	//
	//   - `display_name`
	//   - `create_time`
	//   - `update_time`
	//
	// Example: `display_name, create_time desc`.
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels].

func (*ListModelsRequest) Descriptor deprecated

func (*ListModelsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListModelsRequest.ProtoReflect.Descriptor instead.

func (*ListModelsRequest) GetFilter

func (x *ListModelsRequest) GetFilter() string

func (*ListModelsRequest) GetOrderBy

func (x *ListModelsRequest) GetOrderBy() string

func (*ListModelsRequest) GetPageSize

func (x *ListModelsRequest) GetPageSize() int32

func (*ListModelsRequest) GetPageToken

func (x *ListModelsRequest) GetPageToken() string

func (*ListModelsRequest) GetParent

func (x *ListModelsRequest) GetParent() string

func (*ListModelsRequest) GetReadMask

func (x *ListModelsRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListModelsRequest) ProtoMessage

func (*ListModelsRequest) ProtoMessage()

func (*ListModelsRequest) ProtoReflect

func (x *ListModelsRequest) ProtoReflect() protoreflect.Message

func (*ListModelsRequest) Reset

func (x *ListModelsRequest) Reset()

func (*ListModelsRequest) String

func (x *ListModelsRequest) String() string

type ListModelsResponse

type ListModelsResponse struct {

	// List of Models in the requested page.
	Models []*Model `protobuf:"bytes,1,rep,name=models,proto3" json:"models,omitempty"`
	// A token to retrieve next page of results.
	// Pass to
	// [ListModelsRequest.page_token][google.cloud.aiplatform.v1.ListModelsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]

func (*ListModelsResponse) Descriptor deprecated

func (*ListModelsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListModelsResponse.ProtoReflect.Descriptor instead.

func (*ListModelsResponse) GetModels

func (x *ListModelsResponse) GetModels() []*Model

func (*ListModelsResponse) GetNextPageToken

func (x *ListModelsResponse) GetNextPageToken() string

func (*ListModelsResponse) ProtoMessage

func (*ListModelsResponse) ProtoMessage()

func (*ListModelsResponse) ProtoReflect

func (x *ListModelsResponse) ProtoReflect() protoreflect.Message

func (*ListModelsResponse) Reset

func (x *ListModelsResponse) Reset()

func (*ListModelsResponse) String

func (x *ListModelsResponse) String() string

type ListNasJobsRequest added in v1.34.0

type ListNasJobsRequest struct {

	// Required. The resource name of the Location to list the NasJobs
	// from. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	//
	// Supported fields:
	//
	//   - `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
	//   - `state` supports `=`, `!=` comparisons.
	//   - `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
	//     `create_time` must be in RFC 3339 format.
	//   - `labels` supports general map functions that is:
	//     `labels.key=value` - key:value equality
	//     `labels.key:* - key existence
	//
	// Some examples of using the filter are:
	//
	//   - `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
	//   - `state!="JOB_STATE_FAILED" OR display_name="my_job"`
	//   - `NOT display_name="my_job"`
	//   - `create_time>"2021-05-18T00:00:00Z"`
	//   - `labels.keyA=valueA`
	//   - `labels.keyB:*`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [ListNasJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token]
	// of the previous
	// [JobService.ListNasJobs][google.cloud.aiplatform.v1.JobService.ListNasJobs]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.ListNasJobs][google.cloud.aiplatform.v1.JobService.ListNasJobs].

func (*ListNasJobsRequest) Descriptor deprecated added in v1.34.0

func (*ListNasJobsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListNasJobsRequest.ProtoReflect.Descriptor instead.

func (*ListNasJobsRequest) GetFilter added in v1.34.0

func (x *ListNasJobsRequest) GetFilter() string

func (*ListNasJobsRequest) GetPageSize added in v1.34.0

func (x *ListNasJobsRequest) GetPageSize() int32

func (*ListNasJobsRequest) GetPageToken added in v1.34.0

func (x *ListNasJobsRequest) GetPageToken() string

func (*ListNasJobsRequest) GetParent added in v1.34.0

func (x *ListNasJobsRequest) GetParent() string

func (*ListNasJobsRequest) GetReadMask added in v1.34.0

func (x *ListNasJobsRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListNasJobsRequest) ProtoMessage added in v1.34.0

func (*ListNasJobsRequest) ProtoMessage()

func (*ListNasJobsRequest) ProtoReflect added in v1.34.0

func (x *ListNasJobsRequest) ProtoReflect() protoreflect.Message

func (*ListNasJobsRequest) Reset added in v1.34.0

func (x *ListNasJobsRequest) Reset()

func (*ListNasJobsRequest) String added in v1.34.0

func (x *ListNasJobsRequest) String() string

type ListNasJobsResponse added in v1.34.0

type ListNasJobsResponse struct {

	// List of NasJobs in the requested page.
	// [NasJob.nas_job_output][google.cloud.aiplatform.v1.NasJob.nas_job_output]
	// of the jobs will not be returned.
	NasJobs []*NasJob `protobuf:"bytes,1,rep,name=nas_jobs,json=nasJobs,proto3" json:"nas_jobs,omitempty"`
	// A token to retrieve the next page of results.
	// Pass to
	// [ListNasJobsRequest.page_token][google.cloud.aiplatform.v1.ListNasJobsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [JobService.ListNasJobs][google.cloud.aiplatform.v1.JobService.ListNasJobs]

func (*ListNasJobsResponse) Descriptor deprecated added in v1.34.0

func (*ListNasJobsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListNasJobsResponse.ProtoReflect.Descriptor instead.

func (*ListNasJobsResponse) GetNasJobs added in v1.34.0

func (x *ListNasJobsResponse) GetNasJobs() []*NasJob

func (*ListNasJobsResponse) GetNextPageToken added in v1.34.0

func (x *ListNasJobsResponse) GetNextPageToken() string

func (*ListNasJobsResponse) ProtoMessage added in v1.34.0

func (*ListNasJobsResponse) ProtoMessage()

func (*ListNasJobsResponse) ProtoReflect added in v1.34.0

func (x *ListNasJobsResponse) ProtoReflect() protoreflect.Message

func (*ListNasJobsResponse) Reset added in v1.34.0

func (x *ListNasJobsResponse) Reset()

func (*ListNasJobsResponse) String added in v1.34.0

func (x *ListNasJobsResponse) String() string

type ListNasTrialDetailsRequest added in v1.34.0

type ListNasTrialDetailsRequest struct {

	// Required. The name of the NasJob resource.
	// Format:
	// `projects/{project}/locations/{location}/nasJobs/{nas_job}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [ListNasTrialDetailsResponse.next_page_token][google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token]
	// of the previous
	// [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1.JobService.ListNasTrialDetails]
	// call.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1.JobService.ListNasTrialDetails].

func (*ListNasTrialDetailsRequest) Descriptor deprecated added in v1.34.0

func (*ListNasTrialDetailsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListNasTrialDetailsRequest.ProtoReflect.Descriptor instead.

func (*ListNasTrialDetailsRequest) GetPageSize added in v1.34.0

func (x *ListNasTrialDetailsRequest) GetPageSize() int32

func (*ListNasTrialDetailsRequest) GetPageToken added in v1.34.0

func (x *ListNasTrialDetailsRequest) GetPageToken() string

func (*ListNasTrialDetailsRequest) GetParent added in v1.34.0

func (x *ListNasTrialDetailsRequest) GetParent() string

func (*ListNasTrialDetailsRequest) ProtoMessage added in v1.34.0

func (*ListNasTrialDetailsRequest) ProtoMessage()

func (*ListNasTrialDetailsRequest) ProtoReflect added in v1.34.0

func (*ListNasTrialDetailsRequest) Reset added in v1.34.0

func (x *ListNasTrialDetailsRequest) Reset()

func (*ListNasTrialDetailsRequest) String added in v1.34.0

func (x *ListNasTrialDetailsRequest) String() string

type ListNasTrialDetailsResponse added in v1.34.0

type ListNasTrialDetailsResponse struct {

	// List of top NasTrials in the requested page.
	NasTrialDetails []*NasTrialDetail `protobuf:"bytes,1,rep,name=nas_trial_details,json=nasTrialDetails,proto3" json:"nas_trial_details,omitempty"`
	// A token to retrieve the next page of results.
	// Pass to
	// [ListNasTrialDetailsRequest.page_token][google.cloud.aiplatform.v1.ListNasTrialDetailsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1.JobService.ListNasTrialDetails]

func (*ListNasTrialDetailsResponse) Descriptor deprecated added in v1.34.0

func (*ListNasTrialDetailsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListNasTrialDetailsResponse.ProtoReflect.Descriptor instead.

func (*ListNasTrialDetailsResponse) GetNasTrialDetails added in v1.34.0

func (x *ListNasTrialDetailsResponse) GetNasTrialDetails() []*NasTrialDetail

func (*ListNasTrialDetailsResponse) GetNextPageToken added in v1.34.0

func (x *ListNasTrialDetailsResponse) GetNextPageToken() string

func (*ListNasTrialDetailsResponse) ProtoMessage added in v1.34.0

func (*ListNasTrialDetailsResponse) ProtoMessage()

func (*ListNasTrialDetailsResponse) ProtoReflect added in v1.34.0

func (*ListNasTrialDetailsResponse) Reset added in v1.34.0

func (x *ListNasTrialDetailsResponse) Reset()

func (*ListNasTrialDetailsResponse) String added in v1.34.0

func (x *ListNasTrialDetailsResponse) String() string

type ListNotebookRuntimeTemplatesRequest added in v1.67.0

type ListNotebookRuntimeTemplatesRequest struct {

	// Required. The resource name of the Location from which to list the
	// NotebookRuntimeTemplates.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. An expression for filtering the results of the request. For field
	// names both snake_case and camelCase are supported.
	//
	//   - `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate`
	//     represents the NotebookRuntimeTemplate ID,
	//     i.e. the last segment of the NotebookRuntimeTemplate's [resource name]
	//     [google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name].
	//   - `display_name` supports = and !=
	//   - `labels` supports general map functions that is:
	//   - `labels.key=value` - key:value equality
	//   - `labels.key:* or labels:key - key existence
	//   - A key including a space must be quoted. `labels."a key"`.
	//   - `notebookRuntimeType` supports = and !=. notebookRuntimeType enum:
	//     [USER_DEFINED, ONE_CLICK].
	//
	// Some examples:
	//
	//   - `notebookRuntimeTemplate=notebookRuntimeTemplate123`
	//   - `displayName="myDisplayName"`
	//   - `labels.myKey="myValue"`
	//   - `notebookRuntimeType=USER_DEFINED`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The standard list page token.
	// Typically obtained via
	// [ListNotebookRuntimeTemplatesResponse.next_page_token][google.cloud.aiplatform.v1.ListNotebookRuntimeTemplatesResponse.next_page_token]
	// of the previous
	// [NotebookService.ListNotebookRuntimeTemplates][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimeTemplates]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// Optional. A comma-separated list of fields to order by, sorted in ascending
	// order. Use "desc" after a field name for descending. Supported fields:
	//
	//   - `display_name`
	//   - `create_time`
	//   - `update_time`
	//
	// Example: `display_name, create_time desc`.
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [NotebookService.ListNotebookRuntimeTemplates][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimeTemplates].

func (*ListNotebookRuntimeTemplatesRequest) Descriptor deprecated added in v1.67.0

func (*ListNotebookRuntimeTemplatesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListNotebookRuntimeTemplatesRequest.ProtoReflect.Descriptor instead.

func (*ListNotebookRuntimeTemplatesRequest) GetFilter added in v1.67.0

func (*ListNotebookRuntimeTemplatesRequest) GetOrderBy added in v1.67.0

func (*ListNotebookRuntimeTemplatesRequest) GetPageSize added in v1.67.0

func (x *ListNotebookRuntimeTemplatesRequest) GetPageSize() int32

func (*ListNotebookRuntimeTemplatesRequest) GetPageToken added in v1.67.0

func (x *ListNotebookRuntimeTemplatesRequest) GetPageToken() string

func (*ListNotebookRuntimeTemplatesRequest) GetParent added in v1.67.0

func (*ListNotebookRuntimeTemplatesRequest) GetReadMask added in v1.67.0

func (*ListNotebookRuntimeTemplatesRequest) ProtoMessage added in v1.67.0

func (*ListNotebookRuntimeTemplatesRequest) ProtoMessage()

func (*ListNotebookRuntimeTemplatesRequest) ProtoReflect added in v1.67.0

func (*ListNotebookRuntimeTemplatesRequest) Reset added in v1.67.0

func (*ListNotebookRuntimeTemplatesRequest) String added in v1.67.0

type ListNotebookRuntimeTemplatesResponse added in v1.67.0

type ListNotebookRuntimeTemplatesResponse struct {

	// List of NotebookRuntimeTemplates in the requested page.
	NotebookRuntimeTemplates []*NotebookRuntimeTemplate `` /* 135-byte string literal not displayed */
	// A token to retrieve next page of results.
	// Pass to
	// [ListNotebookRuntimeTemplatesRequest.page_token][google.cloud.aiplatform.v1.ListNotebookRuntimeTemplatesRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [NotebookService.ListNotebookRuntimeTemplates][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimeTemplates].

func (*ListNotebookRuntimeTemplatesResponse) Descriptor deprecated added in v1.67.0

func (*ListNotebookRuntimeTemplatesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListNotebookRuntimeTemplatesResponse.ProtoReflect.Descriptor instead.

func (*ListNotebookRuntimeTemplatesResponse) GetNextPageToken added in v1.67.0

func (x *ListNotebookRuntimeTemplatesResponse) GetNextPageToken() string

func (*ListNotebookRuntimeTemplatesResponse) GetNotebookRuntimeTemplates added in v1.67.0

func (x *ListNotebookRuntimeTemplatesResponse) GetNotebookRuntimeTemplates() []*NotebookRuntimeTemplate

func (*ListNotebookRuntimeTemplatesResponse) ProtoMessage added in v1.67.0

func (*ListNotebookRuntimeTemplatesResponse) ProtoMessage()

func (*ListNotebookRuntimeTemplatesResponse) ProtoReflect added in v1.67.0

func (*ListNotebookRuntimeTemplatesResponse) Reset added in v1.67.0

func (*ListNotebookRuntimeTemplatesResponse) String added in v1.67.0

type ListNotebookRuntimesRequest added in v1.67.0

type ListNotebookRuntimesRequest struct {

	// Required. The resource name of the Location from which to list the
	// NotebookRuntimes.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. An expression for filtering the results of the request. For field
	// names both snake_case and camelCase are supported.
	//
	//   - `notebookRuntime` supports = and !=. `notebookRuntime` represents the
	//     NotebookRuntime ID,
	//     i.e. the last segment of the NotebookRuntime's [resource name]
	//     [google.cloud.aiplatform.v1.NotebookRuntime.name].
	//   - `displayName` supports = and != and regex.
	//   - `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate`
	//     represents the NotebookRuntimeTemplate ID,
	//     i.e. the last segment of the NotebookRuntimeTemplate's [resource name]
	//     [google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name].
	//   - `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY,
	//     HEALTH_STATE_UNSPECIFIED].
	//   - `runtimeState` supports = and !=. runtimeState enum:
	//     [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED,
	//     STOPPED, BEING_UPGRADED, ERROR, INVALID].
	//   - `runtimeUser` supports = and !=.
	//   - API version is UI only: `uiState` supports = and !=. uiState enum:
	//     [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED,
	//     UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED,
	//     UI_RESOURCE_STATE_CREATION_FAILED].
	//   - `notebookRuntimeType` supports = and !=. notebookRuntimeType enum:
	//     [USER_DEFINED, ONE_CLICK].
	//
	// Some examples:
	//
	//   - `notebookRuntime="notebookRuntime123"`
	//   - `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
	//   - `notebookRuntimeTemplate="notebookRuntimeTemplate321"`
	//   - `healthState=HEALTHY`
	//   - `runtimeState=RUNNING`
	//   - `runtimeUser="test@google.com"`
	//   - `uiState=UI_RESOURCE_STATE_BEING_DELETED`
	//   - `notebookRuntimeType=USER_DEFINED`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The standard list page token.
	// Typically obtained via
	// [ListNotebookRuntimesResponse.next_page_token][google.cloud.aiplatform.v1.ListNotebookRuntimesResponse.next_page_token]
	// of the previous
	// [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// Optional. A comma-separated list of fields to order by, sorted in ascending
	// order. Use "desc" after a field name for descending. Supported fields:
	//
	//   - `display_name`
	//   - `create_time`
	//   - `update_time`
	//
	// Example: `display_name, create_time desc`.
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes].

func (*ListNotebookRuntimesRequest) Descriptor deprecated added in v1.67.0

func (*ListNotebookRuntimesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListNotebookRuntimesRequest.ProtoReflect.Descriptor instead.

func (*ListNotebookRuntimesRequest) GetFilter added in v1.67.0

func (x *ListNotebookRuntimesRequest) GetFilter() string

func (*ListNotebookRuntimesRequest) GetOrderBy added in v1.67.0

func (x *ListNotebookRuntimesRequest) GetOrderBy() string

func (*ListNotebookRuntimesRequest) GetPageSize added in v1.67.0

func (x *ListNotebookRuntimesRequest) GetPageSize() int32

func (*ListNotebookRuntimesRequest) GetPageToken added in v1.67.0

func (x *ListNotebookRuntimesRequest) GetPageToken() string

func (*ListNotebookRuntimesRequest) GetParent added in v1.67.0

func (x *ListNotebookRuntimesRequest) GetParent() string

func (*ListNotebookRuntimesRequest) GetReadMask added in v1.67.0

func (*ListNotebookRuntimesRequest) ProtoMessage added in v1.67.0

func (*ListNotebookRuntimesRequest) ProtoMessage()

func (*ListNotebookRuntimesRequest) ProtoReflect added in v1.67.0

func (*ListNotebookRuntimesRequest) Reset added in v1.67.0

func (x *ListNotebookRuntimesRequest) Reset()

func (*ListNotebookRuntimesRequest) String added in v1.67.0

func (x *ListNotebookRuntimesRequest) String() string

type ListNotebookRuntimesResponse added in v1.67.0

type ListNotebookRuntimesResponse struct {

	// List of NotebookRuntimes in the requested page.
	NotebookRuntimes []*NotebookRuntime `protobuf:"bytes,1,rep,name=notebook_runtimes,json=notebookRuntimes,proto3" json:"notebook_runtimes,omitempty"`
	// A token to retrieve next page of results.
	// Pass to
	// [ListNotebookRuntimesRequest.page_token][google.cloud.aiplatform.v1.ListNotebookRuntimesRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes].

func (*ListNotebookRuntimesResponse) Descriptor deprecated added in v1.67.0

func (*ListNotebookRuntimesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListNotebookRuntimesResponse.ProtoReflect.Descriptor instead.

func (*ListNotebookRuntimesResponse) GetNextPageToken added in v1.67.0

func (x *ListNotebookRuntimesResponse) GetNextPageToken() string

func (*ListNotebookRuntimesResponse) GetNotebookRuntimes added in v1.67.0

func (x *ListNotebookRuntimesResponse) GetNotebookRuntimes() []*NotebookRuntime

func (*ListNotebookRuntimesResponse) ProtoMessage added in v1.67.0

func (*ListNotebookRuntimesResponse) ProtoMessage()

func (*ListNotebookRuntimesResponse) ProtoReflect added in v1.67.0

func (*ListNotebookRuntimesResponse) Reset added in v1.67.0

func (x *ListNotebookRuntimesResponse) Reset()

func (*ListNotebookRuntimesResponse) String added in v1.67.0

type ListOptimalTrialsRequest

type ListOptimalTrialsRequest struct {

	// Required. The name of the Study that the optimal Trial belongs to.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1.VizierService.ListOptimalTrials].

func (*ListOptimalTrialsRequest) Descriptor deprecated

func (*ListOptimalTrialsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListOptimalTrialsRequest.ProtoReflect.Descriptor instead.

func (*ListOptimalTrialsRequest) GetParent

func (x *ListOptimalTrialsRequest) GetParent() string

func (*ListOptimalTrialsRequest) ProtoMessage

func (*ListOptimalTrialsRequest) ProtoMessage()

func (*ListOptimalTrialsRequest) ProtoReflect

func (x *ListOptimalTrialsRequest) ProtoReflect() protoreflect.Message

func (*ListOptimalTrialsRequest) Reset

func (x *ListOptimalTrialsRequest) Reset()

func (*ListOptimalTrialsRequest) String

func (x *ListOptimalTrialsRequest) String() string

type ListOptimalTrialsResponse

type ListOptimalTrialsResponse struct {

	// The pareto-optimal Trials for multiple objective Study or the
	// optimal trial for single objective Study. The definition of
	// pareto-optimal can be checked in wiki page.
	// https://en.wikipedia.org/wiki/Pareto_efficiency
	OptimalTrials []*Trial `protobuf:"bytes,1,rep,name=optimal_trials,json=optimalTrials,proto3" json:"optimal_trials,omitempty"`
	// contains filtered or unexported fields
}

Response message for [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1.VizierService.ListOptimalTrials].

func (*ListOptimalTrialsResponse) Descriptor deprecated

func (*ListOptimalTrialsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListOptimalTrialsResponse.ProtoReflect.Descriptor instead.

func (*ListOptimalTrialsResponse) GetOptimalTrials

func (x *ListOptimalTrialsResponse) GetOptimalTrials() []*Trial

func (*ListOptimalTrialsResponse) ProtoMessage

func (*ListOptimalTrialsResponse) ProtoMessage()

func (*ListOptimalTrialsResponse) ProtoReflect

func (*ListOptimalTrialsResponse) Reset

func (x *ListOptimalTrialsResponse) Reset()

func (*ListOptimalTrialsResponse) String

func (x *ListOptimalTrialsResponse) String() string

type ListPersistentResourcesRequest added in v1.67.0

type ListPersistentResourcesRequest struct {

	// Required. The resource name of the Location to list the PersistentResources
	// from. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The standard list page token.
	// Typically obtained via
	// [ListPersistentResourceResponse.next_page_token][] of the previous
	// [PersistentResourceService.ListPersistentResource][] call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PersistentResourceService.ListPersistentResource][].

func (*ListPersistentResourcesRequest) Descriptor deprecated added in v1.67.0

func (*ListPersistentResourcesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListPersistentResourcesRequest.ProtoReflect.Descriptor instead.

func (*ListPersistentResourcesRequest) GetPageSize added in v1.67.0

func (x *ListPersistentResourcesRequest) GetPageSize() int32

func (*ListPersistentResourcesRequest) GetPageToken added in v1.67.0

func (x *ListPersistentResourcesRequest) GetPageToken() string

func (*ListPersistentResourcesRequest) GetParent added in v1.67.0

func (x *ListPersistentResourcesRequest) GetParent() string

func (*ListPersistentResourcesRequest) ProtoMessage added in v1.67.0

func (*ListPersistentResourcesRequest) ProtoMessage()

func (*ListPersistentResourcesRequest) ProtoReflect added in v1.67.0

func (*ListPersistentResourcesRequest) Reset added in v1.67.0

func (x *ListPersistentResourcesRequest) Reset()

func (*ListPersistentResourcesRequest) String added in v1.67.0

type ListPersistentResourcesResponse added in v1.67.0

type ListPersistentResourcesResponse struct {
	PersistentResources []*PersistentResource `protobuf:"bytes,1,rep,name=persistent_resources,json=persistentResources,proto3" json:"persistent_resources,omitempty"`
	// A token to retrieve next page of results.
	// Pass to
	// [ListPersistentResourcesRequest.page_token][google.cloud.aiplatform.v1.ListPersistentResourcesRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PersistentResourceService.ListPersistentResources][google.cloud.aiplatform.v1.PersistentResourceService.ListPersistentResources]

func (*ListPersistentResourcesResponse) Descriptor deprecated added in v1.67.0

func (*ListPersistentResourcesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListPersistentResourcesResponse.ProtoReflect.Descriptor instead.

func (*ListPersistentResourcesResponse) GetNextPageToken added in v1.67.0

func (x *ListPersistentResourcesResponse) GetNextPageToken() string

func (*ListPersistentResourcesResponse) GetPersistentResources added in v1.67.0

func (x *ListPersistentResourcesResponse) GetPersistentResources() []*PersistentResource

func (*ListPersistentResourcesResponse) ProtoMessage added in v1.67.0

func (*ListPersistentResourcesResponse) ProtoMessage()

func (*ListPersistentResourcesResponse) ProtoReflect added in v1.67.0

func (*ListPersistentResourcesResponse) Reset added in v1.67.0

func (*ListPersistentResourcesResponse) String added in v1.67.0

type ListPipelineJobsRequest

type ListPipelineJobsRequest struct {

	// Required. The resource name of the Location to list the PipelineJobs from.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the PipelineJobs that match the filter expression. The following
	// fields are supported:
	//
	//   - `pipeline_name`: Supports `=` and `!=` comparisons.
	//   - `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard.
	//   - `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard.
	//     for example, can check if pipeline's display_name contains *step* by
	//     doing display_name:\"*step*\"
	//   - `state`: Supports `=` and `!=` comparisons.
	//   - `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
	//     Values must be in RFC 3339 format.
	//   - `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
	//     Values must be in RFC 3339 format.
	//   - `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
	//     Values must be in RFC 3339 format.
	//   - `labels`: Supports key-value equality and key presence.
	//   - `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard.
	//   - `template_metadata.version`: Supports `=`, `!=` comparisons, and `:`
	//     wildcard.
	//
	// Filter expressions can be combined together using logical operators
	// (`AND` & `OR`).
	// For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`.
	//
	// The syntax to define filter expression is based on
	// https://google.aip.dev/160.
	//
	// Examples:
	//
	//   - `create_time>"2021-05-18T00:00:00Z" OR
	//     update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated
	//     after 2020-05-18 00:00:00 UTC.
	//   - `labels.env = "prod"`
	//     PipelineJobs with label "env" set to "prod".
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token]
	// of the previous
	// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A comma-separated list of fields to order by. The default sort order is in
	// ascending order. Use "desc" after a field name for descending. You can have
	// multiple order_by fields provided e.g. "create_time desc, end_time",
	// "end_time, start_time, update_time" For example, using "create_time desc,
	// end_time" will order results by create time in descending order, and if
	// there are multiple jobs having the same create time, order them by the end
	// time in ascending order. if order_by is not specified, it will order by
	// default order is create time in descending order. Supported fields:
	//
	//   - `create_time`
	//   - `update_time`
	//   - `end_time`
	//   - `start_time`
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,7,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs].

func (*ListPipelineJobsRequest) Descriptor deprecated

func (*ListPipelineJobsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListPipelineJobsRequest.ProtoReflect.Descriptor instead.

func (*ListPipelineJobsRequest) GetFilter

func (x *ListPipelineJobsRequest) GetFilter() string

func (*ListPipelineJobsRequest) GetOrderBy

func (x *ListPipelineJobsRequest) GetOrderBy() string

func (*ListPipelineJobsRequest) GetPageSize

func (x *ListPipelineJobsRequest) GetPageSize() int32

func (*ListPipelineJobsRequest) GetPageToken

func (x *ListPipelineJobsRequest) GetPageToken() string

func (*ListPipelineJobsRequest) GetParent

func (x *ListPipelineJobsRequest) GetParent() string

func (*ListPipelineJobsRequest) GetReadMask

func (x *ListPipelineJobsRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListPipelineJobsRequest) ProtoMessage

func (*ListPipelineJobsRequest) ProtoMessage()

func (*ListPipelineJobsRequest) ProtoReflect

func (x *ListPipelineJobsRequest) ProtoReflect() protoreflect.Message

func (*ListPipelineJobsRequest) Reset

func (x *ListPipelineJobsRequest) Reset()

func (*ListPipelineJobsRequest) String

func (x *ListPipelineJobsRequest) String() string

type ListPipelineJobsResponse

type ListPipelineJobsResponse struct {

	// List of PipelineJobs in the requested page.
	PipelineJobs []*PipelineJob `protobuf:"bytes,1,rep,name=pipeline_jobs,json=pipelineJobs,proto3" json:"pipeline_jobs,omitempty"`
	// A token to retrieve the next page of results.
	// Pass to
	// [ListPipelineJobsRequest.page_token][google.cloud.aiplatform.v1.ListPipelineJobsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs]

func (*ListPipelineJobsResponse) Descriptor deprecated

func (*ListPipelineJobsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListPipelineJobsResponse.ProtoReflect.Descriptor instead.

func (*ListPipelineJobsResponse) GetNextPageToken

func (x *ListPipelineJobsResponse) GetNextPageToken() string

func (*ListPipelineJobsResponse) GetPipelineJobs

func (x *ListPipelineJobsResponse) GetPipelineJobs() []*PipelineJob

func (*ListPipelineJobsResponse) ProtoMessage

func (*ListPipelineJobsResponse) ProtoMessage()

func (*ListPipelineJobsResponse) ProtoReflect

func (x *ListPipelineJobsResponse) ProtoReflect() protoreflect.Message

func (*ListPipelineJobsResponse) Reset

func (x *ListPipelineJobsResponse) Reset()

func (*ListPipelineJobsResponse) String

func (x *ListPipelineJobsResponse) String() string

type ListSavedQueriesRequest

type ListSavedQueriesRequest struct {

	// Required. The resource name of the Dataset to list SavedQueries from.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries].

func (*ListSavedQueriesRequest) Descriptor deprecated

func (*ListSavedQueriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSavedQueriesRequest.ProtoReflect.Descriptor instead.

func (*ListSavedQueriesRequest) GetFilter

func (x *ListSavedQueriesRequest) GetFilter() string

func (*ListSavedQueriesRequest) GetOrderBy

func (x *ListSavedQueriesRequest) GetOrderBy() string

func (*ListSavedQueriesRequest) GetPageSize

func (x *ListSavedQueriesRequest) GetPageSize() int32

func (*ListSavedQueriesRequest) GetPageToken

func (x *ListSavedQueriesRequest) GetPageToken() string

func (*ListSavedQueriesRequest) GetParent

func (x *ListSavedQueriesRequest) GetParent() string

func (*ListSavedQueriesRequest) GetReadMask

func (x *ListSavedQueriesRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListSavedQueriesRequest) ProtoMessage

func (*ListSavedQueriesRequest) ProtoMessage()

func (*ListSavedQueriesRequest) ProtoReflect

func (x *ListSavedQueriesRequest) ProtoReflect() protoreflect.Message

func (*ListSavedQueriesRequest) Reset

func (x *ListSavedQueriesRequest) Reset()

func (*ListSavedQueriesRequest) String

func (x *ListSavedQueriesRequest) String() string

type ListSavedQueriesResponse

type ListSavedQueriesResponse struct {

	// A list of SavedQueries that match the specified filter in the request.
	SavedQueries []*SavedQuery `protobuf:"bytes,1,rep,name=saved_queries,json=savedQueries,proto3" json:"saved_queries,omitempty"`
	// The standard List next-page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries].

func (*ListSavedQueriesResponse) Descriptor deprecated

func (*ListSavedQueriesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSavedQueriesResponse.ProtoReflect.Descriptor instead.

func (*ListSavedQueriesResponse) GetNextPageToken

func (x *ListSavedQueriesResponse) GetNextPageToken() string

func (*ListSavedQueriesResponse) GetSavedQueries

func (x *ListSavedQueriesResponse) GetSavedQueries() []*SavedQuery

func (*ListSavedQueriesResponse) ProtoMessage

func (*ListSavedQueriesResponse) ProtoMessage()

func (*ListSavedQueriesResponse) ProtoReflect

func (x *ListSavedQueriesResponse) ProtoReflect() protoreflect.Message

func (*ListSavedQueriesResponse) Reset

func (x *ListSavedQueriesResponse) Reset()

func (*ListSavedQueriesResponse) String

func (x *ListSavedQueriesResponse) String() string

type ListSchedulesRequest added in v1.47.0

type ListSchedulesRequest struct {

	// Required. The resource name of the Location to list the Schedules from.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the Schedules that match the filter expression. The following
	// fields are supported:
	//
	//   - `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard.
	//   - `state`: Supports `=` and `!=` comparisons.
	//   - `request`: Supports existence of the <request_type> check.
	//     (e.g. `create_pipeline_job_request:*` --> Schedule has
	//     create_pipeline_job_request).
	//   - `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
	//     Values must be in RFC 3339 format.
	//   - `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
	//     Values must be in RFC 3339 format.
	//   - `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*`
	//     existence check. Values must be in RFC 3339 format.
	//   - `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=`
	//     comparisons. Values must be in RFC 3339 format.
	//
	// Filter expressions can be combined together using logical operators
	// (`NOT`, `AND` & `OR`).
	// The syntax to define filter expression is based on
	// https://google.aip.dev/160.
	//
	// Examples:
	//
	// * `state="ACTIVE" AND display_name:"my_schedule_*"`
	// * `NOT display_name="my_schedule"`
	// * `create_time>"2021-05-18T00:00:00Z"`
	// * `end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*`
	// * `create_pipeline_job_request:*`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	// Default to 100 if not specified.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [ListSchedulesResponse.next_page_token][google.cloud.aiplatform.v1.ListSchedulesResponse.next_page_token]
	// of the previous
	// [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A comma-separated list of fields to order by. The default sort order is in
	// ascending order. Use "desc" after a field name for descending. You can have
	// multiple order_by fields provided.
	//
	// For example, using "create_time desc, end_time" will order results by
	// create time in descending order, and if there are multiple schedules having
	// the same create time, order them by the end time in ascending order.
	//
	// If order_by is not specified, it will order by default with create_time in
	// descending order.
	//
	// Supported fields:
	//
	//   - `create_time`
	//   - `start_time`
	//   - `end_time`
	//   - `next_run_time`
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules].

func (*ListSchedulesRequest) Descriptor deprecated added in v1.47.0

func (*ListSchedulesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSchedulesRequest.ProtoReflect.Descriptor instead.

func (*ListSchedulesRequest) GetFilter added in v1.47.0

func (x *ListSchedulesRequest) GetFilter() string

func (*ListSchedulesRequest) GetOrderBy added in v1.47.0

func (x *ListSchedulesRequest) GetOrderBy() string

func (*ListSchedulesRequest) GetPageSize added in v1.47.0

func (x *ListSchedulesRequest) GetPageSize() int32

func (*ListSchedulesRequest) GetPageToken added in v1.47.0

func (x *ListSchedulesRequest) GetPageToken() string

func (*ListSchedulesRequest) GetParent added in v1.47.0

func (x *ListSchedulesRequest) GetParent() string

func (*ListSchedulesRequest) ProtoMessage added in v1.47.0

func (*ListSchedulesRequest) ProtoMessage()

func (*ListSchedulesRequest) ProtoReflect added in v1.47.0

func (x *ListSchedulesRequest) ProtoReflect() protoreflect.Message

func (*ListSchedulesRequest) Reset added in v1.47.0

func (x *ListSchedulesRequest) Reset()

func (*ListSchedulesRequest) String added in v1.47.0

func (x *ListSchedulesRequest) String() string

type ListSchedulesResponse added in v1.47.0

type ListSchedulesResponse struct {

	// List of Schedules in the requested page.
	Schedules []*Schedule `protobuf:"bytes,1,rep,name=schedules,proto3" json:"schedules,omitempty"`
	// A token to retrieve the next page of results.
	// Pass to
	// [ListSchedulesRequest.page_token][google.cloud.aiplatform.v1.ListSchedulesRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules]

func (*ListSchedulesResponse) Descriptor deprecated added in v1.47.0

func (*ListSchedulesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSchedulesResponse.ProtoReflect.Descriptor instead.

func (*ListSchedulesResponse) GetNextPageToken added in v1.47.0

func (x *ListSchedulesResponse) GetNextPageToken() string

func (*ListSchedulesResponse) GetSchedules added in v1.47.0

func (x *ListSchedulesResponse) GetSchedules() []*Schedule

func (*ListSchedulesResponse) ProtoMessage added in v1.47.0

func (*ListSchedulesResponse) ProtoMessage()

func (*ListSchedulesResponse) ProtoReflect added in v1.47.0

func (x *ListSchedulesResponse) ProtoReflect() protoreflect.Message

func (*ListSchedulesResponse) Reset added in v1.47.0

func (x *ListSchedulesResponse) Reset()

func (*ListSchedulesResponse) String added in v1.47.0

func (x *ListSchedulesResponse) String() string

type ListSpecialistPoolsRequest

type ListSpecialistPoolsRequest struct {

	// Required. The name of the SpecialistPool's parent resource.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained by
	// [ListSpecialistPoolsResponse.next_page_token][google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token]
	// of the previous
	// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools]
	// call. Return first page if empty.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read. FieldMask represents a set of
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools].

func (*ListSpecialistPoolsRequest) Descriptor deprecated

func (*ListSpecialistPoolsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSpecialistPoolsRequest.ProtoReflect.Descriptor instead.

func (*ListSpecialistPoolsRequest) GetPageSize

func (x *ListSpecialistPoolsRequest) GetPageSize() int32

func (*ListSpecialistPoolsRequest) GetPageToken

func (x *ListSpecialistPoolsRequest) GetPageToken() string

func (*ListSpecialistPoolsRequest) GetParent

func (x *ListSpecialistPoolsRequest) GetParent() string

func (*ListSpecialistPoolsRequest) GetReadMask

func (*ListSpecialistPoolsRequest) ProtoMessage

func (*ListSpecialistPoolsRequest) ProtoMessage()

func (*ListSpecialistPoolsRequest) ProtoReflect

func (*ListSpecialistPoolsRequest) Reset

func (x *ListSpecialistPoolsRequest) Reset()

func (*ListSpecialistPoolsRequest) String

func (x *ListSpecialistPoolsRequest) String() string

type ListSpecialistPoolsResponse

type ListSpecialistPoolsResponse struct {

	// A list of SpecialistPools that matches the specified filter in the request.
	SpecialistPools []*SpecialistPool `protobuf:"bytes,1,rep,name=specialist_pools,json=specialistPools,proto3" json:"specialist_pools,omitempty"`
	// The standard List next-page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools].

func (*ListSpecialistPoolsResponse) Descriptor deprecated

func (*ListSpecialistPoolsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSpecialistPoolsResponse.ProtoReflect.Descriptor instead.

func (*ListSpecialistPoolsResponse) GetNextPageToken

func (x *ListSpecialistPoolsResponse) GetNextPageToken() string

func (*ListSpecialistPoolsResponse) GetSpecialistPools

func (x *ListSpecialistPoolsResponse) GetSpecialistPools() []*SpecialistPool

func (*ListSpecialistPoolsResponse) ProtoMessage

func (*ListSpecialistPoolsResponse) ProtoMessage()

func (*ListSpecialistPoolsResponse) ProtoReflect

func (*ListSpecialistPoolsResponse) Reset

func (x *ListSpecialistPoolsResponse) Reset()

func (*ListSpecialistPoolsResponse) String

func (x *ListSpecialistPoolsResponse) String() string

type ListStudiesRequest

type ListStudiesRequest struct {

	// Required. The resource name of the Location to list the Study from.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. A page token to request the next page of results.
	// If unspecified, there are no subsequent pages.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. The maximum number of studies to return per "page" of results.
	// If unspecified, service will pick an appropriate default.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies].

func (*ListStudiesRequest) Descriptor deprecated

func (*ListStudiesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListStudiesRequest.ProtoReflect.Descriptor instead.

func (*ListStudiesRequest) GetPageSize

func (x *ListStudiesRequest) GetPageSize() int32

func (*ListStudiesRequest) GetPageToken

func (x *ListStudiesRequest) GetPageToken() string

func (*ListStudiesRequest) GetParent

func (x *ListStudiesRequest) GetParent() string

func (*ListStudiesRequest) ProtoMessage

func (*ListStudiesRequest) ProtoMessage()

func (*ListStudiesRequest) ProtoReflect

func (x *ListStudiesRequest) ProtoReflect() protoreflect.Message

func (*ListStudiesRequest) Reset

func (x *ListStudiesRequest) Reset()

func (*ListStudiesRequest) String

func (x *ListStudiesRequest) String() string

type ListStudiesResponse

type ListStudiesResponse struct {

	// The studies associated with the project.
	Studies []*Study `protobuf:"bytes,1,rep,name=studies,proto3" json:"studies,omitempty"`
	// Passes this token as the `page_token` field of the request for a
	// subsequent call.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies].

func (*ListStudiesResponse) Descriptor deprecated

func (*ListStudiesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListStudiesResponse.ProtoReflect.Descriptor instead.

func (*ListStudiesResponse) GetNextPageToken

func (x *ListStudiesResponse) GetNextPageToken() string

func (*ListStudiesResponse) GetStudies

func (x *ListStudiesResponse) GetStudies() []*Study

func (*ListStudiesResponse) ProtoMessage

func (*ListStudiesResponse) ProtoMessage()

func (*ListStudiesResponse) ProtoReflect

func (x *ListStudiesResponse) ProtoReflect() protoreflect.Message

func (*ListStudiesResponse) Reset

func (x *ListStudiesResponse) Reset()

func (*ListStudiesResponse) String

func (x *ListStudiesResponse) String() string

type ListTensorboardExperimentsRequest

type ListTensorboardExperimentsRequest struct {

	// Required. The resource name of the Tensorboard to list
	// TensorboardExperiments. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the TensorboardExperiments that match the filter expression.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of TensorboardExperiments to return. The service may
	// return fewer than this value. If unspecified, at most 50
	// TensorboardExperiments are returned. The maximum value is 1000; values
	// above 1000 are coerced to 1000.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Field to use to sort the list.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments].

func (*ListTensorboardExperimentsRequest) Descriptor deprecated

func (*ListTensorboardExperimentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListTensorboardExperimentsRequest.ProtoReflect.Descriptor instead.

func (*ListTensorboardExperimentsRequest) GetFilter

func (*ListTensorboardExperimentsRequest) GetOrderBy

func (x *ListTensorboardExperimentsRequest) GetOrderBy() string

func (*ListTensorboardExperimentsRequest) GetPageSize

func (x *ListTensorboardExperimentsRequest) GetPageSize() int32

func (*ListTensorboardExperimentsRequest) GetPageToken

func (x *ListTensorboardExperimentsRequest) GetPageToken() string

func (*ListTensorboardExperimentsRequest) GetParent

func (*ListTensorboardExperimentsRequest) GetReadMask

func (*ListTensorboardExperimentsRequest) ProtoMessage

func (*ListTensorboardExperimentsRequest) ProtoMessage()

func (*ListTensorboardExperimentsRequest) ProtoReflect

func (*ListTensorboardExperimentsRequest) Reset

func (*ListTensorboardExperimentsRequest) String

type ListTensorboardExperimentsResponse

type ListTensorboardExperimentsResponse struct {

	// The TensorboardExperiments mathching the request.
	TensorboardExperiments []*TensorboardExperiment `` /* 127-byte string literal not displayed */
	// A token, which can be sent as
	// [ListTensorboardExperimentsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardExperimentsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments].

func (*ListTensorboardExperimentsResponse) Descriptor deprecated

func (*ListTensorboardExperimentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListTensorboardExperimentsResponse.ProtoReflect.Descriptor instead.

func (*ListTensorboardExperimentsResponse) GetNextPageToken

func (x *ListTensorboardExperimentsResponse) GetNextPageToken() string

func (*ListTensorboardExperimentsResponse) GetTensorboardExperiments

func (x *ListTensorboardExperimentsResponse) GetTensorboardExperiments() []*TensorboardExperiment

func (*ListTensorboardExperimentsResponse) ProtoMessage

func (*ListTensorboardExperimentsResponse) ProtoMessage()

func (*ListTensorboardExperimentsResponse) ProtoReflect

func (*ListTensorboardExperimentsResponse) Reset

func (*ListTensorboardExperimentsResponse) String

type ListTensorboardRunsRequest

type ListTensorboardRunsRequest struct {

	// Required. The resource name of the TensorboardExperiment to list
	// TensorboardRuns. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the TensorboardRuns that match the filter expression.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of TensorboardRuns to return. The service may return
	// fewer than this value. If unspecified, at most 50 TensorboardRuns are
	// returned. The maximum value is 1000; values above 1000 are coerced to
	// 1000.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Field to use to sort the list.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns].

func (*ListTensorboardRunsRequest) Descriptor deprecated

func (*ListTensorboardRunsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListTensorboardRunsRequest.ProtoReflect.Descriptor instead.

func (*ListTensorboardRunsRequest) GetFilter

func (x *ListTensorboardRunsRequest) GetFilter() string

func (*ListTensorboardRunsRequest) GetOrderBy

func (x *ListTensorboardRunsRequest) GetOrderBy() string

func (*ListTensorboardRunsRequest) GetPageSize

func (x *ListTensorboardRunsRequest) GetPageSize() int32

func (*ListTensorboardRunsRequest) GetPageToken

func (x *ListTensorboardRunsRequest) GetPageToken() string

func (*ListTensorboardRunsRequest) GetParent

func (x *ListTensorboardRunsRequest) GetParent() string

func (*ListTensorboardRunsRequest) GetReadMask

func (*ListTensorboardRunsRequest) ProtoMessage

func (*ListTensorboardRunsRequest) ProtoMessage()

func (*ListTensorboardRunsRequest) ProtoReflect

func (*ListTensorboardRunsRequest) Reset

func (x *ListTensorboardRunsRequest) Reset()

func (*ListTensorboardRunsRequest) String

func (x *ListTensorboardRunsRequest) String() string

type ListTensorboardRunsResponse

type ListTensorboardRunsResponse struct {

	// The TensorboardRuns mathching the request.
	TensorboardRuns []*TensorboardRun `protobuf:"bytes,1,rep,name=tensorboard_runs,json=tensorboardRuns,proto3" json:"tensorboard_runs,omitempty"`
	// A token, which can be sent as
	// [ListTensorboardRunsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardRunsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns].

func (*ListTensorboardRunsResponse) Descriptor deprecated

func (*ListTensorboardRunsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListTensorboardRunsResponse.ProtoReflect.Descriptor instead.

func (*ListTensorboardRunsResponse) GetNextPageToken

func (x *ListTensorboardRunsResponse) GetNextPageToken() string

func (*ListTensorboardRunsResponse) GetTensorboardRuns

func (x *ListTensorboardRunsResponse) GetTensorboardRuns() []*TensorboardRun

func (*ListTensorboardRunsResponse) ProtoMessage

func (*ListTensorboardRunsResponse) ProtoMessage()

func (*ListTensorboardRunsResponse) ProtoReflect

func (*ListTensorboardRunsResponse) Reset

func (x *ListTensorboardRunsResponse) Reset()

func (*ListTensorboardRunsResponse) String

func (x *ListTensorboardRunsResponse) String() string

type ListTensorboardTimeSeriesRequest

type ListTensorboardTimeSeriesRequest struct {

	// Required. The resource name of the TensorboardRun to list
	// TensorboardTimeSeries. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the TensorboardTimeSeries that match the filter expression.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of TensorboardTimeSeries to return. The service may
	// return fewer than this value. If unspecified, at most 50
	// TensorboardTimeSeries are returned. The maximum value is 1000; values
	// above 1000 are coerced to 1000.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Field to use to sort the list.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries].

func (*ListTensorboardTimeSeriesRequest) Descriptor deprecated

func (*ListTensorboardTimeSeriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListTensorboardTimeSeriesRequest.ProtoReflect.Descriptor instead.

func (*ListTensorboardTimeSeriesRequest) GetFilter

func (*ListTensorboardTimeSeriesRequest) GetOrderBy

func (x *ListTensorboardTimeSeriesRequest) GetOrderBy() string

func (*ListTensorboardTimeSeriesRequest) GetPageSize

func (x *ListTensorboardTimeSeriesRequest) GetPageSize() int32

func (*ListTensorboardTimeSeriesRequest) GetPageToken

func (x *ListTensorboardTimeSeriesRequest) GetPageToken() string

func (*ListTensorboardTimeSeriesRequest) GetParent

func (*ListTensorboardTimeSeriesRequest) GetReadMask

func (*ListTensorboardTimeSeriesRequest) ProtoMessage

func (*ListTensorboardTimeSeriesRequest) ProtoMessage()

func (*ListTensorboardTimeSeriesRequest) ProtoReflect

func (*ListTensorboardTimeSeriesRequest) Reset

func (*ListTensorboardTimeSeriesRequest) String

type ListTensorboardTimeSeriesResponse

type ListTensorboardTimeSeriesResponse struct {

	// The TensorboardTimeSeries mathching the request.
	TensorboardTimeSeries []*TensorboardTimeSeries `` /* 126-byte string literal not displayed */
	// A token, which can be sent as
	// [ListTensorboardTimeSeriesRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardTimeSeriesRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries].

func (*ListTensorboardTimeSeriesResponse) Descriptor deprecated

func (*ListTensorboardTimeSeriesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListTensorboardTimeSeriesResponse.ProtoReflect.Descriptor instead.

func (*ListTensorboardTimeSeriesResponse) GetNextPageToken

func (x *ListTensorboardTimeSeriesResponse) GetNextPageToken() string

func (*ListTensorboardTimeSeriesResponse) GetTensorboardTimeSeries

func (x *ListTensorboardTimeSeriesResponse) GetTensorboardTimeSeries() []*TensorboardTimeSeries

func (*ListTensorboardTimeSeriesResponse) ProtoMessage

func (*ListTensorboardTimeSeriesResponse) ProtoMessage()

func (*ListTensorboardTimeSeriesResponse) ProtoReflect

func (*ListTensorboardTimeSeriesResponse) Reset

func (*ListTensorboardTimeSeriesResponse) String

type ListTensorboardsRequest

type ListTensorboardsRequest struct {

	// Required. The resource name of the Location to list Tensorboards.
	// Format:
	// `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Lists the Tensorboards that match the filter expression.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of Tensorboards to return. The service may return
	// fewer than this value. If unspecified, at most 100 Tensorboards are
	// returned. The maximum value is 100; values above 100 are coerced to
	// 100.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Field to use to sort the list.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards].

func (*ListTensorboardsRequest) Descriptor deprecated

func (*ListTensorboardsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListTensorboardsRequest.ProtoReflect.Descriptor instead.

func (*ListTensorboardsRequest) GetFilter

func (x *ListTensorboardsRequest) GetFilter() string

func (*ListTensorboardsRequest) GetOrderBy

func (x *ListTensorboardsRequest) GetOrderBy() string

func (*ListTensorboardsRequest) GetPageSize

func (x *ListTensorboardsRequest) GetPageSize() int32

func (*ListTensorboardsRequest) GetPageToken

func (x *ListTensorboardsRequest) GetPageToken() string

func (*ListTensorboardsRequest) GetParent

func (x *ListTensorboardsRequest) GetParent() string

func (*ListTensorboardsRequest) GetReadMask

func (x *ListTensorboardsRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListTensorboardsRequest) ProtoMessage

func (*ListTensorboardsRequest) ProtoMessage()

func (*ListTensorboardsRequest) ProtoReflect

func (x *ListTensorboardsRequest) ProtoReflect() protoreflect.Message

func (*ListTensorboardsRequest) Reset

func (x *ListTensorboardsRequest) Reset()

func (*ListTensorboardsRequest) String

func (x *ListTensorboardsRequest) String() string

type ListTensorboardsResponse

type ListTensorboardsResponse struct {

	// The Tensorboards mathching the request.
	Tensorboards []*Tensorboard `protobuf:"bytes,1,rep,name=tensorboards,proto3" json:"tensorboards,omitempty"`
	// A token, which can be sent as
	// [ListTensorboardsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards].

func (*ListTensorboardsResponse) Descriptor deprecated

func (*ListTensorboardsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListTensorboardsResponse.ProtoReflect.Descriptor instead.

func (*ListTensorboardsResponse) GetNextPageToken

func (x *ListTensorboardsResponse) GetNextPageToken() string

func (*ListTensorboardsResponse) GetTensorboards

func (x *ListTensorboardsResponse) GetTensorboards() []*Tensorboard

func (*ListTensorboardsResponse) ProtoMessage

func (*ListTensorboardsResponse) ProtoMessage()

func (*ListTensorboardsResponse) ProtoReflect

func (x *ListTensorboardsResponse) ProtoReflect() protoreflect.Message

func (*ListTensorboardsResponse) Reset

func (x *ListTensorboardsResponse) Reset()

func (*ListTensorboardsResponse) String

func (x *ListTensorboardsResponse) String() string

type ListTrainingPipelinesRequest

type ListTrainingPipelinesRequest struct {

	// Required. The resource name of the Location to list the TrainingPipelines
	// from. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list filter.
	//
	// Supported fields:
	//
	//   - `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
	//   - `state` supports `=`, `!=` comparisons.
	//   - `training_task_definition` `=`, `!=` comparisons, and `:` wildcard.
	//   - `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
	//     `create_time` must be in RFC 3339 format.
	//   - `labels` supports general map functions that is:
	//     `labels.key=value` - key:value equality
	//     `labels.key:* - key existence
	//
	// Some examples of using the filter are:
	//
	//   - `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"`
	//   - `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"`
	//   - `NOT display_name="my_pipeline"`
	//   - `create_time>"2021-05-18T00:00:00Z"`
	//   - `training_task_definition:"*automl_text_classification*"`
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	// Typically obtained via
	// [ListTrainingPipelinesResponse.next_page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token]
	// of the previous
	// [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines]
	// call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Mask specifying which fields to read.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines].

func (*ListTrainingPipelinesRequest) Descriptor deprecated

func (*ListTrainingPipelinesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListTrainingPipelinesRequest.ProtoReflect.Descriptor instead.

func (*ListTrainingPipelinesRequest) GetFilter

func (x *ListTrainingPipelinesRequest) GetFilter() string

func (*ListTrainingPipelinesRequest) GetPageSize

func (x *ListTrainingPipelinesRequest) GetPageSize() int32

func (*ListTrainingPipelinesRequest) GetPageToken

func (x *ListTrainingPipelinesRequest) GetPageToken() string

func (*ListTrainingPipelinesRequest) GetParent

func (x *ListTrainingPipelinesRequest) GetParent() string

func (*ListTrainingPipelinesRequest) GetReadMask

func (*ListTrainingPipelinesRequest) ProtoMessage

func (*ListTrainingPipelinesRequest) ProtoMessage()

func (*ListTrainingPipelinesRequest) ProtoReflect

func (*ListTrainingPipelinesRequest) Reset

func (x *ListTrainingPipelinesRequest) Reset()

func (*ListTrainingPipelinesRequest) String

type ListTrainingPipelinesResponse

type ListTrainingPipelinesResponse struct {

	// List of TrainingPipelines in the requested page.
	TrainingPipelines []*TrainingPipeline `protobuf:"bytes,1,rep,name=training_pipelines,json=trainingPipelines,proto3" json:"training_pipelines,omitempty"`
	// A token to retrieve the next page of results.
	// Pass to
	// [ListTrainingPipelinesRequest.page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines]

func (*ListTrainingPipelinesResponse) Descriptor deprecated

func (*ListTrainingPipelinesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListTrainingPipelinesResponse.ProtoReflect.Descriptor instead.

func (*ListTrainingPipelinesResponse) GetNextPageToken

func (x *ListTrainingPipelinesResponse) GetNextPageToken() string

func (*ListTrainingPipelinesResponse) GetTrainingPipelines

func (x *ListTrainingPipelinesResponse) GetTrainingPipelines() []*TrainingPipeline

func (*ListTrainingPipelinesResponse) ProtoMessage

func (*ListTrainingPipelinesResponse) ProtoMessage()

func (*ListTrainingPipelinesResponse) ProtoReflect

func (*ListTrainingPipelinesResponse) Reset

func (x *ListTrainingPipelinesResponse) Reset()

func (*ListTrainingPipelinesResponse) String

type ListTrialsRequest

type ListTrialsRequest struct {

	// Required. The resource name of the Study to list the Trial from.
	// Format: `projects/{project}/locations/{location}/studies/{study}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. A page token to request the next page of results.
	// If unspecified, there are no subsequent pages.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. The number of Trials to retrieve per "page" of results.
	// If unspecified, the service will pick an appropriate default.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials].

func (*ListTrialsRequest) Descriptor deprecated

func (*ListTrialsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListTrialsRequest.ProtoReflect.Descriptor instead.

func (*ListTrialsRequest) GetPageSize

func (x *ListTrialsRequest) GetPageSize() int32

func (*ListTrialsRequest) GetPageToken

func (x *ListTrialsRequest) GetPageToken() string

func (*ListTrialsRequest) GetParent

func (x *ListTrialsRequest) GetParent() string

func (*ListTrialsRequest) ProtoMessage

func (*ListTrialsRequest) ProtoMessage()

func (*ListTrialsRequest) ProtoReflect

func (x *ListTrialsRequest) ProtoReflect() protoreflect.Message

func (*ListTrialsRequest) Reset

func (x *ListTrialsRequest) Reset()

func (*ListTrialsRequest) String

func (x *ListTrialsRequest) String() string

type ListTrialsResponse

type ListTrialsResponse struct {

	// The Trials associated with the Study.
	Trials []*Trial `protobuf:"bytes,1,rep,name=trials,proto3" json:"trials,omitempty"`
	// Pass this token as the `page_token` field of the request for a
	// subsequent call.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials].

func (*ListTrialsResponse) Descriptor deprecated

func (*ListTrialsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListTrialsResponse.ProtoReflect.Descriptor instead.

func (*ListTrialsResponse) GetNextPageToken

func (x *ListTrialsResponse) GetNextPageToken() string

func (*ListTrialsResponse) GetTrials

func (x *ListTrialsResponse) GetTrials() []*Trial

func (*ListTrialsResponse) ProtoMessage

func (*ListTrialsResponse) ProtoMessage()

func (*ListTrialsResponse) ProtoReflect

func (x *ListTrialsResponse) ProtoReflect() protoreflect.Message

func (*ListTrialsResponse) Reset

func (x *ListTrialsResponse) Reset()

func (*ListTrialsResponse) String

func (x *ListTrialsResponse) String() string

type ListTuningJobsRequest added in v1.67.0

type ListTuningJobsRequest struct {

	// Required. The resource name of the Location to list the TuningJobs from.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The standard list filter.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. The standard list page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The standard list page token.
	// Typically obtained via [ListTuningJob.next_page_token][] of the
	// previous GenAiTuningService.ListTuningJob][] call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [GenAiTuningService.ListTuningJobs][google.cloud.aiplatform.v1.GenAiTuningService.ListTuningJobs].

func (*ListTuningJobsRequest) Descriptor deprecated added in v1.67.0

func (*ListTuningJobsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListTuningJobsRequest.ProtoReflect.Descriptor instead.

func (*ListTuningJobsRequest) GetFilter added in v1.67.0

func (x *ListTuningJobsRequest) GetFilter() string

func (*ListTuningJobsRequest) GetPageSize added in v1.67.0

func (x *ListTuningJobsRequest) GetPageSize() int32

func (*ListTuningJobsRequest) GetPageToken added in v1.67.0

func (x *ListTuningJobsRequest) GetPageToken() string

func (*ListTuningJobsRequest) GetParent added in v1.67.0

func (x *ListTuningJobsRequest) GetParent() string

func (*ListTuningJobsRequest) ProtoMessage added in v1.67.0

func (*ListTuningJobsRequest) ProtoMessage()

func (*ListTuningJobsRequest) ProtoReflect added in v1.67.0

func (x *ListTuningJobsRequest) ProtoReflect() protoreflect.Message

func (*ListTuningJobsRequest) Reset added in v1.67.0

func (x *ListTuningJobsRequest) Reset()

func (*ListTuningJobsRequest) String added in v1.67.0

func (x *ListTuningJobsRequest) String() string

type ListTuningJobsResponse added in v1.67.0

type ListTuningJobsResponse struct {

	// List of TuningJobs in the requested page.
	TuningJobs []*TuningJob `protobuf:"bytes,1,rep,name=tuning_jobs,json=tuningJobs,proto3" json:"tuning_jobs,omitempty"`
	// A token to retrieve the next page of results.
	// Pass to
	// [ListTuningJobsRequest.page_token][google.cloud.aiplatform.v1.ListTuningJobsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [GenAiTuningService.ListTuningJobs][google.cloud.aiplatform.v1.GenAiTuningService.ListTuningJobs]

func (*ListTuningJobsResponse) Descriptor deprecated added in v1.67.0

func (*ListTuningJobsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListTuningJobsResponse.ProtoReflect.Descriptor instead.

func (*ListTuningJobsResponse) GetNextPageToken added in v1.67.0

func (x *ListTuningJobsResponse) GetNextPageToken() string

func (*ListTuningJobsResponse) GetTuningJobs added in v1.67.0

func (x *ListTuningJobsResponse) GetTuningJobs() []*TuningJob

func (*ListTuningJobsResponse) ProtoMessage added in v1.67.0

func (*ListTuningJobsResponse) ProtoMessage()

func (*ListTuningJobsResponse) ProtoReflect added in v1.67.0

func (x *ListTuningJobsResponse) ProtoReflect() protoreflect.Message

func (*ListTuningJobsResponse) Reset added in v1.67.0

func (x *ListTuningJobsResponse) Reset()

func (*ListTuningJobsResponse) String added in v1.67.0

func (x *ListTuningJobsResponse) String() string

type LlmUtilityServiceClient added in v1.54.0

type LlmUtilityServiceClient interface {
	// Perform a token counting.
	CountTokens(ctx context.Context, in *CountTokensRequest, opts ...grpc.CallOption) (*CountTokensResponse, error)
	// Return a list of tokens based on the input text.
	ComputeTokens(ctx context.Context, in *ComputeTokensRequest, opts ...grpc.CallOption) (*ComputeTokensResponse, error)
}

LlmUtilityServiceClient is the client API for LlmUtilityService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewLlmUtilityServiceClient added in v1.54.0

func NewLlmUtilityServiceClient(cc grpc.ClientConnInterface) LlmUtilityServiceClient

type LlmUtilityServiceServer added in v1.54.0

type LlmUtilityServiceServer interface {
	// Perform a token counting.
	CountTokens(context.Context, *CountTokensRequest) (*CountTokensResponse, error)
	// Return a list of tokens based on the input text.
	ComputeTokens(context.Context, *ComputeTokensRequest) (*ComputeTokensResponse, error)
}

LlmUtilityServiceServer is the server API for LlmUtilityService service.

type LookupStudyRequest

type LookupStudyRequest struct {

	// Required. The resource name of the Location to get the Study from.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The user-defined display name of the Study
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.LookupStudy][google.cloud.aiplatform.v1.VizierService.LookupStudy].

func (*LookupStudyRequest) Descriptor deprecated

func (*LookupStudyRequest) Descriptor() ([]byte, []int)

Deprecated: Use LookupStudyRequest.ProtoReflect.Descriptor instead.

func (*LookupStudyRequest) GetDisplayName

func (x *LookupStudyRequest) GetDisplayName() string

func (*LookupStudyRequest) GetParent

func (x *LookupStudyRequest) GetParent() string

func (*LookupStudyRequest) ProtoMessage

func (*LookupStudyRequest) ProtoMessage()

func (*LookupStudyRequest) ProtoReflect

func (x *LookupStudyRequest) ProtoReflect() protoreflect.Message

func (*LookupStudyRequest) Reset

func (x *LookupStudyRequest) Reset()

func (*LookupStudyRequest) String

func (x *LookupStudyRequest) String() string

type MachineSpec

type MachineSpec struct {

	// Immutable. The type of the machine.
	//
	// See the [list of machine types supported for
	// prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types)
	//
	// See the [list of machine types supported for custom
	// training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types).
	//
	// For [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] this field is
	// optional, and the default value is `n1-standard-2`. For
	// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] or as
	// part of [WorkerPoolSpec][google.cloud.aiplatform.v1.WorkerPoolSpec] this
	// field is required.
	MachineType string `protobuf:"bytes,1,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
	// Immutable. The type of accelerator(s) that may be attached to the machine
	// as per
	// [accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count].
	AcceleratorType AcceleratorType `` /* 155-byte string literal not displayed */
	// The number of accelerators to attach to the machine.
	AcceleratorCount int32 `protobuf:"varint,3,opt,name=accelerator_count,json=acceleratorCount,proto3" json:"accelerator_count,omitempty"`
	// Immutable. The topology of the TPUs. Corresponds to the TPU topologies
	// available from GKE. (Example: tpu_topology: "2x2x1").
	TpuTopology string `protobuf:"bytes,4,opt,name=tpu_topology,json=tpuTopology,proto3" json:"tpu_topology,omitempty"`
	// contains filtered or unexported fields
}

Specification of a single machine.

func (*MachineSpec) Descriptor deprecated

func (*MachineSpec) Descriptor() ([]byte, []int)

Deprecated: Use MachineSpec.ProtoReflect.Descriptor instead.

func (*MachineSpec) GetAcceleratorCount

func (x *MachineSpec) GetAcceleratorCount() int32

func (*MachineSpec) GetAcceleratorType

func (x *MachineSpec) GetAcceleratorType() AcceleratorType

func (*MachineSpec) GetMachineType

func (x *MachineSpec) GetMachineType() string

func (*MachineSpec) GetTpuTopology added in v1.54.0

func (x *MachineSpec) GetTpuTopology() string

func (*MachineSpec) ProtoMessage

func (*MachineSpec) ProtoMessage()

func (*MachineSpec) ProtoReflect

func (x *MachineSpec) ProtoReflect() protoreflect.Message

func (*MachineSpec) Reset

func (x *MachineSpec) Reset()

func (*MachineSpec) String

func (x *MachineSpec) String() string

type ManualBatchTuningParameters

type ManualBatchTuningParameters struct {

	// Immutable. The number of the records (e.g. instances) of the operation
	// given in each batch to a machine replica. Machine type, and size of a
	// single record should be considered when setting this parameter, higher
	// value speeds up the batch operation's execution, but too high value will
	// result in a whole batch not fitting in a machine's memory, and the whole
	// operation will fail.
	// The default value is 64.
	BatchSize int32 `protobuf:"varint,1,opt,name=batch_size,json=batchSize,proto3" json:"batch_size,omitempty"`
	// contains filtered or unexported fields
}

Manual batch tuning parameters.

func (*ManualBatchTuningParameters) Descriptor deprecated

func (*ManualBatchTuningParameters) Descriptor() ([]byte, []int)

Deprecated: Use ManualBatchTuningParameters.ProtoReflect.Descriptor instead.

func (*ManualBatchTuningParameters) GetBatchSize

func (x *ManualBatchTuningParameters) GetBatchSize() int32

func (*ManualBatchTuningParameters) ProtoMessage

func (*ManualBatchTuningParameters) ProtoMessage()

func (*ManualBatchTuningParameters) ProtoReflect

func (*ManualBatchTuningParameters) Reset

func (x *ManualBatchTuningParameters) Reset()

func (*ManualBatchTuningParameters) String

func (x *ManualBatchTuningParameters) String() string

type MatchServiceClient added in v1.43.0

type MatchServiceClient interface {
	// Finds the nearest neighbors of each vector within the request.
	FindNeighbors(ctx context.Context, in *FindNeighborsRequest, opts ...grpc.CallOption) (*FindNeighborsResponse, error)
	// Reads the datapoints/vectors of the given IDs.
	// A maximum of 1000 datapoints can be retrieved in a batch.
	ReadIndexDatapoints(ctx context.Context, in *ReadIndexDatapointsRequest, opts ...grpc.CallOption) (*ReadIndexDatapointsResponse, error)
}

MatchServiceClient is the client API for MatchService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewMatchServiceClient added in v1.43.0

func NewMatchServiceClient(cc grpc.ClientConnInterface) MatchServiceClient

type MatchServiceServer added in v1.43.0

type MatchServiceServer interface {
	// Finds the nearest neighbors of each vector within the request.
	FindNeighbors(context.Context, *FindNeighborsRequest) (*FindNeighborsResponse, error)
	// Reads the datapoints/vectors of the given IDs.
	// A maximum of 1000 datapoints can be retrieved in a batch.
	ReadIndexDatapoints(context.Context, *ReadIndexDatapointsRequest) (*ReadIndexDatapointsResponse, error)
}

MatchServiceServer is the server API for MatchService service.

type Measurement

type Measurement struct {

	// Output only. Time that the Trial has been running at the point of this
	// Measurement.
	ElapsedDuration *durationpb.Duration `protobuf:"bytes,1,opt,name=elapsed_duration,json=elapsedDuration,proto3" json:"elapsed_duration,omitempty"`
	// Output only. The number of steps the machine learning model has been
	// trained for. Must be non-negative.
	StepCount int64 `protobuf:"varint,2,opt,name=step_count,json=stepCount,proto3" json:"step_count,omitempty"`
	// Output only. A list of metrics got by evaluating the objective functions
	// using suggested Parameter values.
	Metrics []*Measurement_Metric `protobuf:"bytes,3,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// contains filtered or unexported fields
}

A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values.

func (*Measurement) Descriptor deprecated

func (*Measurement) Descriptor() ([]byte, []int)

Deprecated: Use Measurement.ProtoReflect.Descriptor instead.

func (*Measurement) GetElapsedDuration

func (x *Measurement) GetElapsedDuration() *durationpb.Duration

func (*Measurement) GetMetrics

func (x *Measurement) GetMetrics() []*Measurement_Metric

func (*Measurement) GetStepCount

func (x *Measurement) GetStepCount() int64

func (*Measurement) ProtoMessage

func (*Measurement) ProtoMessage()

func (*Measurement) ProtoReflect

func (x *Measurement) ProtoReflect() protoreflect.Message

func (*Measurement) Reset

func (x *Measurement) Reset()

func (*Measurement) String

func (x *Measurement) String() string

type Measurement_Metric

type Measurement_Metric struct {

	// Output only. The ID of the Metric. The Metric should be defined in
	// [StudySpec's Metrics][google.cloud.aiplatform.v1.StudySpec.metrics].
	MetricId string `protobuf:"bytes,1,opt,name=metric_id,json=metricId,proto3" json:"metric_id,omitempty"`
	// Output only. The value for this metric.
	Value float64 `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

A message representing a metric in the measurement.

func (*Measurement_Metric) Descriptor deprecated

func (*Measurement_Metric) Descriptor() ([]byte, []int)

Deprecated: Use Measurement_Metric.ProtoReflect.Descriptor instead.

func (*Measurement_Metric) GetMetricId

func (x *Measurement_Metric) GetMetricId() string

func (*Measurement_Metric) GetValue

func (x *Measurement_Metric) GetValue() float64

func (*Measurement_Metric) ProtoMessage

func (*Measurement_Metric) ProtoMessage()

func (*Measurement_Metric) ProtoReflect

func (x *Measurement_Metric) ProtoReflect() protoreflect.Message

func (*Measurement_Metric) Reset

func (x *Measurement_Metric) Reset()

func (*Measurement_Metric) String

func (x *Measurement_Metric) String() string

type MergeVersionAliasesRequest

type MergeVersionAliasesRequest struct {

	// Required. The name of the model version to merge aliases, with a version ID
	// explicitly included.
	//
	// Example: `projects/{project}/locations/{location}/models/{model}@1234`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The set of version aliases to merge.
	// The alias should be at most 128 characters, and match
	// `[a-z][a-zA-Z0-9-]{0,126}[a-z-0-9]`.
	// Add the `-` prefix to an alias means removing that alias from the version.
	// `-` is NOT counted in the 128 characters. Example: `-golden` means removing
	// the `golden` alias from the version.
	//
	// There is NO ordering in aliases, which means
	// 1) The aliases returned from GetModel API might not have the exactly same
	// order from this MergeVersionAliases API. 2) Adding and deleting the same
	// alias in the request is not recommended, and the 2 operations will be
	// cancelled out.
	VersionAliases []string `protobuf:"bytes,2,rep,name=version_aliases,json=versionAliases,proto3" json:"version_aliases,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.MergeVersionAliases][google.cloud.aiplatform.v1.ModelService.MergeVersionAliases].

func (*MergeVersionAliasesRequest) Descriptor deprecated

func (*MergeVersionAliasesRequest) Descriptor() ([]byte, []int)

Deprecated: Use MergeVersionAliasesRequest.ProtoReflect.Descriptor instead.

func (*MergeVersionAliasesRequest) GetName

func (x *MergeVersionAliasesRequest) GetName() string

func (*MergeVersionAliasesRequest) GetVersionAliases

func (x *MergeVersionAliasesRequest) GetVersionAliases() []string

func (*MergeVersionAliasesRequest) ProtoMessage

func (*MergeVersionAliasesRequest) ProtoMessage()

func (*MergeVersionAliasesRequest) ProtoReflect

func (*MergeVersionAliasesRequest) Reset

func (x *MergeVersionAliasesRequest) Reset()

func (*MergeVersionAliasesRequest) String

func (x *MergeVersionAliasesRequest) String() string

type MetadataSchema

type MetadataSchema struct {

	// Output only. The resource name of the MetadataSchema.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The version of the MetadataSchema. The version's format must match
	// the following regular expression: `^[0-9]+[.][0-9]+[.][0-9]+$`, which would
	// allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
	SchemaVersion string `protobuf:"bytes,2,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`
	// Required. The raw YAML string representation of the MetadataSchema. The
	// combination of [MetadataSchema.version] and the schema name given by
	// `title` in [MetadataSchema.schema] must be unique within a MetadataStore.
	//
	// The schema is defined as an OpenAPI 3.0.2
	// [MetadataSchema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)
	Schema string `protobuf:"bytes,3,opt,name=schema,proto3" json:"schema,omitempty"`
	// The type of the MetadataSchema. This is a property that identifies which
	// metadata types will use the MetadataSchema.
	SchemaType MetadataSchema_MetadataSchemaType `` /* 158-byte string literal not displayed */
	// Output only. Timestamp when this MetadataSchema was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Description of the Metadata Schema
	Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Instance of a general MetadataSchema.

func (*MetadataSchema) Descriptor deprecated

func (*MetadataSchema) Descriptor() ([]byte, []int)

Deprecated: Use MetadataSchema.ProtoReflect.Descriptor instead.

func (*MetadataSchema) GetCreateTime

func (x *MetadataSchema) GetCreateTime() *timestamppb.Timestamp

func (*MetadataSchema) GetDescription

func (x *MetadataSchema) GetDescription() string

func (*MetadataSchema) GetName

func (x *MetadataSchema) GetName() string

func (*MetadataSchema) GetSchema

func (x *MetadataSchema) GetSchema() string

func (*MetadataSchema) GetSchemaType

func (*MetadataSchema) GetSchemaVersion

func (x *MetadataSchema) GetSchemaVersion() string

func (*MetadataSchema) ProtoMessage

func (*MetadataSchema) ProtoMessage()

func (*MetadataSchema) ProtoReflect

func (x *MetadataSchema) ProtoReflect() protoreflect.Message

func (*MetadataSchema) Reset

func (x *MetadataSchema) Reset()

func (*MetadataSchema) String

func (x *MetadataSchema) String() string

type MetadataSchema_MetadataSchemaType

type MetadataSchema_MetadataSchemaType int32

Describes the type of the MetadataSchema.

const (
	// Unspecified type for the MetadataSchema.
	MetadataSchema_METADATA_SCHEMA_TYPE_UNSPECIFIED MetadataSchema_MetadataSchemaType = 0
	// A type indicating that the MetadataSchema will be used by Artifacts.
	MetadataSchema_ARTIFACT_TYPE MetadataSchema_MetadataSchemaType = 1
	// A typee indicating that the MetadataSchema will be used by Executions.
	MetadataSchema_EXECUTION_TYPE MetadataSchema_MetadataSchemaType = 2
	// A state indicating that the MetadataSchema will be used by Contexts.
	MetadataSchema_CONTEXT_TYPE MetadataSchema_MetadataSchemaType = 3
)

func (MetadataSchema_MetadataSchemaType) Descriptor

func (MetadataSchema_MetadataSchemaType) Enum

func (MetadataSchema_MetadataSchemaType) EnumDescriptor deprecated

func (MetadataSchema_MetadataSchemaType) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetadataSchema_MetadataSchemaType.Descriptor instead.

func (MetadataSchema_MetadataSchemaType) Number

func (MetadataSchema_MetadataSchemaType) String

func (MetadataSchema_MetadataSchemaType) Type

type MetadataServiceClient

type MetadataServiceClient interface {
	// Initializes a MetadataStore, including allocation of resources.
	CreateMetadataStore(ctx context.Context, in *CreateMetadataStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Retrieves a specific MetadataStore.
	GetMetadataStore(ctx context.Context, in *GetMetadataStoreRequest, opts ...grpc.CallOption) (*MetadataStore, error)
	// Lists MetadataStores for a Location.
	ListMetadataStores(ctx context.Context, in *ListMetadataStoresRequest, opts ...grpc.CallOption) (*ListMetadataStoresResponse, error)
	// Deletes a single MetadataStore and all its child resources (Artifacts,
	// Executions, and Contexts).
	DeleteMetadataStore(ctx context.Context, in *DeleteMetadataStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates an Artifact associated with a MetadataStore.
	CreateArtifact(ctx context.Context, in *CreateArtifactRequest, opts ...grpc.CallOption) (*Artifact, error)
	// Retrieves a specific Artifact.
	GetArtifact(ctx context.Context, in *GetArtifactRequest, opts ...grpc.CallOption) (*Artifact, error)
	// Lists Artifacts in the MetadataStore.
	ListArtifacts(ctx context.Context, in *ListArtifactsRequest, opts ...grpc.CallOption) (*ListArtifactsResponse, error)
	// Updates a stored Artifact.
	UpdateArtifact(ctx context.Context, in *UpdateArtifactRequest, opts ...grpc.CallOption) (*Artifact, error)
	// Deletes an Artifact.
	DeleteArtifact(ctx context.Context, in *DeleteArtifactRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Purges Artifacts.
	PurgeArtifacts(ctx context.Context, in *PurgeArtifactsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a Context associated with a MetadataStore.
	CreateContext(ctx context.Context, in *CreateContextRequest, opts ...grpc.CallOption) (*Context, error)
	// Retrieves a specific Context.
	GetContext(ctx context.Context, in *GetContextRequest, opts ...grpc.CallOption) (*Context, error)
	// Lists Contexts on the MetadataStore.
	ListContexts(ctx context.Context, in *ListContextsRequest, opts ...grpc.CallOption) (*ListContextsResponse, error)
	// Updates a stored Context.
	UpdateContext(ctx context.Context, in *UpdateContextRequest, opts ...grpc.CallOption) (*Context, error)
	// Deletes a stored Context.
	DeleteContext(ctx context.Context, in *DeleteContextRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Purges Contexts.
	PurgeContexts(ctx context.Context, in *PurgeContextsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Adds a set of Artifacts and Executions to a Context. If any of the
	// Artifacts or Executions have already been added to a Context, they are
	// simply skipped.
	AddContextArtifactsAndExecutions(ctx context.Context, in *AddContextArtifactsAndExecutionsRequest, opts ...grpc.CallOption) (*AddContextArtifactsAndExecutionsResponse, error)
	// Adds a set of Contexts as children to a parent Context. If any of the
	// child Contexts have already been added to the parent Context, they are
	// simply skipped. If this call would create a cycle or cause any Context to
	// have more than 10 parents, the request will fail with an INVALID_ARGUMENT
	// error.
	AddContextChildren(ctx context.Context, in *AddContextChildrenRequest, opts ...grpc.CallOption) (*AddContextChildrenResponse, error)
	// Remove a set of children contexts from a parent Context. If any of the
	// child Contexts were NOT added to the parent Context, they are
	// simply skipped.
	RemoveContextChildren(ctx context.Context, in *RemoveContextChildrenRequest, opts ...grpc.CallOption) (*RemoveContextChildrenResponse, error)
	// Retrieves Artifacts and Executions within the specified Context, connected
	// by Event edges and returned as a LineageSubgraph.
	QueryContextLineageSubgraph(ctx context.Context, in *QueryContextLineageSubgraphRequest, opts ...grpc.CallOption) (*LineageSubgraph, error)
	// Creates an Execution associated with a MetadataStore.
	CreateExecution(ctx context.Context, in *CreateExecutionRequest, opts ...grpc.CallOption) (*Execution, error)
	// Retrieves a specific Execution.
	GetExecution(ctx context.Context, in *GetExecutionRequest, opts ...grpc.CallOption) (*Execution, error)
	// Lists Executions in the MetadataStore.
	ListExecutions(ctx context.Context, in *ListExecutionsRequest, opts ...grpc.CallOption) (*ListExecutionsResponse, error)
	// Updates a stored Execution.
	UpdateExecution(ctx context.Context, in *UpdateExecutionRequest, opts ...grpc.CallOption) (*Execution, error)
	// Deletes an Execution.
	DeleteExecution(ctx context.Context, in *DeleteExecutionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Purges Executions.
	PurgeExecutions(ctx context.Context, in *PurgeExecutionsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Adds Events to the specified Execution. An Event indicates whether an
	// Artifact was used as an input or output for an Execution. If an Event
	// already exists between the Execution and the Artifact, the Event is
	// skipped.
	AddExecutionEvents(ctx context.Context, in *AddExecutionEventsRequest, opts ...grpc.CallOption) (*AddExecutionEventsResponse, error)
	// Obtains the set of input and output Artifacts for this Execution, in the
	// form of LineageSubgraph that also contains the Execution and connecting
	// Events.
	QueryExecutionInputsAndOutputs(ctx context.Context, in *QueryExecutionInputsAndOutputsRequest, opts ...grpc.CallOption) (*LineageSubgraph, error)
	// Creates a MetadataSchema.
	CreateMetadataSchema(ctx context.Context, in *CreateMetadataSchemaRequest, opts ...grpc.CallOption) (*MetadataSchema, error)
	// Retrieves a specific MetadataSchema.
	GetMetadataSchema(ctx context.Context, in *GetMetadataSchemaRequest, opts ...grpc.CallOption) (*MetadataSchema, error)
	// Lists MetadataSchemas.
	ListMetadataSchemas(ctx context.Context, in *ListMetadataSchemasRequest, opts ...grpc.CallOption) (*ListMetadataSchemasResponse, error)
	// Retrieves lineage of an Artifact represented through Artifacts and
	// Executions connected by Event edges and returned as a LineageSubgraph.
	QueryArtifactLineageSubgraph(ctx context.Context, in *QueryArtifactLineageSubgraphRequest, opts ...grpc.CallOption) (*LineageSubgraph, error)
}

MetadataServiceClient is the client API for MetadataService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type MetadataServiceServer

type MetadataServiceServer interface {
	// Initializes a MetadataStore, including allocation of resources.
	CreateMetadataStore(context.Context, *CreateMetadataStoreRequest) (*longrunningpb.Operation, error)
	// Retrieves a specific MetadataStore.
	GetMetadataStore(context.Context, *GetMetadataStoreRequest) (*MetadataStore, error)
	// Lists MetadataStores for a Location.
	ListMetadataStores(context.Context, *ListMetadataStoresRequest) (*ListMetadataStoresResponse, error)
	// Deletes a single MetadataStore and all its child resources (Artifacts,
	// Executions, and Contexts).
	DeleteMetadataStore(context.Context, *DeleteMetadataStoreRequest) (*longrunningpb.Operation, error)
	// Creates an Artifact associated with a MetadataStore.
	CreateArtifact(context.Context, *CreateArtifactRequest) (*Artifact, error)
	// Retrieves a specific Artifact.
	GetArtifact(context.Context, *GetArtifactRequest) (*Artifact, error)
	// Lists Artifacts in the MetadataStore.
	ListArtifacts(context.Context, *ListArtifactsRequest) (*ListArtifactsResponse, error)
	// Updates a stored Artifact.
	UpdateArtifact(context.Context, *UpdateArtifactRequest) (*Artifact, error)
	// Deletes an Artifact.
	DeleteArtifact(context.Context, *DeleteArtifactRequest) (*longrunningpb.Operation, error)
	// Purges Artifacts.
	PurgeArtifacts(context.Context, *PurgeArtifactsRequest) (*longrunningpb.Operation, error)
	// Creates a Context associated with a MetadataStore.
	CreateContext(context.Context, *CreateContextRequest) (*Context, error)
	// Retrieves a specific Context.
	GetContext(context.Context, *GetContextRequest) (*Context, error)
	// Lists Contexts on the MetadataStore.
	ListContexts(context.Context, *ListContextsRequest) (*ListContextsResponse, error)
	// Updates a stored Context.
	UpdateContext(context.Context, *UpdateContextRequest) (*Context, error)
	// Deletes a stored Context.
	DeleteContext(context.Context, *DeleteContextRequest) (*longrunningpb.Operation, error)
	// Purges Contexts.
	PurgeContexts(context.Context, *PurgeContextsRequest) (*longrunningpb.Operation, error)
	// Adds a set of Artifacts and Executions to a Context. If any of the
	// Artifacts or Executions have already been added to a Context, they are
	// simply skipped.
	AddContextArtifactsAndExecutions(context.Context, *AddContextArtifactsAndExecutionsRequest) (*AddContextArtifactsAndExecutionsResponse, error)
	// Adds a set of Contexts as children to a parent Context. If any of the
	// child Contexts have already been added to the parent Context, they are
	// simply skipped. If this call would create a cycle or cause any Context to
	// have more than 10 parents, the request will fail with an INVALID_ARGUMENT
	// error.
	AddContextChildren(context.Context, *AddContextChildrenRequest) (*AddContextChildrenResponse, error)
	// Remove a set of children contexts from a parent Context. If any of the
	// child Contexts were NOT added to the parent Context, they are
	// simply skipped.
	RemoveContextChildren(context.Context, *RemoveContextChildrenRequest) (*RemoveContextChildrenResponse, error)
	// Retrieves Artifacts and Executions within the specified Context, connected
	// by Event edges and returned as a LineageSubgraph.
	QueryContextLineageSubgraph(context.Context, *QueryContextLineageSubgraphRequest) (*LineageSubgraph, error)
	// Creates an Execution associated with a MetadataStore.
	CreateExecution(context.Context, *CreateExecutionRequest) (*Execution, error)
	// Retrieves a specific Execution.
	GetExecution(context.Context, *GetExecutionRequest) (*Execution, error)
	// Lists Executions in the MetadataStore.
	ListExecutions(context.Context, *ListExecutionsRequest) (*ListExecutionsResponse, error)
	// Updates a stored Execution.
	UpdateExecution(context.Context, *UpdateExecutionRequest) (*Execution, error)
	// Deletes an Execution.
	DeleteExecution(context.Context, *DeleteExecutionRequest) (*longrunningpb.Operation, error)
	// Purges Executions.
	PurgeExecutions(context.Context, *PurgeExecutionsRequest) (*longrunningpb.Operation, error)
	// Adds Events to the specified Execution. An Event indicates whether an
	// Artifact was used as an input or output for an Execution. If an Event
	// already exists between the Execution and the Artifact, the Event is
	// skipped.
	AddExecutionEvents(context.Context, *AddExecutionEventsRequest) (*AddExecutionEventsResponse, error)
	// Obtains the set of input and output Artifacts for this Execution, in the
	// form of LineageSubgraph that also contains the Execution and connecting
	// Events.
	QueryExecutionInputsAndOutputs(context.Context, *QueryExecutionInputsAndOutputsRequest) (*LineageSubgraph, error)
	// Creates a MetadataSchema.
	CreateMetadataSchema(context.Context, *CreateMetadataSchemaRequest) (*MetadataSchema, error)
	// Retrieves a specific MetadataSchema.
	GetMetadataSchema(context.Context, *GetMetadataSchemaRequest) (*MetadataSchema, error)
	// Lists MetadataSchemas.
	ListMetadataSchemas(context.Context, *ListMetadataSchemasRequest) (*ListMetadataSchemasResponse, error)
	// Retrieves lineage of an Artifact represented through Artifacts and
	// Executions connected by Event edges and returned as a LineageSubgraph.
	QueryArtifactLineageSubgraph(context.Context, *QueryArtifactLineageSubgraphRequest) (*LineageSubgraph, error)
}

MetadataServiceServer is the server API for MetadataService service.

type MetadataStore

type MetadataStore struct {

	// Output only. The resource name of the MetadataStore instance.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Timestamp when this MetadataStore was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this MetadataStore was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Customer-managed encryption key spec for a Metadata Store. If set, this
	// Metadata Store and all sub-resources of this Metadata Store are secured
	// using this key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,5,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// Description of the MetadataStore.
	Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. State information of the MetadataStore.
	State *MetadataStore_MetadataStoreState `protobuf:"bytes,7,opt,name=state,proto3" json:"state,omitempty"`
	// contains filtered or unexported fields
}

Instance of a metadata store. Contains a set of metadata that can be queried.

func (*MetadataStore) Descriptor deprecated

func (*MetadataStore) Descriptor() ([]byte, []int)

Deprecated: Use MetadataStore.ProtoReflect.Descriptor instead.

func (*MetadataStore) GetCreateTime

func (x *MetadataStore) GetCreateTime() *timestamppb.Timestamp

func (*MetadataStore) GetDescription

func (x *MetadataStore) GetDescription() string

func (*MetadataStore) GetEncryptionSpec

func (x *MetadataStore) GetEncryptionSpec() *EncryptionSpec

func (*MetadataStore) GetName

func (x *MetadataStore) GetName() string

func (*MetadataStore) GetState

func (*MetadataStore) GetUpdateTime

func (x *MetadataStore) GetUpdateTime() *timestamppb.Timestamp

func (*MetadataStore) ProtoMessage

func (*MetadataStore) ProtoMessage()

func (*MetadataStore) ProtoReflect

func (x *MetadataStore) ProtoReflect() protoreflect.Message

func (*MetadataStore) Reset

func (x *MetadataStore) Reset()

func (*MetadataStore) String

func (x *MetadataStore) String() string

type MetadataStore_MetadataStoreState

type MetadataStore_MetadataStoreState struct {

	// The disk utilization of the MetadataStore in bytes.
	DiskUtilizationBytes int64 `protobuf:"varint,1,opt,name=disk_utilization_bytes,json=diskUtilizationBytes,proto3" json:"disk_utilization_bytes,omitempty"`
	// contains filtered or unexported fields
}

Represents state information for a MetadataStore.

func (*MetadataStore_MetadataStoreState) Descriptor deprecated

func (*MetadataStore_MetadataStoreState) Descriptor() ([]byte, []int)

Deprecated: Use MetadataStore_MetadataStoreState.ProtoReflect.Descriptor instead.

func (*MetadataStore_MetadataStoreState) GetDiskUtilizationBytes

func (x *MetadataStore_MetadataStoreState) GetDiskUtilizationBytes() int64

func (*MetadataStore_MetadataStoreState) ProtoMessage

func (*MetadataStore_MetadataStoreState) ProtoMessage()

func (*MetadataStore_MetadataStoreState) ProtoReflect

func (*MetadataStore_MetadataStoreState) Reset

func (*MetadataStore_MetadataStoreState) String

type MigratableResource

type MigratableResource struct {

	// Types that are assignable to Resource:
	//
	//	*MigratableResource_MlEngineModelVersion_
	//	*MigratableResource_AutomlModel_
	//	*MigratableResource_AutomlDataset_
	//	*MigratableResource_DataLabelingDataset_
	Resource isMigratableResource_Resource `protobuf_oneof:"resource"`
	// Output only. Timestamp when the last migration attempt on this
	// MigratableResource started. Will not be set if there's no migration attempt
	// on this MigratableResource.
	LastMigrateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=last_migrate_time,json=lastMigrateTime,proto3" json:"last_migrate_time,omitempty"`
	// Output only. Timestamp when this MigratableResource was last updated.
	LastUpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=last_update_time,json=lastUpdateTime,proto3" json:"last_update_time,omitempty"`
	// contains filtered or unexported fields
}

Represents one resource that exists in automl.googleapis.com, datalabeling.googleapis.com or ml.googleapis.com.

func (*MigratableResource) Descriptor deprecated

func (*MigratableResource) Descriptor() ([]byte, []int)

Deprecated: Use MigratableResource.ProtoReflect.Descriptor instead.

func (*MigratableResource) GetAutomlDataset

func (*MigratableResource) GetAutomlModel

func (*MigratableResource) GetDataLabelingDataset

func (x *MigratableResource) GetDataLabelingDataset() *MigratableResource_DataLabelingDataset

func (*MigratableResource) GetLastMigrateTime

func (x *MigratableResource) GetLastMigrateTime() *timestamppb.Timestamp

func (*MigratableResource) GetLastUpdateTime

func (x *MigratableResource) GetLastUpdateTime() *timestamppb.Timestamp

func (*MigratableResource) GetMlEngineModelVersion

func (x *MigratableResource) GetMlEngineModelVersion() *MigratableResource_MlEngineModelVersion

func (*MigratableResource) GetResource

func (m *MigratableResource) GetResource() isMigratableResource_Resource

func (*MigratableResource) ProtoMessage

func (*MigratableResource) ProtoMessage()

func (*MigratableResource) ProtoReflect

func (x *MigratableResource) ProtoReflect() protoreflect.Message

func (*MigratableResource) Reset

func (x *MigratableResource) Reset()

func (*MigratableResource) String

func (x *MigratableResource) String() string

type MigratableResource_AutomlDataset

type MigratableResource_AutomlDataset struct {

	// Full resource name of automl Dataset.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`.
	Dataset string `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// The Dataset's display name in automl.googleapis.com.
	DatasetDisplayName string `protobuf:"bytes,4,opt,name=dataset_display_name,json=datasetDisplayName,proto3" json:"dataset_display_name,omitempty"`
	// contains filtered or unexported fields
}

Represents one Dataset in automl.googleapis.com.

func (*MigratableResource_AutomlDataset) Descriptor deprecated

func (*MigratableResource_AutomlDataset) Descriptor() ([]byte, []int)

Deprecated: Use MigratableResource_AutomlDataset.ProtoReflect.Descriptor instead.

func (*MigratableResource_AutomlDataset) GetDataset

func (x *MigratableResource_AutomlDataset) GetDataset() string

func (*MigratableResource_AutomlDataset) GetDatasetDisplayName

func (x *MigratableResource_AutomlDataset) GetDatasetDisplayName() string

func (*MigratableResource_AutomlDataset) ProtoMessage

func (*MigratableResource_AutomlDataset) ProtoMessage()

func (*MigratableResource_AutomlDataset) ProtoReflect

func (*MigratableResource_AutomlDataset) Reset

func (*MigratableResource_AutomlDataset) String

type MigratableResource_AutomlDataset_

type MigratableResource_AutomlDataset_ struct {
	// Output only. Represents one Dataset in automl.googleapis.com.
	AutomlDataset *MigratableResource_AutomlDataset `protobuf:"bytes,3,opt,name=automl_dataset,json=automlDataset,proto3,oneof"`
}

type MigratableResource_AutomlModel

type MigratableResource_AutomlModel struct {

	// Full resource name of automl Model.
	// Format:
	// `projects/{project}/locations/{location}/models/{model}`.
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// The Model's display name in automl.googleapis.com.
	ModelDisplayName string `protobuf:"bytes,3,opt,name=model_display_name,json=modelDisplayName,proto3" json:"model_display_name,omitempty"`
	// contains filtered or unexported fields
}

Represents one Model in automl.googleapis.com.

func (*MigratableResource_AutomlModel) Descriptor deprecated

func (*MigratableResource_AutomlModel) Descriptor() ([]byte, []int)

Deprecated: Use MigratableResource_AutomlModel.ProtoReflect.Descriptor instead.

func (*MigratableResource_AutomlModel) GetModel

func (x *MigratableResource_AutomlModel) GetModel() string

func (*MigratableResource_AutomlModel) GetModelDisplayName

func (x *MigratableResource_AutomlModel) GetModelDisplayName() string

func (*MigratableResource_AutomlModel) ProtoMessage

func (*MigratableResource_AutomlModel) ProtoMessage()

func (*MigratableResource_AutomlModel) ProtoReflect

func (*MigratableResource_AutomlModel) Reset

func (x *MigratableResource_AutomlModel) Reset()

func (*MigratableResource_AutomlModel) String

type MigratableResource_AutomlModel_

type MigratableResource_AutomlModel_ struct {
	// Output only. Represents one Model in automl.googleapis.com.
	AutomlModel *MigratableResource_AutomlModel `protobuf:"bytes,2,opt,name=automl_model,json=automlModel,proto3,oneof"`
}

type MigratableResource_DataLabelingDataset

type MigratableResource_DataLabelingDataset struct {

	// Full resource name of data labeling Dataset.
	// Format:
	// `projects/{project}/datasets/{dataset}`.
	Dataset string `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// The Dataset's display name in datalabeling.googleapis.com.
	DatasetDisplayName string `protobuf:"bytes,4,opt,name=dataset_display_name,json=datasetDisplayName,proto3" json:"dataset_display_name,omitempty"`
	// The migratable AnnotatedDataset in datalabeling.googleapis.com belongs to
	// the data labeling Dataset.
	DataLabelingAnnotatedDatasets []*MigratableResource_DataLabelingDataset_DataLabelingAnnotatedDataset `` /* 152-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents one Dataset in datalabeling.googleapis.com.

func (*MigratableResource_DataLabelingDataset) Descriptor deprecated

func (*MigratableResource_DataLabelingDataset) Descriptor() ([]byte, []int)

Deprecated: Use MigratableResource_DataLabelingDataset.ProtoReflect.Descriptor instead.

func (*MigratableResource_DataLabelingDataset) GetDataLabelingAnnotatedDatasets

func (*MigratableResource_DataLabelingDataset) GetDataset

func (*MigratableResource_DataLabelingDataset) GetDatasetDisplayName

func (x *MigratableResource_DataLabelingDataset) GetDatasetDisplayName() string

func (*MigratableResource_DataLabelingDataset) ProtoMessage

func (*MigratableResource_DataLabelingDataset) ProtoReflect

func (*MigratableResource_DataLabelingDataset) Reset

func (*MigratableResource_DataLabelingDataset) String

type MigratableResource_DataLabelingDataset_

type MigratableResource_DataLabelingDataset_ struct {
	// Output only. Represents one Dataset in datalabeling.googleapis.com.
	DataLabelingDataset *MigratableResource_DataLabelingDataset `protobuf:"bytes,4,opt,name=data_labeling_dataset,json=dataLabelingDataset,proto3,oneof"`
}

type MigratableResource_DataLabelingDataset_DataLabelingAnnotatedDataset

type MigratableResource_DataLabelingDataset_DataLabelingAnnotatedDataset struct {

	// Full resource name of data labeling AnnotatedDataset.
	// Format:
	// `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.
	AnnotatedDataset string `protobuf:"bytes,1,opt,name=annotated_dataset,json=annotatedDataset,proto3" json:"annotated_dataset,omitempty"`
	// The AnnotatedDataset's display name in datalabeling.googleapis.com.
	AnnotatedDatasetDisplayName string `` /* 146-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents one AnnotatedDataset in datalabeling.googleapis.com.

func (*MigratableResource_DataLabelingDataset_DataLabelingAnnotatedDataset) Descriptor deprecated

Deprecated: Use MigratableResource_DataLabelingDataset_DataLabelingAnnotatedDataset.ProtoReflect.Descriptor instead.

func (*MigratableResource_DataLabelingDataset_DataLabelingAnnotatedDataset) GetAnnotatedDataset

func (*MigratableResource_DataLabelingDataset_DataLabelingAnnotatedDataset) GetAnnotatedDatasetDisplayName

func (*MigratableResource_DataLabelingDataset_DataLabelingAnnotatedDataset) ProtoMessage

func (*MigratableResource_DataLabelingDataset_DataLabelingAnnotatedDataset) ProtoReflect

func (*MigratableResource_DataLabelingDataset_DataLabelingAnnotatedDataset) Reset

func (*MigratableResource_DataLabelingDataset_DataLabelingAnnotatedDataset) String

type MigratableResource_MlEngineModelVersion

type MigratableResource_MlEngineModelVersion struct {

	// The ml.googleapis.com endpoint that this model Version currently lives
	// in.
	// Example values:
	//
	// * ml.googleapis.com
	// * us-centrall-ml.googleapis.com
	// * europe-west4-ml.googleapis.com
	// * asia-east1-ml.googleapis.com
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Full resource name of ml engine model Version.
	// Format: `projects/{project}/models/{model}/versions/{version}`.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

Represents one model Version in ml.googleapis.com.

func (*MigratableResource_MlEngineModelVersion) Descriptor deprecated

func (*MigratableResource_MlEngineModelVersion) Descriptor() ([]byte, []int)

Deprecated: Use MigratableResource_MlEngineModelVersion.ProtoReflect.Descriptor instead.

func (*MigratableResource_MlEngineModelVersion) GetEndpoint

func (*MigratableResource_MlEngineModelVersion) GetVersion

func (*MigratableResource_MlEngineModelVersion) ProtoMessage

func (*MigratableResource_MlEngineModelVersion) ProtoReflect

func (*MigratableResource_MlEngineModelVersion) Reset

func (*MigratableResource_MlEngineModelVersion) String

type MigratableResource_MlEngineModelVersion_

type MigratableResource_MlEngineModelVersion_ struct {
	// Output only. Represents one Version in ml.googleapis.com.
	MlEngineModelVersion *MigratableResource_MlEngineModelVersion `protobuf:"bytes,1,opt,name=ml_engine_model_version,json=mlEngineModelVersion,proto3,oneof"`
}

type MigrateResourceRequest

type MigrateResourceRequest struct {

	// Types that are assignable to Request:
	//
	//	*MigrateResourceRequest_MigrateMlEngineModelVersionConfig_
	//	*MigrateResourceRequest_MigrateAutomlModelConfig_
	//	*MigrateResourceRequest_MigrateAutomlDatasetConfig_
	//	*MigrateResourceRequest_MigrateDataLabelingDatasetConfig_
	Request isMigrateResourceRequest_Request `protobuf_oneof:"request"`
	// contains filtered or unexported fields
}

Config of migrating one resource from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.

func (*MigrateResourceRequest) Descriptor deprecated

func (*MigrateResourceRequest) Descriptor() ([]byte, []int)

Deprecated: Use MigrateResourceRequest.ProtoReflect.Descriptor instead.

func (*MigrateResourceRequest) GetMigrateAutomlDatasetConfig

func (*MigrateResourceRequest) GetMigrateAutomlModelConfig

func (*MigrateResourceRequest) GetMigrateDataLabelingDatasetConfig

func (x *MigrateResourceRequest) GetMigrateDataLabelingDatasetConfig() *MigrateResourceRequest_MigrateDataLabelingDatasetConfig

func (*MigrateResourceRequest) GetMigrateMlEngineModelVersionConfig

func (x *MigrateResourceRequest) GetMigrateMlEngineModelVersionConfig() *MigrateResourceRequest_MigrateMlEngineModelVersionConfig

func (*MigrateResourceRequest) GetRequest

func (m *MigrateResourceRequest) GetRequest() isMigrateResourceRequest_Request

func (*MigrateResourceRequest) ProtoMessage

func (*MigrateResourceRequest) ProtoMessage()

func (*MigrateResourceRequest) ProtoReflect

func (x *MigrateResourceRequest) ProtoReflect() protoreflect.Message

func (*MigrateResourceRequest) Reset

func (x *MigrateResourceRequest) Reset()

func (*MigrateResourceRequest) String

func (x *MigrateResourceRequest) String() string

type MigrateResourceRequest_MigrateAutomlDatasetConfig

type MigrateResourceRequest_MigrateAutomlDatasetConfig struct {

	// Required. Full resource name of automl Dataset.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`.
	Dataset string `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// Required. Display name of the Dataset in Vertex AI.
	// System will pick a display name if unspecified.
	DatasetDisplayName string `protobuf:"bytes,2,opt,name=dataset_display_name,json=datasetDisplayName,proto3" json:"dataset_display_name,omitempty"`
	// contains filtered or unexported fields
}

Config for migrating Dataset in automl.googleapis.com to Vertex AI's Dataset.

func (*MigrateResourceRequest_MigrateAutomlDatasetConfig) Descriptor deprecated

Deprecated: Use MigrateResourceRequest_MigrateAutomlDatasetConfig.ProtoReflect.Descriptor instead.

func (*MigrateResourceRequest_MigrateAutomlDatasetConfig) GetDataset

func (*MigrateResourceRequest_MigrateAutomlDatasetConfig) GetDatasetDisplayName

func (x *MigrateResourceRequest_MigrateAutomlDatasetConfig) GetDatasetDisplayName() string

func (*MigrateResourceRequest_MigrateAutomlDatasetConfig) ProtoMessage

func (*MigrateResourceRequest_MigrateAutomlDatasetConfig) ProtoReflect

func (*MigrateResourceRequest_MigrateAutomlDatasetConfig) Reset

func (*MigrateResourceRequest_MigrateAutomlDatasetConfig) String

type MigrateResourceRequest_MigrateAutomlDatasetConfig_

type MigrateResourceRequest_MigrateAutomlDatasetConfig_ struct {
	// Config for migrating Dataset in automl.googleapis.com to Vertex AI's
	// Dataset.
	MigrateAutomlDatasetConfig *MigrateResourceRequest_MigrateAutomlDatasetConfig `protobuf:"bytes,3,opt,name=migrate_automl_dataset_config,json=migrateAutomlDatasetConfig,proto3,oneof"`
}

type MigrateResourceRequest_MigrateAutomlModelConfig

type MigrateResourceRequest_MigrateAutomlModelConfig struct {

	// Required. Full resource name of automl Model.
	// Format:
	// `projects/{project}/locations/{location}/models/{model}`.
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Optional. Display name of the model in Vertex AI.
	// System will pick a display name if unspecified.
	ModelDisplayName string `protobuf:"bytes,2,opt,name=model_display_name,json=modelDisplayName,proto3" json:"model_display_name,omitempty"`
	// contains filtered or unexported fields
}

Config for migrating Model in automl.googleapis.com to Vertex AI's Model.

func (*MigrateResourceRequest_MigrateAutomlModelConfig) Descriptor deprecated

Deprecated: Use MigrateResourceRequest_MigrateAutomlModelConfig.ProtoReflect.Descriptor instead.

func (*MigrateResourceRequest_MigrateAutomlModelConfig) GetModel

func (*MigrateResourceRequest_MigrateAutomlModelConfig) GetModelDisplayName

func (*MigrateResourceRequest_MigrateAutomlModelConfig) ProtoMessage

func (*MigrateResourceRequest_MigrateAutomlModelConfig) ProtoReflect

func (*MigrateResourceRequest_MigrateAutomlModelConfig) Reset

func (*MigrateResourceRequest_MigrateAutomlModelConfig) String

type MigrateResourceRequest_MigrateAutomlModelConfig_

type MigrateResourceRequest_MigrateAutomlModelConfig_ struct {
	// Config for migrating Model in automl.googleapis.com to Vertex AI's
	// Model.
	MigrateAutomlModelConfig *MigrateResourceRequest_MigrateAutomlModelConfig `protobuf:"bytes,2,opt,name=migrate_automl_model_config,json=migrateAutomlModelConfig,proto3,oneof"`
}

type MigrateResourceRequest_MigrateDataLabelingDatasetConfig

type MigrateResourceRequest_MigrateDataLabelingDatasetConfig struct {

	// Required. Full resource name of data labeling Dataset.
	// Format:
	// `projects/{project}/datasets/{dataset}`.
	Dataset string `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// Optional. Display name of the Dataset in Vertex AI.
	// System will pick a display name if unspecified.
	DatasetDisplayName string `protobuf:"bytes,2,opt,name=dataset_display_name,json=datasetDisplayName,proto3" json:"dataset_display_name,omitempty"`
	// Optional. Configs for migrating AnnotatedDataset in
	// datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified
	// AnnotatedDatasets have to belong to the datalabeling Dataset.
	MigrateDataLabelingAnnotatedDatasetConfigs []*MigrateResourceRequest_MigrateDataLabelingDatasetConfig_MigrateDataLabelingAnnotatedDatasetConfig `` /* 195-byte string literal not displayed */
	// contains filtered or unexported fields
}

Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI's Dataset.

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig) Descriptor deprecated

Deprecated: Use MigrateResourceRequest_MigrateDataLabelingDatasetConfig.ProtoReflect.Descriptor instead.

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig) GetDataset

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig) GetDatasetDisplayName

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig) ProtoMessage

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig) ProtoReflect

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig) Reset

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig) String

type MigrateResourceRequest_MigrateDataLabelingDatasetConfig_

type MigrateResourceRequest_MigrateDataLabelingDatasetConfig_ struct {
	// Config for migrating Dataset in datalabeling.googleapis.com to
	// Vertex AI's Dataset.
	MigrateDataLabelingDatasetConfig *MigrateResourceRequest_MigrateDataLabelingDatasetConfig `protobuf:"bytes,4,opt,name=migrate_data_labeling_dataset_config,json=migrateDataLabelingDatasetConfig,proto3,oneof"`
}

type MigrateResourceRequest_MigrateDataLabelingDatasetConfig_MigrateDataLabelingAnnotatedDatasetConfig

type MigrateResourceRequest_MigrateDataLabelingDatasetConfig_MigrateDataLabelingAnnotatedDatasetConfig struct {

	// Required. Full resource name of data labeling AnnotatedDataset.
	// Format:
	// `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.
	AnnotatedDataset string `protobuf:"bytes,1,opt,name=annotated_dataset,json=annotatedDataset,proto3" json:"annotated_dataset,omitempty"`
	// contains filtered or unexported fields
}

Config for migrating AnnotatedDataset in datalabeling.googleapis.com to Vertex AI's SavedQuery.

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig_MigrateDataLabelingAnnotatedDatasetConfig) Descriptor deprecated

Deprecated: Use MigrateResourceRequest_MigrateDataLabelingDatasetConfig_MigrateDataLabelingAnnotatedDatasetConfig.ProtoReflect.Descriptor instead.

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig_MigrateDataLabelingAnnotatedDatasetConfig) GetAnnotatedDataset

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig_MigrateDataLabelingAnnotatedDatasetConfig) ProtoMessage

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig_MigrateDataLabelingAnnotatedDatasetConfig) ProtoReflect

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig_MigrateDataLabelingAnnotatedDatasetConfig) Reset

func (*MigrateResourceRequest_MigrateDataLabelingDatasetConfig_MigrateDataLabelingAnnotatedDatasetConfig) String

type MigrateResourceRequest_MigrateMlEngineModelVersionConfig

type MigrateResourceRequest_MigrateMlEngineModelVersionConfig struct {

	// Required. The ml.googleapis.com endpoint that this model version should
	// be migrated from. Example values:
	//
	// * ml.googleapis.com
	//
	// * us-centrall-ml.googleapis.com
	//
	// * europe-west4-ml.googleapis.com
	//
	// * asia-east1-ml.googleapis.com
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Required. Full resource name of ml engine model version.
	// Format: `projects/{project}/models/{model}/versions/{version}`.
	ModelVersion string `protobuf:"bytes,2,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
	// Required. Display name of the model in Vertex AI.
	// System will pick a display name if unspecified.
	ModelDisplayName string `protobuf:"bytes,3,opt,name=model_display_name,json=modelDisplayName,proto3" json:"model_display_name,omitempty"`
	// contains filtered or unexported fields
}

Config for migrating version in ml.googleapis.com to Vertex AI's Model.

func (*MigrateResourceRequest_MigrateMlEngineModelVersionConfig) Descriptor deprecated

Deprecated: Use MigrateResourceRequest_MigrateMlEngineModelVersionConfig.ProtoReflect.Descriptor instead.

func (*MigrateResourceRequest_MigrateMlEngineModelVersionConfig) GetEndpoint

func (*MigrateResourceRequest_MigrateMlEngineModelVersionConfig) GetModelDisplayName

func (*MigrateResourceRequest_MigrateMlEngineModelVersionConfig) GetModelVersion

func (*MigrateResourceRequest_MigrateMlEngineModelVersionConfig) ProtoMessage

func (*MigrateResourceRequest_MigrateMlEngineModelVersionConfig) ProtoReflect

func (*MigrateResourceRequest_MigrateMlEngineModelVersionConfig) Reset

func (*MigrateResourceRequest_MigrateMlEngineModelVersionConfig) String

type MigrateResourceRequest_MigrateMlEngineModelVersionConfig_

type MigrateResourceRequest_MigrateMlEngineModelVersionConfig_ struct {
	// Config for migrating Version in ml.googleapis.com to Vertex AI's Model.
	MigrateMlEngineModelVersionConfig *MigrateResourceRequest_MigrateMlEngineModelVersionConfig `protobuf:"bytes,1,opt,name=migrate_ml_engine_model_version_config,json=migrateMlEngineModelVersionConfig,proto3,oneof"`
}

type MigrateResourceResponse

type MigrateResourceResponse struct {

	// After migration, the resource name in Vertex AI.
	//
	// Types that are assignable to MigratedResource:
	//
	//	*MigrateResourceResponse_Dataset
	//	*MigrateResourceResponse_Model
	MigratedResource isMigrateResourceResponse_MigratedResource `protobuf_oneof:"migrated_resource"`
	// Before migration, the identifier in ml.googleapis.com,
	// automl.googleapis.com or datalabeling.googleapis.com.
	MigratableResource *MigratableResource `protobuf:"bytes,3,opt,name=migratable_resource,json=migratableResource,proto3" json:"migratable_resource,omitempty"`
	// contains filtered or unexported fields
}

Describes a successfully migrated resource.

func (*MigrateResourceResponse) Descriptor deprecated

func (*MigrateResourceResponse) Descriptor() ([]byte, []int)

Deprecated: Use MigrateResourceResponse.ProtoReflect.Descriptor instead.

func (*MigrateResourceResponse) GetDataset

func (x *MigrateResourceResponse) GetDataset() string

func (*MigrateResourceResponse) GetMigratableResource

func (x *MigrateResourceResponse) GetMigratableResource() *MigratableResource

func (*MigrateResourceResponse) GetMigratedResource

func (m *MigrateResourceResponse) GetMigratedResource() isMigrateResourceResponse_MigratedResource

func (*MigrateResourceResponse) GetModel

func (x *MigrateResourceResponse) GetModel() string

func (*MigrateResourceResponse) ProtoMessage

func (*MigrateResourceResponse) ProtoMessage()

func (*MigrateResourceResponse) ProtoReflect

func (x *MigrateResourceResponse) ProtoReflect() protoreflect.Message

func (*MigrateResourceResponse) Reset

func (x *MigrateResourceResponse) Reset()

func (*MigrateResourceResponse) String

func (x *MigrateResourceResponse) String() string

type MigrateResourceResponse_Dataset

type MigrateResourceResponse_Dataset struct {
	// Migrated Dataset's resource name.
	Dataset string `protobuf:"bytes,1,opt,name=dataset,proto3,oneof"`
}

type MigrateResourceResponse_Model

type MigrateResourceResponse_Model struct {
	// Migrated Model's resource name.
	Model string `protobuf:"bytes,2,opt,name=model,proto3,oneof"`
}

type MigrationServiceClient

type MigrationServiceClient interface {
	// 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.
	SearchMigratableResources(ctx context.Context, in *SearchMigratableResourcesRequest, opts ...grpc.CallOption) (*SearchMigratableResourcesResponse, error)
	// Batch migrates resources from ml.googleapis.com, automl.googleapis.com,
	// and datalabeling.googleapis.com to Vertex AI.
	BatchMigrateResources(ctx context.Context, in *BatchMigrateResourcesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

MigrationServiceClient is the client API for MigrationService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type MigrationServiceServer

type MigrationServiceServer interface {
	// 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.
	SearchMigratableResources(context.Context, *SearchMigratableResourcesRequest) (*SearchMigratableResourcesResponse, error)
	// Batch migrates resources from ml.googleapis.com, automl.googleapis.com,
	// and datalabeling.googleapis.com to Vertex AI.
	BatchMigrateResources(context.Context, *BatchMigrateResourcesRequest) (*longrunningpb.Operation, error)
}

MigrationServiceServer is the server API for MigrationService service.

type Model

type Model struct {

	// The resource name of the Model.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Immutable. The version ID of the model.
	// A new version is committed when a new model version is uploaded or
	// trained under an existing model id. It is an auto-incrementing decimal
	// number in string representation.
	VersionId string `protobuf:"bytes,28,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// User provided version aliases so that a model version can be referenced via
	// alias (i.e.
	// `projects/{project}/locations/{location}/models/{model_id}@{version_alias}`
	// instead of auto-generated version id (i.e.
	// `projects/{project}/locations/{location}/models/{model_id}@{version_id})`.
	// The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from
	// version_id. A default version alias will be created for the first version
	// of the model, and there must be exactly one default version alias for a
	// model.
	VersionAliases []string `protobuf:"bytes,29,rep,name=version_aliases,json=versionAliases,proto3" json:"version_aliases,omitempty"`
	// Output only. Timestamp when this version was created.
	VersionCreateTime *timestamppb.Timestamp `protobuf:"bytes,31,opt,name=version_create_time,json=versionCreateTime,proto3" json:"version_create_time,omitempty"`
	// Output only. Timestamp when this version was most recently updated.
	VersionUpdateTime *timestamppb.Timestamp `protobuf:"bytes,32,opt,name=version_update_time,json=versionUpdateTime,proto3" json:"version_update_time,omitempty"`
	// Required. The display name of the Model.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The description of the Model.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// The description of this version.
	VersionDescription string `protobuf:"bytes,30,opt,name=version_description,json=versionDescription,proto3" json:"version_description,omitempty"`
	// The schemata that describe formats of the Model's predictions and
	// explanations as given and returned via
	// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]
	// and
	// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
	PredictSchemata *PredictSchemata `protobuf:"bytes,4,opt,name=predict_schemata,json=predictSchemata,proto3" json:"predict_schemata,omitempty"`
	// Immutable. Points to a YAML file stored on Google Cloud Storage describing
	// additional information about the Model, that is specific to it. Unset if
	// the Model does not have any additional information. The schema is defined
	// as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	// AutoML Models always have this field populated by Vertex AI, if no
	// additional metadata is needed, this field is set to an empty string.
	// Note: The URI given on output will be immutable and probably different,
	// including the URI scheme, than the one given on input. The output URI will
	// point to a location where the user only has a read access.
	MetadataSchemaUri string `protobuf:"bytes,5,opt,name=metadata_schema_uri,json=metadataSchemaUri,proto3" json:"metadata_schema_uri,omitempty"`
	// Immutable. An additional information about the Model; the schema of the
	// metadata can be found in
	// [metadata_schema][google.cloud.aiplatform.v1.Model.metadata_schema_uri].
	// Unset if the Model does not have any additional information.
	Metadata *structpb.Value `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Output only. The formats in which this Model may be exported. If empty,
	// this Model is not available for export.
	SupportedExportFormats []*Model_ExportFormat `` /* 130-byte string literal not displayed */
	// Output only. The resource name of the TrainingPipeline that uploaded this
	// Model, if any.
	TrainingPipeline string `protobuf:"bytes,7,opt,name=training_pipeline,json=trainingPipeline,proto3" json:"training_pipeline,omitempty"`
	// Optional. This field is populated if the model is produced by a pipeline
	// job.
	PipelineJob string `protobuf:"bytes,47,opt,name=pipeline_job,json=pipelineJob,proto3" json:"pipeline_job,omitempty"`
	// Input only. The specification of the container that is to be used when
	// deploying this Model. The specification is ingested upon
	// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel],
	// and all binaries it contains are copied and stored internally by Vertex AI.
	// Not required for AutoML Models.
	ContainerSpec *ModelContainerSpec `protobuf:"bytes,9,opt,name=container_spec,json=containerSpec,proto3" json:"container_spec,omitempty"`
	// Immutable. The path to the directory containing the Model artifact and any
	// of its supporting files. Not required for AutoML Models.
	ArtifactUri string `protobuf:"bytes,26,opt,name=artifact_uri,json=artifactUri,proto3" json:"artifact_uri,omitempty"`
	// Output only. When this Model is deployed, its prediction resources are
	// described by the `prediction_resources` field of the
	// [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
	// object. Because not all Models support all resource configuration types,
	// the configuration types this Model supports are listed here. If no
	// configuration types are listed, the Model cannot be deployed to an
	// [Endpoint][google.cloud.aiplatform.v1.Endpoint] and does not support
	// online predictions
	// ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]
	// or
	// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]).
	// Such a Model can serve predictions by using a
	// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it
	// has at least one entry each in
	// [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats]
	// and
	// [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
	SupportedDeploymentResourcesTypes []Model_DeploymentResourcesType `` /* 235-byte string literal not displayed */
	// Output only. The formats this Model supports in
	// [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
	// If
	// [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
	// exists, the instances should be given as per that schema.
	//
	// The possible formats are:
	//
	// * `jsonl`
	// The JSON Lines format, where each instance is a single line. Uses
	// [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source].
	//
	// * `csv`
	// The CSV format, where each instance is a single comma-separated line.
	// The first line in the file is the header, containing comma-separated field
	// names. Uses
	// [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source].
	//
	// * `tf-record`
	// The TFRecord format, where each instance is a single record in tfrecord
	// syntax. Uses
	// [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source].
	//
	// * `tf-record-gzip`
	// Similar to `tf-record`, but the file is gzipped. Uses
	// [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source].
	//
	// * `bigquery`
	// Each instance is a single row in BigQuery. Uses
	// [BigQuerySource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.bigquery_source].
	//
	// * `file-list`
	// Each line of the file is the location of an instance to process, uses
	// `gcs_source` field of the
	// [InputConfig][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig]
	// object.
	//
	// If this Model doesn't support any of these formats it means it cannot be
	// used with a
	// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
	// However, if it has
	// [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types],
	// it could serve online predictions by using
	// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]
	// or
	// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
	SupportedInputStorageFormats []string `` /* 150-byte string literal not displayed */
	// Output only. The formats this Model supports in
	// [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
	// If both
	// [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
	// and
	// [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri]
	// exist, the predictions are returned together with their instances. In other
	// words, the prediction has the original instance data first, followed by the
	// actual prediction content (as per the schema).
	//
	// The possible formats are:
	//
	// * `jsonl`
	// The JSON Lines format, where each prediction is a single line. Uses
	// [GcsDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.gcs_destination].
	//
	// * `csv`
	// The CSV format, where each prediction is a single comma-separated line.
	// The first line in the file is the header, containing comma-separated field
	// names. Uses
	// [GcsDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.gcs_destination].
	//
	// * `bigquery`
	// Each prediction is a single row in a BigQuery table, uses
	// [BigQueryDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.bigquery_destination]
	// .
	//
	// If this Model doesn't support any of these formats it means it cannot be
	// used with a
	// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
	// However, if it has
	// [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types],
	// it could serve online predictions by using
	// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]
	// or
	// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
	SupportedOutputStorageFormats []string `` /* 153-byte string literal not displayed */
	// Output only. Timestamp when this Model was uploaded into Vertex AI.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Model was most recently updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The pointers to DeployedModels created from this Model. Note
	// that Model could have been deployed to Endpoints in different Locations.
	DeployedModels []*DeployedModelRef `protobuf:"bytes,15,rep,name=deployed_models,json=deployedModels,proto3" json:"deployed_models,omitempty"`
	// The default explanation specification for this Model.
	//
	// The Model can be used for
	// [requesting
	// explanation][google.cloud.aiplatform.v1.PredictionService.Explain] after
	// being [deployed][google.cloud.aiplatform.v1.EndpointService.DeployModel] if
	// it is populated. The Model can be used for [batch
	// explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
	// if it is populated.
	//
	// All fields of the explanation_spec can be overridden by
	// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
	// of
	// [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model],
	// or
	// [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
	// of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
	//
	// If the default explanation specification is not set for this Model, this
	// Model can still be used for
	// [requesting
	// explanation][google.cloud.aiplatform.v1.PredictionService.Explain] by
	// setting
	// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
	// of
	// [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model]
	// and for [batch
	// explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
	// by setting
	// [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
	// of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
	ExplanationSpec *ExplanationSpec `protobuf:"bytes,23,opt,name=explanation_spec,json=explanationSpec,proto3" json:"explanation_spec,omitempty"`
	// Used to perform consistent read-modify-write updates. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,16,opt,name=etag,proto3" json:"etag,omitempty"`
	// The labels with user-defined metadata to organize your Models.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Stats of data used for training or evaluating the Model.
	//
	// Only populated when the Model is trained by a TrainingPipeline with
	// [data_input_config][TrainingPipeline.data_input_config].
	DataStats *Model_DataStats `protobuf:"bytes,21,opt,name=data_stats,json=dataStats,proto3" json:"data_stats,omitempty"`
	// Customer-managed encryption key spec for a Model. If set, this
	// Model and all sub-resources of this Model will be secured by this key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,24,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// Output only. Source of a model. It can either be automl training pipeline,
	// custom training pipeline, BigQuery ML, or saved and tuned from Genie or
	// Model Garden.
	ModelSourceInfo *ModelSourceInfo `protobuf:"bytes,38,opt,name=model_source_info,json=modelSourceInfo,proto3" json:"model_source_info,omitempty"`
	// Output only. If this Model is a copy of another Model, this contains info
	// about the original.
	OriginalModelInfo *Model_OriginalModelInfo `protobuf:"bytes,34,opt,name=original_model_info,json=originalModelInfo,proto3" json:"original_model_info,omitempty"`
	// Output only. The resource name of the Artifact that was created in
	// MetadataStore when creating the Model. The Artifact resource name pattern
	// is
	// `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
	MetadataArtifact string `protobuf:"bytes,44,opt,name=metadata_artifact,json=metadataArtifact,proto3" json:"metadata_artifact,omitempty"`
	// Optional. User input field to specify the base model source. Currently it
	// only supports specifing the Model Garden models and Genie models.
	BaseModelSource *Model_BaseModelSource `protobuf:"bytes,50,opt,name=base_model_source,json=baseModelSource,proto3" json:"base_model_source,omitempty"`
	// contains filtered or unexported fields
}

A trained machine learning Model.

func (*Model) Descriptor deprecated

func (*Model) Descriptor() ([]byte, []int)

Deprecated: Use Model.ProtoReflect.Descriptor instead.

func (*Model) GetArtifactUri

func (x *Model) GetArtifactUri() string

func (*Model) GetBaseModelSource added in v1.63.0

func (x *Model) GetBaseModelSource() *Model_BaseModelSource

func (*Model) GetContainerSpec

func (x *Model) GetContainerSpec() *ModelContainerSpec

func (*Model) GetCreateTime

func (x *Model) GetCreateTime() *timestamppb.Timestamp

func (*Model) GetDataStats added in v1.56.0

func (x *Model) GetDataStats() *Model_DataStats

func (*Model) GetDeployedModels

func (x *Model) GetDeployedModels() []*DeployedModelRef

func (*Model) GetDescription

func (x *Model) GetDescription() string

func (*Model) GetDisplayName

func (x *Model) GetDisplayName() string

func (*Model) GetEncryptionSpec

func (x *Model) GetEncryptionSpec() *EncryptionSpec

func (*Model) GetEtag

func (x *Model) GetEtag() string

func (*Model) GetExplanationSpec

func (x *Model) GetExplanationSpec() *ExplanationSpec

func (*Model) GetLabels

func (x *Model) GetLabels() map[string]string

func (*Model) GetMetadata

func (x *Model) GetMetadata() *structpb.Value

func (*Model) GetMetadataArtifact

func (x *Model) GetMetadataArtifact() string

func (*Model) GetMetadataSchemaUri

func (x *Model) GetMetadataSchemaUri() string

func (*Model) GetModelSourceInfo

func (x *Model) GetModelSourceInfo() *ModelSourceInfo

func (*Model) GetName

func (x *Model) GetName() string

func (*Model) GetOriginalModelInfo added in v1.34.0

func (x *Model) GetOriginalModelInfo() *Model_OriginalModelInfo

func (*Model) GetPipelineJob added in v1.44.0

func (x *Model) GetPipelineJob() string

func (*Model) GetPredictSchemata

func (x *Model) GetPredictSchemata() *PredictSchemata

func (*Model) GetSupportedDeploymentResourcesTypes

func (x *Model) GetSupportedDeploymentResourcesTypes() []Model_DeploymentResourcesType

func (*Model) GetSupportedExportFormats

func (x *Model) GetSupportedExportFormats() []*Model_ExportFormat

func (*Model) GetSupportedInputStorageFormats

func (x *Model) GetSupportedInputStorageFormats() []string

func (*Model) GetSupportedOutputStorageFormats

func (x *Model) GetSupportedOutputStorageFormats() []string

func (*Model) GetTrainingPipeline

func (x *Model) GetTrainingPipeline() string

func (*Model) GetUpdateTime

func (x *Model) GetUpdateTime() *timestamppb.Timestamp

func (*Model) GetVersionAliases

func (x *Model) GetVersionAliases() []string

func (*Model) GetVersionCreateTime

func (x *Model) GetVersionCreateTime() *timestamppb.Timestamp

func (*Model) GetVersionDescription

func (x *Model) GetVersionDescription() string

func (*Model) GetVersionId

func (x *Model) GetVersionId() string

func (*Model) GetVersionUpdateTime

func (x *Model) GetVersionUpdateTime() *timestamppb.Timestamp

func (*Model) ProtoMessage

func (*Model) ProtoMessage()

func (*Model) ProtoReflect

func (x *Model) ProtoReflect() protoreflect.Message

func (*Model) Reset

func (x *Model) Reset()

func (*Model) String

func (x *Model) String() string

type ModelContainerSpec

type ModelContainerSpec struct {

	// Required. Immutable. URI of the Docker image to be used as the custom
	// container for serving predictions. This URI must identify an image in
	// Artifact Registry or Container Registry. Learn more about the [container
	// publishing
	// requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing),
	// including permissions requirements for the Vertex AI Service Agent.
	//
	// The container image is ingested upon
	// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel],
	// stored internally, and this original path is afterwards not used.
	//
	// To learn about the requirements for the Docker image itself, see
	// [Custom container
	// requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#).
	//
	// You can use the URI to one of Vertex AI's [pre-built container images for
	// prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers)
	// in this field.
	ImageUri string `protobuf:"bytes,1,opt,name=image_uri,json=imageUri,proto3" json:"image_uri,omitempty"`
	// Immutable. Specifies the command that runs when the container starts. This
	// overrides the container's
	// [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint).
	// Specify this field as an array of executable and arguments, similar to a
	// Docker `ENTRYPOINT`'s "exec" form, not its "shell" form.
	//
	// If you do not specify this field, then the container's `ENTRYPOINT` runs,
	// in conjunction with the
	// [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] field or the
	// container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd),
	// if either exists. If this field is not specified and the container does not
	// have an `ENTRYPOINT`, then refer to the Docker documentation about [how
	// `CMD` and `ENTRYPOINT`
	// interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact).
	//
	// If you specify this field, then you can also specify the `args` field to
	// provide additional arguments for this command. However, if you specify this
	// field, then the container's `CMD` is ignored. See the
	// [Kubernetes documentation about how the
	// `command` and `args` fields interact with a container's `ENTRYPOINT` and
	// `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes).
	//
	// In this field, you can reference [environment variables set by Vertex
	// AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables)
	// and environment variables set in the
	// [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field. You cannot
	// reference environment variables set in the Docker image. In order for
	// environment variables to be expanded, reference them by using the following
	// syntax: <code>$(<var>VARIABLE_NAME</var>)</code> Note that this differs
	// from Bash variable expansion, which does not use parentheses. If a variable
	// cannot be resolved, the reference in the input string is used unchanged. To
	// avoid variable expansion, you can escape this syntax with `$$`; for
	// example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds
	// to the `command` field of the Kubernetes Containers [v1 core
	// API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
	Command []string `protobuf:"bytes,2,rep,name=command,proto3" json:"command,omitempty"`
	// Immutable. Specifies arguments for the command that runs when the container
	// starts. This overrides the container's
	// [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify
	// this field as an array of executable and arguments, similar to a Docker
	// `CMD`'s "default parameters" form.
	//
	// If you don't specify this field but do specify the
	// [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] field,
	// then the command from the `command` field runs without any additional
	// arguments. See the [Kubernetes documentation about how the `command` and
	// `args` fields interact with a container's `ENTRYPOINT` and
	// `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes).
	//
	// If you don't specify this field and don't specify the `command` field,
	// then the container's
	// [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and
	// `CMD` determine what runs based on their default behavior. See the Docker
	// documentation about [how `CMD` and `ENTRYPOINT`
	// interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact).
	//
	// In this field, you can reference [environment variables
	// set by Vertex
	// AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables)
	// and environment variables set in the
	// [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field. You cannot
	// reference environment variables set in the Docker image. In order for
	// environment variables to be expanded, reference them by using the following
	// syntax: <code>$(<var>VARIABLE_NAME</var>)</code> Note that this differs
	// from Bash variable expansion, which does not use parentheses. If a variable
	// cannot be resolved, the reference in the input string is used unchanged. To
	// avoid variable expansion, you can escape this syntax with `$$`; for
	// example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds
	// to the `args` field of the Kubernetes Containers [v1 core
	// API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
	Args []string `protobuf:"bytes,3,rep,name=args,proto3" json:"args,omitempty"`
	// Immutable. List of environment variables to set in the container. After the
	// container starts running, code running in the container can read these
	// environment variables.
	//
	// Additionally, the
	// [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] and
	// [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] fields can
	// reference these variables. Later entries in this list can also reference
	// earlier entries. For example, the following example sets the variable
	// `VAR_2` to have the value `foo bar`:
	//
	// “`json
	// [
	//
	//	{
	//	  "name": "VAR_1",
	//	  "value": "foo"
	//	},
	//	{
	//	  "name": "VAR_2",
	//	  "value": "$(VAR_1) bar"
	//	}
	//
	// ]
	// “`
	//
	// If you switch the order of the variables in the example, then the expansion
	// does not occur.
	//
	// This field corresponds to the `env` field of the Kubernetes Containers
	// [v1 core
	// API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
	Env []*EnvVar `protobuf:"bytes,4,rep,name=env,proto3" json:"env,omitempty"`
	// Immutable. List of ports to expose from the container. Vertex AI sends any
	// prediction requests that it receives to the first port on this list. Vertex
	// AI also sends
	// [liveness and health
	// checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness)
	// to this port.
	//
	// If you do not specify this field, it defaults to following value:
	//
	// “`json
	// [
	//
	//	{
	//	  "containerPort": 8080
	//	}
	//
	// ]
	// “`
	//
	// Vertex AI does not use ports other than the first one listed. This field
	// corresponds to the `ports` field of the Kubernetes Containers
	// [v1 core
	// API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
	Ports []*Port `protobuf:"bytes,5,rep,name=ports,proto3" json:"ports,omitempty"`
	// Immutable. HTTP path on the container to send prediction requests to.
	// Vertex AI forwards requests sent using
	// [projects.locations.endpoints.predict][google.cloud.aiplatform.v1.PredictionService.Predict]
	// to this path on the container's IP address and port. Vertex AI then returns
	// the container's response in the API response.
	//
	// For example, if you set this field to `/foo`, then when Vertex AI
	// receives a prediction request, it forwards the request body in a POST
	// request to the `/foo` path on the port of your container specified by the
	// first value of this `ModelContainerSpec`'s
	// [ports][google.cloud.aiplatform.v1.ModelContainerSpec.ports] field.
	//
	// If you don't specify this field, it defaults to the following value when
	// you [deploy this Model to an
	// Endpoint][google.cloud.aiplatform.v1.EndpointService.DeployModel]:
	// <code>/v1/endpoints/<var>ENDPOINT</var>/deployedModels/<var>DEPLOYED_MODEL</var>:predict</code>
	// The placeholders in this value are replaced as follows:
	//
	//   - <var>ENDPOINT</var>: The last segment (following `endpoints/`)of the
	//     Endpoint.name][] field of the Endpoint where this Model has been
	//     deployed. (Vertex AI makes this value available to your container code
	//     as the [`AIP_ENDPOINT_ID` environment
	//     variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
	//
	// * <var>DEPLOYED_MODEL</var>:
	// [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the
	// `DeployedModel`.
	//
	//	(Vertex AI makes this value available to your container code
	//	as the [`AIP_DEPLOYED_MODEL_ID` environment
	//	variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
	PredictRoute string `protobuf:"bytes,6,opt,name=predict_route,json=predictRoute,proto3" json:"predict_route,omitempty"`
	// Immutable. HTTP path on the container to send health checks to. Vertex AI
	// intermittently sends GET requests to this path on the container's IP
	// address and port to check that the container is healthy. Read more about
	// [health
	// checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health).
	//
	// For example, if you set this field to `/bar`, then Vertex AI
	// intermittently sends a GET request to the `/bar` path on the port of your
	// container specified by the first value of this `ModelContainerSpec`'s
	// [ports][google.cloud.aiplatform.v1.ModelContainerSpec.ports] field.
	//
	// If you don't specify this field, it defaults to the following value when
	// you [deploy this Model to an
	// Endpoint][google.cloud.aiplatform.v1.EndpointService.DeployModel]:
	// <code>/v1/endpoints/<var>ENDPOINT</var>/deployedModels/<var>DEPLOYED_MODEL</var>:predict</code>
	// The placeholders in this value are replaced as follows:
	//
	//   - <var>ENDPOINT</var>: The last segment (following `endpoints/`)of the
	//     Endpoint.name][] field of the Endpoint where this Model has been
	//     deployed. (Vertex AI makes this value available to your container code
	//     as the [`AIP_ENDPOINT_ID` environment
	//     variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
	//
	// * <var>DEPLOYED_MODEL</var>:
	// [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the
	// `DeployedModel`.
	//
	//	(Vertex AI makes this value available to your container code as the
	//	[`AIP_DEPLOYED_MODEL_ID` environment
	//	variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
	HealthRoute string `protobuf:"bytes,7,opt,name=health_route,json=healthRoute,proto3" json:"health_route,omitempty"`
	// Immutable. List of ports to expose from the container. Vertex AI sends gRPC
	// prediction requests that it receives to the first port on this list. Vertex
	// AI also sends liveness and health checks to this port.
	//
	// If you do not specify this field, gRPC requests to the container will be
	// disabled.
	//
	// Vertex AI does not use ports other than the first one listed. This field
	// corresponds to the `ports` field of the Kubernetes Containers v1 core API.
	GrpcPorts []*Port `protobuf:"bytes,9,rep,name=grpc_ports,json=grpcPorts,proto3" json:"grpc_ports,omitempty"`
	// Immutable. Deployment timeout.
	// Limit for deployment timeout is 2 hours.
	DeploymentTimeout *durationpb.Duration `protobuf:"bytes,10,opt,name=deployment_timeout,json=deploymentTimeout,proto3" json:"deployment_timeout,omitempty"`
	// Immutable. The amount of the VM memory to reserve as the shared memory for
	// the model in megabytes.
	SharedMemorySizeMb int64 `protobuf:"varint,11,opt,name=shared_memory_size_mb,json=sharedMemorySizeMb,proto3" json:"shared_memory_size_mb,omitempty"`
	// Immutable. Specification for Kubernetes startup probe.
	StartupProbe *Probe `protobuf:"bytes,12,opt,name=startup_probe,json=startupProbe,proto3" json:"startup_probe,omitempty"`
	// Immutable. Specification for Kubernetes readiness probe.
	HealthProbe *Probe `protobuf:"bytes,13,opt,name=health_probe,json=healthProbe,proto3" json:"health_probe,omitempty"`
	// contains filtered or unexported fields
}

Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).

func (*ModelContainerSpec) Descriptor deprecated

func (*ModelContainerSpec) Descriptor() ([]byte, []int)

Deprecated: Use ModelContainerSpec.ProtoReflect.Descriptor instead.

func (*ModelContainerSpec) GetArgs

func (x *ModelContainerSpec) GetArgs() []string

func (*ModelContainerSpec) GetCommand

func (x *ModelContainerSpec) GetCommand() []string

func (*ModelContainerSpec) GetDeploymentTimeout added in v1.54.0

func (x *ModelContainerSpec) GetDeploymentTimeout() *durationpb.Duration

func (*ModelContainerSpec) GetEnv

func (x *ModelContainerSpec) GetEnv() []*EnvVar

func (*ModelContainerSpec) GetGrpcPorts added in v1.55.0

func (x *ModelContainerSpec) GetGrpcPorts() []*Port

func (*ModelContainerSpec) GetHealthProbe added in v1.54.0

func (x *ModelContainerSpec) GetHealthProbe() *Probe

func (*ModelContainerSpec) GetHealthRoute

func (x *ModelContainerSpec) GetHealthRoute() string

func (*ModelContainerSpec) GetImageUri

func (x *ModelContainerSpec) GetImageUri() string

func (*ModelContainerSpec) GetPorts

func (x *ModelContainerSpec) GetPorts() []*Port

func (*ModelContainerSpec) GetPredictRoute

func (x *ModelContainerSpec) GetPredictRoute() string

func (*ModelContainerSpec) GetSharedMemorySizeMb added in v1.54.0

func (x *ModelContainerSpec) GetSharedMemorySizeMb() int64

func (*ModelContainerSpec) GetStartupProbe added in v1.54.0

func (x *ModelContainerSpec) GetStartupProbe() *Probe

func (*ModelContainerSpec) ProtoMessage

func (*ModelContainerSpec) ProtoMessage()

func (*ModelContainerSpec) ProtoReflect

func (x *ModelContainerSpec) ProtoReflect() protoreflect.Message

func (*ModelContainerSpec) Reset

func (x *ModelContainerSpec) Reset()

func (*ModelContainerSpec) String

func (x *ModelContainerSpec) String() string

type ModelDeploymentMonitoringBigQueryTable

type ModelDeploymentMonitoringBigQueryTable struct {

	// The source of log.
	LogSource ModelDeploymentMonitoringBigQueryTable_LogSource `` /* 170-byte string literal not displayed */
	// The type of log.
	LogType ModelDeploymentMonitoringBigQueryTable_LogType `` /* 162-byte string literal not displayed */
	// The created BigQuery table to store logs. Customer could do their own query
	// & analysis. Format:
	// `bq://<project_id>.model_deployment_monitoring_<endpoint_id>.<tolower(log_source)>_<tolower(log_type)>`
	BigqueryTablePath string `protobuf:"bytes,3,opt,name=bigquery_table_path,json=bigqueryTablePath,proto3" json:"bigquery_table_path,omitempty"`
	// Output only. The schema version of the request/response logging BigQuery
	// table. Default to v1 if unset.
	RequestResponseLoggingSchemaVersion string `` /* 172-byte string literal not displayed */
	// contains filtered or unexported fields
}

ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name as well as some information of the logs stored in this table.

func (*ModelDeploymentMonitoringBigQueryTable) Descriptor deprecated

func (*ModelDeploymentMonitoringBigQueryTable) Descriptor() ([]byte, []int)

Deprecated: Use ModelDeploymentMonitoringBigQueryTable.ProtoReflect.Descriptor instead.

func (*ModelDeploymentMonitoringBigQueryTable) GetBigqueryTablePath

func (x *ModelDeploymentMonitoringBigQueryTable) GetBigqueryTablePath() string

func (*ModelDeploymentMonitoringBigQueryTable) GetLogSource

func (*ModelDeploymentMonitoringBigQueryTable) GetLogType

func (*ModelDeploymentMonitoringBigQueryTable) GetRequestResponseLoggingSchemaVersion added in v1.60.0

func (x *ModelDeploymentMonitoringBigQueryTable) GetRequestResponseLoggingSchemaVersion() string

func (*ModelDeploymentMonitoringBigQueryTable) ProtoMessage

func (*ModelDeploymentMonitoringBigQueryTable) ProtoReflect

func (*ModelDeploymentMonitoringBigQueryTable) Reset

func (*ModelDeploymentMonitoringBigQueryTable) String

type ModelDeploymentMonitoringBigQueryTable_LogSource

type ModelDeploymentMonitoringBigQueryTable_LogSource int32

Indicates where does the log come from.

const (
	// Unspecified source.
	ModelDeploymentMonitoringBigQueryTable_LOG_SOURCE_UNSPECIFIED ModelDeploymentMonitoringBigQueryTable_LogSource = 0
	// Logs coming from Training dataset.
	ModelDeploymentMonitoringBigQueryTable_TRAINING ModelDeploymentMonitoringBigQueryTable_LogSource = 1
	// Logs coming from Serving traffic.
	ModelDeploymentMonitoringBigQueryTable_SERVING ModelDeploymentMonitoringBigQueryTable_LogSource = 2
)

func (ModelDeploymentMonitoringBigQueryTable_LogSource) Descriptor

func (ModelDeploymentMonitoringBigQueryTable_LogSource) Enum

func (ModelDeploymentMonitoringBigQueryTable_LogSource) EnumDescriptor deprecated

Deprecated: Use ModelDeploymentMonitoringBigQueryTable_LogSource.Descriptor instead.

func (ModelDeploymentMonitoringBigQueryTable_LogSource) Number

func (ModelDeploymentMonitoringBigQueryTable_LogSource) String

func (ModelDeploymentMonitoringBigQueryTable_LogSource) Type

type ModelDeploymentMonitoringBigQueryTable_LogType

type ModelDeploymentMonitoringBigQueryTable_LogType int32

Indicates what type of traffic does the log belong to.

const (
	// Unspecified type.
	ModelDeploymentMonitoringBigQueryTable_LOG_TYPE_UNSPECIFIED ModelDeploymentMonitoringBigQueryTable_LogType = 0
	// Predict logs.
	ModelDeploymentMonitoringBigQueryTable_PREDICT ModelDeploymentMonitoringBigQueryTable_LogType = 1
	// Explain logs.
	ModelDeploymentMonitoringBigQueryTable_EXPLAIN ModelDeploymentMonitoringBigQueryTable_LogType = 2
)

func (ModelDeploymentMonitoringBigQueryTable_LogType) Descriptor

func (ModelDeploymentMonitoringBigQueryTable_LogType) Enum

func (ModelDeploymentMonitoringBigQueryTable_LogType) EnumDescriptor deprecated

Deprecated: Use ModelDeploymentMonitoringBigQueryTable_LogType.Descriptor instead.

func (ModelDeploymentMonitoringBigQueryTable_LogType) Number

func (ModelDeploymentMonitoringBigQueryTable_LogType) String

func (ModelDeploymentMonitoringBigQueryTable_LogType) Type

type ModelDeploymentMonitoringJob

type ModelDeploymentMonitoringJob struct {

	// Output only. Resource name of a ModelDeploymentMonitoringJob.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The user-defined name of the ModelDeploymentMonitoringJob.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	// Display name of a ModelDeploymentMonitoringJob.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Required. Endpoint resource name.
	// Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,3,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Output only. The detailed state of the monitoring job.
	// When the job is still creating, the state will be 'PENDING'.
	// Once the job is successfully created, the state will be 'RUNNING'.
	// Pause the job, the state will be 'PAUSED'.
	// Resume the job, the state will return to 'RUNNING'.
	State JobState `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.JobState" json:"state,omitempty"`
	// Output only. Schedule state when the monitoring job is in Running state.
	ScheduleState ModelDeploymentMonitoringJob_MonitoringScheduleState `` /* 186-byte string literal not displayed */
	// Output only. Latest triggered monitoring pipeline metadata.
	LatestMonitoringPipelineMetadata *ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata `` /* 162-byte string literal not displayed */
	// Required. The config for monitoring objectives. This is a per DeployedModel
	// config. Each DeployedModel needs to be configured separately.
	ModelDeploymentMonitoringObjectiveConfigs []*ModelDeploymentMonitoringObjectiveConfig `` /* 190-byte string literal not displayed */
	// Required. Schedule config for running the monitoring job.
	ModelDeploymentMonitoringScheduleConfig *ModelDeploymentMonitoringScheduleConfig `` /* 184-byte string literal not displayed */
	// Required. Sample Strategy for logging.
	LoggingSamplingStrategy *SamplingStrategy `` /* 132-byte string literal not displayed */
	// Alert config for model monitoring.
	ModelMonitoringAlertConfig *ModelMonitoringAlertConfig `` /* 144-byte string literal not displayed */
	// YAML schema file uri describing the format of a single instance,
	// which are given to format this Endpoint's prediction (and explanation).
	// If not set, we will generate predict schema from collected predict
	// requests.
	PredictInstanceSchemaUri string `` /* 137-byte string literal not displayed */
	// Sample Predict instance, same format as
	// [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
	// this can be set as a replacement of
	// [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri].
	// If not set, we will generate predict schema from collected predict
	// requests.
	SamplePredictInstance *structpb.Value `` /* 127-byte string literal not displayed */
	// YAML schema file uri describing the format of a single instance that you
	// want Tensorflow Data Validation (TFDV) to analyze.
	//
	// If this field is empty, all the feature data types are inferred from
	// [predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri],
	// meaning that TFDV will use the data in the exact format(data type) as
	// prediction request/response.
	// If there are any data type differences between predict instance and TFDV
	// instance, this field can be used to override the schema.
	// For models trained with Vertex AI, this field must be set as all the
	// fields in predict instance formatted as string.
	AnalysisInstanceSchemaUri string `` /* 141-byte string literal not displayed */
	// Output only. The created bigquery tables for the job under customer
	// project. Customer could do their own query & analysis. There could be 4 log
	// tables in maximum:
	// 1. Training data logging predict request/response
	// 2. Serving data logging predict request/response
	BigqueryTables []*ModelDeploymentMonitoringBigQueryTable `protobuf:"bytes,10,rep,name=bigquery_tables,json=bigqueryTables,proto3" json:"bigquery_tables,omitempty"`
	// The TTL of BigQuery tables in user projects which stores logs.
	// A day is the basic unit of the TTL and we take the ceil of TTL/86400(a
	// day). e.g. { second: 3600} indicates ttl = 1 day.
	LogTtl *durationpb.Duration `protobuf:"bytes,17,opt,name=log_ttl,json=logTtl,proto3" json:"log_ttl,omitempty"`
	// The labels with user-defined metadata to organize your
	// ModelDeploymentMonitoringJob.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Output only. Timestamp when this ModelDeploymentMonitoringJob was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this ModelDeploymentMonitoringJob was updated
	// most recently.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Timestamp when this monitoring pipeline will be scheduled to
	// run for the next round.
	NextScheduleTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=next_schedule_time,json=nextScheduleTime,proto3" json:"next_schedule_time,omitempty"`
	// Stats anomalies base folder path.
	StatsAnomaliesBaseDirectory *GcsDestination `` /* 147-byte string literal not displayed */
	// Customer-managed encryption key spec for a ModelDeploymentMonitoringJob. If
	// set, this ModelDeploymentMonitoringJob and all sub-resources of this
	// ModelDeploymentMonitoringJob will be secured by this key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,21,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// If true, the scheduled monitoring pipeline logs are sent to
	// Google Cloud Logging, including pipeline status and anomalies detected.
	// Please note the logs incur cost, which are subject to [Cloud Logging
	// pricing](https://cloud.google.com/logging#pricing).
	EnableMonitoringPipelineLogs bool `` /* 151-byte string literal not displayed */
	// Output only. Only populated when the job's state is `JOB_STATE_FAILED` or
	// `JOB_STATE_CANCELLED`.
	Error *status.Status `protobuf:"bytes,23,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

Represents a job that runs periodically to monitor the deployed models in an endpoint. It will analyze the logged training & prediction data to detect any abnormal behaviors.

func (*ModelDeploymentMonitoringJob) Descriptor deprecated

func (*ModelDeploymentMonitoringJob) Descriptor() ([]byte, []int)

Deprecated: Use ModelDeploymentMonitoringJob.ProtoReflect.Descriptor instead.

func (*ModelDeploymentMonitoringJob) GetAnalysisInstanceSchemaUri

func (x *ModelDeploymentMonitoringJob) GetAnalysisInstanceSchemaUri() string

func (*ModelDeploymentMonitoringJob) GetBigqueryTables

func (*ModelDeploymentMonitoringJob) GetCreateTime

func (*ModelDeploymentMonitoringJob) GetDisplayName

func (x *ModelDeploymentMonitoringJob) GetDisplayName() string

func (*ModelDeploymentMonitoringJob) GetEnableMonitoringPipelineLogs

func (x *ModelDeploymentMonitoringJob) GetEnableMonitoringPipelineLogs() bool

func (*ModelDeploymentMonitoringJob) GetEncryptionSpec

func (x *ModelDeploymentMonitoringJob) GetEncryptionSpec() *EncryptionSpec

func (*ModelDeploymentMonitoringJob) GetEndpoint

func (x *ModelDeploymentMonitoringJob) GetEndpoint() string

func (*ModelDeploymentMonitoringJob) GetError

func (*ModelDeploymentMonitoringJob) GetLabels

func (x *ModelDeploymentMonitoringJob) GetLabels() map[string]string

func (*ModelDeploymentMonitoringJob) GetLatestMonitoringPipelineMetadata

func (*ModelDeploymentMonitoringJob) GetLogTtl

func (*ModelDeploymentMonitoringJob) GetLoggingSamplingStrategy

func (x *ModelDeploymentMonitoringJob) GetLoggingSamplingStrategy() *SamplingStrategy

func (*ModelDeploymentMonitoringJob) GetModelDeploymentMonitoringObjectiveConfigs

func (x *ModelDeploymentMonitoringJob) GetModelDeploymentMonitoringObjectiveConfigs() []*ModelDeploymentMonitoringObjectiveConfig

func (*ModelDeploymentMonitoringJob) GetModelDeploymentMonitoringScheduleConfig

func (x *ModelDeploymentMonitoringJob) GetModelDeploymentMonitoringScheduleConfig() *ModelDeploymentMonitoringScheduleConfig

func (*ModelDeploymentMonitoringJob) GetModelMonitoringAlertConfig

func (x *ModelDeploymentMonitoringJob) GetModelMonitoringAlertConfig() *ModelMonitoringAlertConfig

func (*ModelDeploymentMonitoringJob) GetName

func (x *ModelDeploymentMonitoringJob) GetName() string

func (*ModelDeploymentMonitoringJob) GetNextScheduleTime

func (x *ModelDeploymentMonitoringJob) GetNextScheduleTime() *timestamppb.Timestamp

func (*ModelDeploymentMonitoringJob) GetPredictInstanceSchemaUri

func (x *ModelDeploymentMonitoringJob) GetPredictInstanceSchemaUri() string

func (*ModelDeploymentMonitoringJob) GetSamplePredictInstance

func (x *ModelDeploymentMonitoringJob) GetSamplePredictInstance() *structpb.Value

func (*ModelDeploymentMonitoringJob) GetScheduleState

func (*ModelDeploymentMonitoringJob) GetState

func (x *ModelDeploymentMonitoringJob) GetState() JobState

func (*ModelDeploymentMonitoringJob) GetStatsAnomaliesBaseDirectory

func (x *ModelDeploymentMonitoringJob) GetStatsAnomaliesBaseDirectory() *GcsDestination

func (*ModelDeploymentMonitoringJob) GetUpdateTime

func (*ModelDeploymentMonitoringJob) ProtoMessage

func (*ModelDeploymentMonitoringJob) ProtoMessage()

func (*ModelDeploymentMonitoringJob) ProtoReflect

func (*ModelDeploymentMonitoringJob) Reset

func (x *ModelDeploymentMonitoringJob) Reset()

func (*ModelDeploymentMonitoringJob) String

type ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata

type ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata struct {

	// The time that most recent monitoring pipelines that is related to this
	// run.
	RunTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=run_time,json=runTime,proto3" json:"run_time,omitempty"`
	// The status of the most recent monitoring pipeline.
	Status *status.Status `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

All metadata of most recent monitoring pipelines.

func (*ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata) Descriptor deprecated

Deprecated: Use ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata.ProtoReflect.Descriptor instead.

func (*ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata) GetRunTime

func (*ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata) GetStatus

func (*ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata) ProtoMessage

func (*ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata) ProtoReflect

func (*ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata) Reset

func (*ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata) String

type ModelDeploymentMonitoringJob_MonitoringScheduleState

type ModelDeploymentMonitoringJob_MonitoringScheduleState int32

The state to Specify the monitoring pipeline.

const (
	// Unspecified state.
	ModelDeploymentMonitoringJob_MONITORING_SCHEDULE_STATE_UNSPECIFIED ModelDeploymentMonitoringJob_MonitoringScheduleState = 0
	// The pipeline is picked up and wait to run.
	ModelDeploymentMonitoringJob_PENDING ModelDeploymentMonitoringJob_MonitoringScheduleState = 1
	// The pipeline is offline and will be scheduled for next run.
	ModelDeploymentMonitoringJob_OFFLINE ModelDeploymentMonitoringJob_MonitoringScheduleState = 2
	// The pipeline is running.
	ModelDeploymentMonitoringJob_RUNNING ModelDeploymentMonitoringJob_MonitoringScheduleState = 3
)

func (ModelDeploymentMonitoringJob_MonitoringScheduleState) Descriptor

func (ModelDeploymentMonitoringJob_MonitoringScheduleState) Enum

func (ModelDeploymentMonitoringJob_MonitoringScheduleState) EnumDescriptor deprecated

Deprecated: Use ModelDeploymentMonitoringJob_MonitoringScheduleState.Descriptor instead.

func (ModelDeploymentMonitoringJob_MonitoringScheduleState) Number

func (ModelDeploymentMonitoringJob_MonitoringScheduleState) String

func (ModelDeploymentMonitoringJob_MonitoringScheduleState) Type

type ModelDeploymentMonitoringObjectiveConfig

type ModelDeploymentMonitoringObjectiveConfig struct {

	// The DeployedModel ID of the objective config.
	DeployedModelId string `protobuf:"bytes,1,opt,name=deployed_model_id,json=deployedModelId,proto3" json:"deployed_model_id,omitempty"`
	// The objective config of for the modelmonitoring job of this deployed model.
	ObjectiveConfig *ModelMonitoringObjectiveConfig `protobuf:"bytes,2,opt,name=objective_config,json=objectiveConfig,proto3" json:"objective_config,omitempty"`
	// contains filtered or unexported fields
}

ModelDeploymentMonitoringObjectiveConfig contains the pair of deployed_model_id to ModelMonitoringObjectiveConfig.

func (*ModelDeploymentMonitoringObjectiveConfig) Descriptor deprecated

func (*ModelDeploymentMonitoringObjectiveConfig) Descriptor() ([]byte, []int)

Deprecated: Use ModelDeploymentMonitoringObjectiveConfig.ProtoReflect.Descriptor instead.

func (*ModelDeploymentMonitoringObjectiveConfig) GetDeployedModelId

func (x *ModelDeploymentMonitoringObjectiveConfig) GetDeployedModelId() string

func (*ModelDeploymentMonitoringObjectiveConfig) GetObjectiveConfig

func (*ModelDeploymentMonitoringObjectiveConfig) ProtoMessage

func (*ModelDeploymentMonitoringObjectiveConfig) ProtoReflect

func (*ModelDeploymentMonitoringObjectiveConfig) Reset

func (*ModelDeploymentMonitoringObjectiveConfig) String

type ModelDeploymentMonitoringObjectiveType

type ModelDeploymentMonitoringObjectiveType int32

The Model Monitoring Objective types.

const (
	// Default value, should not be set.
	ModelDeploymentMonitoringObjectiveType_MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED ModelDeploymentMonitoringObjectiveType = 0
	// Raw feature values' stats to detect skew between Training-Prediction
	// datasets.
	ModelDeploymentMonitoringObjectiveType_RAW_FEATURE_SKEW ModelDeploymentMonitoringObjectiveType = 1
	// Raw feature values' stats to detect drift between Serving-Prediction
	// datasets.
	ModelDeploymentMonitoringObjectiveType_RAW_FEATURE_DRIFT ModelDeploymentMonitoringObjectiveType = 2
	// Feature attribution scores to detect skew between Training-Prediction
	// datasets.
	ModelDeploymentMonitoringObjectiveType_FEATURE_ATTRIBUTION_SKEW ModelDeploymentMonitoringObjectiveType = 3
	// Feature attribution scores to detect skew between Prediction datasets
	// collected within different time windows.
	ModelDeploymentMonitoringObjectiveType_FEATURE_ATTRIBUTION_DRIFT ModelDeploymentMonitoringObjectiveType = 4
)

func (ModelDeploymentMonitoringObjectiveType) Descriptor

func (ModelDeploymentMonitoringObjectiveType) Enum

func (ModelDeploymentMonitoringObjectiveType) EnumDescriptor deprecated

func (ModelDeploymentMonitoringObjectiveType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ModelDeploymentMonitoringObjectiveType.Descriptor instead.

func (ModelDeploymentMonitoringObjectiveType) Number

func (ModelDeploymentMonitoringObjectiveType) String

func (ModelDeploymentMonitoringObjectiveType) Type

type ModelDeploymentMonitoringScheduleConfig

type ModelDeploymentMonitoringScheduleConfig struct {

	// Required. The model monitoring job scheduling interval. It will be rounded
	// up to next full hour. This defines how often the monitoring jobs are
	// triggered.
	MonitorInterval *durationpb.Duration `protobuf:"bytes,1,opt,name=monitor_interval,json=monitorInterval,proto3" json:"monitor_interval,omitempty"`
	// The time window of the prediction data being included in each prediction
	// dataset. This window specifies how long the data should be collected from
	// historical model results for each run. If not set,
	// [ModelDeploymentMonitoringScheduleConfig.monitor_interval][google.cloud.aiplatform.v1.ModelDeploymentMonitoringScheduleConfig.monitor_interval]
	// will be used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and
	// the monitor_window is set to be 3600, then data from 2022-01-08 13:30:00 to
	// 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the
	// monitoring statistics.
	MonitorWindow *durationpb.Duration `protobuf:"bytes,2,opt,name=monitor_window,json=monitorWindow,proto3" json:"monitor_window,omitempty"`
	// contains filtered or unexported fields
}

The config for scheduling monitoring job.

func (*ModelDeploymentMonitoringScheduleConfig) Descriptor deprecated

func (*ModelDeploymentMonitoringScheduleConfig) Descriptor() ([]byte, []int)

Deprecated: Use ModelDeploymentMonitoringScheduleConfig.ProtoReflect.Descriptor instead.

func (*ModelDeploymentMonitoringScheduleConfig) GetMonitorInterval

func (*ModelDeploymentMonitoringScheduleConfig) GetMonitorWindow

func (*ModelDeploymentMonitoringScheduleConfig) ProtoMessage

func (*ModelDeploymentMonitoringScheduleConfig) ProtoReflect

func (*ModelDeploymentMonitoringScheduleConfig) Reset

func (*ModelDeploymentMonitoringScheduleConfig) String

type ModelEvaluation

type ModelEvaluation struct {

	// Output only. The resource name of the ModelEvaluation.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The display name of the ModelEvaluation.
	DisplayName string `protobuf:"bytes,10,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Points to a YAML file stored on Google Cloud Storage describing the
	// [metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this
	// ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	MetricsSchemaUri string `protobuf:"bytes,2,opt,name=metrics_schema_uri,json=metricsSchemaUri,proto3" json:"metrics_schema_uri,omitempty"`
	// Evaluation metrics of the Model. The schema of the metrics is stored in
	// [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.metrics_schema_uri]
	Metrics *structpb.Value `protobuf:"bytes,3,opt,name=metrics,proto3" json:"metrics,omitempty"`
	// Output only. Timestamp when this ModelEvaluation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// All possible
	// [dimensions][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.dimension]
	// of ModelEvaluationSlices. The dimensions can be used as the filter of the
	// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]
	// request, in the form of `slice.dimension = <dimension>`.
	SliceDimensions []string `protobuf:"bytes,5,rep,name=slice_dimensions,json=sliceDimensions,proto3" json:"slice_dimensions,omitempty"`
	// Points to a YAML file stored on Google Cloud Storage describing
	// [EvaluatedDataItemView.data_item_payload][] and
	// [EvaluatedAnnotation.data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].
	// The schema is defined as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	//
	// This field is not populated if there are neither EvaluatedDataItemViews nor
	// EvaluatedAnnotations under this ModelEvaluation.
	DataItemSchemaUri string `protobuf:"bytes,6,opt,name=data_item_schema_uri,json=dataItemSchemaUri,proto3" json:"data_item_schema_uri,omitempty"`
	// Points to a YAML file stored on Google Cloud Storage describing
	// [EvaluatedDataItemView.predictions][],
	// [EvaluatedDataItemView.ground_truths][],
	// [EvaluatedAnnotation.predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions],
	// and
	// [EvaluatedAnnotation.ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths].
	// The schema is defined as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	//
	// This field is not populated if there are neither EvaluatedDataItemViews nor
	// EvaluatedAnnotations under this ModelEvaluation.
	AnnotationSchemaUri string `protobuf:"bytes,7,opt,name=annotation_schema_uri,json=annotationSchemaUri,proto3" json:"annotation_schema_uri,omitempty"`
	// Aggregated explanation metrics for the Model's prediction output over the
	// data this ModelEvaluation uses. This field is populated only if the Model
	// is evaluated with explanations, and only for AutoML tabular Models.
	ModelExplanation *ModelExplanation `protobuf:"bytes,8,opt,name=model_explanation,json=modelExplanation,proto3" json:"model_explanation,omitempty"`
	// Describes the values of
	// [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used
	// for explaining the predicted values on the evaluated data.
	ExplanationSpecs []*ModelEvaluation_ModelEvaluationExplanationSpec `protobuf:"bytes,9,rep,name=explanation_specs,json=explanationSpecs,proto3" json:"explanation_specs,omitempty"`
	// The metadata of the ModelEvaluation.
	// For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a
	// structured value with keys of "pipeline_job_id", "evaluation_dataset_type",
	// "evaluation_dataset_path", "row_based_metrics_path".
	Metadata *structpb.Value `protobuf:"bytes,11,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

A collection of metrics calculated by comparing Model's predictions on all of the test data against annotations from the test data.

func (*ModelEvaluation) Descriptor deprecated

func (*ModelEvaluation) Descriptor() ([]byte, []int)

Deprecated: Use ModelEvaluation.ProtoReflect.Descriptor instead.

func (*ModelEvaluation) GetAnnotationSchemaUri

func (x *ModelEvaluation) GetAnnotationSchemaUri() string

func (*ModelEvaluation) GetCreateTime

func (x *ModelEvaluation) GetCreateTime() *timestamppb.Timestamp

func (*ModelEvaluation) GetDataItemSchemaUri

func (x *ModelEvaluation) GetDataItemSchemaUri() string

func (*ModelEvaluation) GetDisplayName

func (x *ModelEvaluation) GetDisplayName() string

func (*ModelEvaluation) GetExplanationSpecs

func (*ModelEvaluation) GetMetadata

func (x *ModelEvaluation) GetMetadata() *structpb.Value

func (*ModelEvaluation) GetMetrics

func (x *ModelEvaluation) GetMetrics() *structpb.Value

func (*ModelEvaluation) GetMetricsSchemaUri

func (x *ModelEvaluation) GetMetricsSchemaUri() string

func (*ModelEvaluation) GetModelExplanation

func (x *ModelEvaluation) GetModelExplanation() *ModelExplanation

func (*ModelEvaluation) GetName

func (x *ModelEvaluation) GetName() string

func (*ModelEvaluation) GetSliceDimensions

func (x *ModelEvaluation) GetSliceDimensions() []string

func (*ModelEvaluation) ProtoMessage

func (*ModelEvaluation) ProtoMessage()

func (*ModelEvaluation) ProtoReflect

func (x *ModelEvaluation) ProtoReflect() protoreflect.Message

func (*ModelEvaluation) Reset

func (x *ModelEvaluation) Reset()

func (*ModelEvaluation) String

func (x *ModelEvaluation) String() string

type ModelEvaluationSlice

type ModelEvaluationSlice struct {

	// Output only. The resource name of the ModelEvaluationSlice.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The slice of the test data that is used to evaluate the Model.
	Slice *ModelEvaluationSlice_Slice `protobuf:"bytes,2,opt,name=slice,proto3" json:"slice,omitempty"`
	// Output only. Points to a YAML file stored on Google Cloud Storage
	// describing the
	// [metrics][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics] of this
	// ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	MetricsSchemaUri string `protobuf:"bytes,3,opt,name=metrics_schema_uri,json=metricsSchemaUri,proto3" json:"metrics_schema_uri,omitempty"`
	// Output only. Sliced evaluation metrics of the Model. The schema of the
	// metrics is stored in
	// [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics_schema_uri]
	Metrics *structpb.Value `protobuf:"bytes,4,opt,name=metrics,proto3" json:"metrics,omitempty"`
	// Output only. Timestamp when this ModelEvaluationSlice was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Aggregated explanation metrics for the Model's prediction
	// output over the data this ModelEvaluation uses. This field is populated
	// only if the Model is evaluated with explanations, and only for tabular
	// Models.
	ModelExplanation *ModelExplanation `protobuf:"bytes,6,opt,name=model_explanation,json=modelExplanation,proto3" json:"model_explanation,omitempty"`
	// contains filtered or unexported fields
}

A collection of metrics calculated by comparing Model's predictions on a slice of the test data against ground truth annotations.

func (*ModelEvaluationSlice) Descriptor deprecated

func (*ModelEvaluationSlice) Descriptor() ([]byte, []int)

Deprecated: Use ModelEvaluationSlice.ProtoReflect.Descriptor instead.

func (*ModelEvaluationSlice) GetCreateTime

func (x *ModelEvaluationSlice) GetCreateTime() *timestamppb.Timestamp

func (*ModelEvaluationSlice) GetMetrics

func (x *ModelEvaluationSlice) GetMetrics() *structpb.Value

func (*ModelEvaluationSlice) GetMetricsSchemaUri

func (x *ModelEvaluationSlice) GetMetricsSchemaUri() string

func (*ModelEvaluationSlice) GetModelExplanation added in v1.36.0

func (x *ModelEvaluationSlice) GetModelExplanation() *ModelExplanation

func (*ModelEvaluationSlice) GetName

func (x *ModelEvaluationSlice) GetName() string

func (*ModelEvaluationSlice) GetSlice

func (*ModelEvaluationSlice) ProtoMessage

func (*ModelEvaluationSlice) ProtoMessage()

func (*ModelEvaluationSlice) ProtoReflect

func (x *ModelEvaluationSlice) ProtoReflect() protoreflect.Message

func (*ModelEvaluationSlice) Reset

func (x *ModelEvaluationSlice) Reset()

func (*ModelEvaluationSlice) String

func (x *ModelEvaluationSlice) String() string

type ModelEvaluationSlice_Slice

type ModelEvaluationSlice_Slice struct {

	// Output only. The dimension of the slice.
	// Well-known dimensions are:
	//   - `annotationSpec`: This slice is on the test data that has either
	//     ground truth or prediction with
	//     [AnnotationSpec.display_name][google.cloud.aiplatform.v1.AnnotationSpec.display_name]
	//     equals to
	//     [value][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.value].
	//   - `slice`: This slice is a user customized slice defined by its
	//     SliceSpec.
	Dimension string `protobuf:"bytes,1,opt,name=dimension,proto3" json:"dimension,omitempty"`
	// Output only. The value of the dimension in this slice.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// Output only. Specification for how the data was sliced.
	SliceSpec *ModelEvaluationSlice_Slice_SliceSpec `protobuf:"bytes,3,opt,name=slice_spec,json=sliceSpec,proto3" json:"slice_spec,omitempty"`
	// contains filtered or unexported fields
}

Definition of a slice.

func (*ModelEvaluationSlice_Slice) Descriptor deprecated

func (*ModelEvaluationSlice_Slice) Descriptor() ([]byte, []int)

Deprecated: Use ModelEvaluationSlice_Slice.ProtoReflect.Descriptor instead.

func (*ModelEvaluationSlice_Slice) GetDimension

func (x *ModelEvaluationSlice_Slice) GetDimension() string

func (*ModelEvaluationSlice_Slice) GetSliceSpec added in v1.36.0

func (*ModelEvaluationSlice_Slice) GetValue

func (x *ModelEvaluationSlice_Slice) GetValue() string

func (*ModelEvaluationSlice_Slice) ProtoMessage

func (*ModelEvaluationSlice_Slice) ProtoMessage()

func (*ModelEvaluationSlice_Slice) ProtoReflect

func (*ModelEvaluationSlice_Slice) Reset

func (x *ModelEvaluationSlice_Slice) Reset()

func (*ModelEvaluationSlice_Slice) String

func (x *ModelEvaluationSlice_Slice) String() string

type ModelEvaluationSlice_Slice_SliceSpec added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec struct {

	// Mapping configuration for this SliceSpec.
	// The key is the name of the feature.
	// By default, the key will be prefixed by "instance" as a dictionary
	// prefix for Vertex Batch Predictions output format.
	Configs map[string]*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specification for how the data should be sliced.

func (*ModelEvaluationSlice_Slice_SliceSpec) Descriptor deprecated added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec) Descriptor() ([]byte, []int)

Deprecated: Use ModelEvaluationSlice_Slice_SliceSpec.ProtoReflect.Descriptor instead.

func (*ModelEvaluationSlice_Slice_SliceSpec) GetConfigs added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec) ProtoMessage added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec) ProtoMessage()

func (*ModelEvaluationSlice_Slice_SliceSpec) ProtoReflect added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec) Reset added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec) String added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec_Range added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec_Range struct {

	// Inclusive low value for the range.
	Low float32 `protobuf:"fixed32,1,opt,name=low,proto3" json:"low,omitempty"`
	// Exclusive high value for the range.
	High float32 `protobuf:"fixed32,2,opt,name=high,proto3" json:"high,omitempty"`
	// contains filtered or unexported fields
}

A range of values for slice(s). `low` is inclusive, `high` is exclusive.

func (*ModelEvaluationSlice_Slice_SliceSpec_Range) Descriptor deprecated added in v1.36.0

Deprecated: Use ModelEvaluationSlice_Slice_SliceSpec_Range.ProtoReflect.Descriptor instead.

func (*ModelEvaluationSlice_Slice_SliceSpec_Range) GetHigh added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_Range) GetLow added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_Range) ProtoMessage added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_Range) ProtoReflect added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_Range) Reset added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_Range) String added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec_SliceConfig added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec_SliceConfig struct {

	// Types that are assignable to Kind:
	//
	//	*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig_Value
	//	*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig_Range
	//	*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig_AllValues
	Kind isModelEvaluationSlice_Slice_SliceSpec_SliceConfig_Kind `protobuf_oneof:"kind"`
	// contains filtered or unexported fields
}

Specification message containing the config for this SliceSpec. When `kind` is selected as `value` and/or `range`, only a single slice will be computed. When `all_values` is present, a separate slice will be computed for each possible label/value for the corresponding key in `config`. Examples, with feature zip_code with values 12345, 23334, 88888 and feature country with values "US", "Canada", "Mexico" in the dataset:

Example 1:

{
  "zip_code": { "value": { "float_value": 12345.0 } }
}

A single slice for any data with zip_code 12345 in the dataset.

Example 2:

{
  "zip_code": { "range": { "low": 12345, "high": 20000 } }
}

A single slice containing data where the zip_codes between 12345 and 20000 For this example, data with the zip_code of 12345 will be in this slice.

Example 3:

{
  "zip_code": { "range": { "low": 10000, "high": 20000 } },
  "country": { "value": { "string_value": "US" } }
}

A single slice containing data where the zip_codes between 10000 and 20000 has the country "US". For this example, data with the zip_code of 12345 and country "US" will be in this slice.

Example 4:

{ "country": {"all_values": { "value": true } } }

Three slices are computed, one for each unique country in the dataset.

Example 5:

{
  "country": { "all_values": { "value": true } },
  "zip_code": { "value": { "float_value": 12345.0 } }
}

Three slices are computed, one for each unique country in the dataset where the zip_code is also 12345. For this example, data with zip_code 12345 and country "US" will be in one slice, zip_code 12345 and country "Canada" in another slice, and zip_code 12345 and country "Mexico" in another slice, totaling 3 slices.

func (*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig) Descriptor deprecated added in v1.36.0

Deprecated: Use ModelEvaluationSlice_Slice_SliceSpec_SliceConfig.ProtoReflect.Descriptor instead.

func (*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig) GetAllValues added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig) GetKind added in v1.36.0

func (m *ModelEvaluationSlice_Slice_SliceSpec_SliceConfig) GetKind() isModelEvaluationSlice_Slice_SliceSpec_SliceConfig_Kind

func (*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig) GetRange added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig) GetValue added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig) ProtoMessage added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig) ProtoReflect added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig) Reset added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_SliceConfig) String added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec_SliceConfig_AllValues added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec_SliceConfig_AllValues struct {
	// If all_values is set to true, then all possible labels of the keyed
	// feature will have another slice computed.
	// Example: `{"all_values":{"value":true}}`
	AllValues *wrapperspb.BoolValue `protobuf:"bytes,3,opt,name=all_values,json=allValues,proto3,oneof"`
}

type ModelEvaluationSlice_Slice_SliceSpec_SliceConfig_Range added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec_SliceConfig_Range struct {
	// A range of values for a numerical feature.
	// Example: `{"range":{"low":10000.0,"high":50000.0}}`
	// will capture 12345 and 23334 in the slice.
	Range *ModelEvaluationSlice_Slice_SliceSpec_Range `protobuf:"bytes,2,opt,name=range,proto3,oneof"`
}

type ModelEvaluationSlice_Slice_SliceSpec_SliceConfig_Value added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec_SliceConfig_Value struct {
	// A unique specific value for a given feature.
	// Example: `{ "value": { "string_value": "12345" } }`
	Value *ModelEvaluationSlice_Slice_SliceSpec_Value `protobuf:"bytes,1,opt,name=value,proto3,oneof"`
}

type ModelEvaluationSlice_Slice_SliceSpec_Value added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec_Value struct {

	// Types that are assignable to Kind:
	//
	//	*ModelEvaluationSlice_Slice_SliceSpec_Value_StringValue
	//	*ModelEvaluationSlice_Slice_SliceSpec_Value_FloatValue
	Kind isModelEvaluationSlice_Slice_SliceSpec_Value_Kind `protobuf_oneof:"kind"`
	// contains filtered or unexported fields
}

Single value that supports strings and floats.

func (*ModelEvaluationSlice_Slice_SliceSpec_Value) Descriptor deprecated added in v1.36.0

Deprecated: Use ModelEvaluationSlice_Slice_SliceSpec_Value.ProtoReflect.Descriptor instead.

func (*ModelEvaluationSlice_Slice_SliceSpec_Value) GetFloatValue added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_Value) GetKind added in v1.36.0

func (m *ModelEvaluationSlice_Slice_SliceSpec_Value) GetKind() isModelEvaluationSlice_Slice_SliceSpec_Value_Kind

func (*ModelEvaluationSlice_Slice_SliceSpec_Value) GetStringValue added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_Value) ProtoMessage added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_Value) ProtoReflect added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_Value) Reset added in v1.36.0

func (*ModelEvaluationSlice_Slice_SliceSpec_Value) String added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec_Value_FloatValue added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec_Value_FloatValue struct {
	// Float type.
	FloatValue float32 `protobuf:"fixed32,2,opt,name=float_value,json=floatValue,proto3,oneof"`
}

type ModelEvaluationSlice_Slice_SliceSpec_Value_StringValue added in v1.36.0

type ModelEvaluationSlice_Slice_SliceSpec_Value_StringValue struct {
	// String type.
	StringValue string `protobuf:"bytes,1,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type ModelEvaluation_ModelEvaluationExplanationSpec

type ModelEvaluation_ModelEvaluationExplanationSpec struct {

	// Explanation type.
	//
	// For AutoML Image Classification models, possible values are:
	//
	//   - `image-integrated-gradients`
	//   - `image-xrai`
	ExplanationType string `protobuf:"bytes,1,opt,name=explanation_type,json=explanationType,proto3" json:"explanation_type,omitempty"`
	// Explanation spec details.
	ExplanationSpec *ExplanationSpec `protobuf:"bytes,2,opt,name=explanation_spec,json=explanationSpec,proto3" json:"explanation_spec,omitempty"`
	// contains filtered or unexported fields
}

func (*ModelEvaluation_ModelEvaluationExplanationSpec) Descriptor deprecated

Deprecated: Use ModelEvaluation_ModelEvaluationExplanationSpec.ProtoReflect.Descriptor instead.

func (*ModelEvaluation_ModelEvaluationExplanationSpec) GetExplanationSpec

func (*ModelEvaluation_ModelEvaluationExplanationSpec) GetExplanationType

func (*ModelEvaluation_ModelEvaluationExplanationSpec) ProtoMessage

func (*ModelEvaluation_ModelEvaluationExplanationSpec) ProtoReflect

func (*ModelEvaluation_ModelEvaluationExplanationSpec) Reset

func (*ModelEvaluation_ModelEvaluationExplanationSpec) String

type ModelExplanation

type ModelExplanation struct {

	// Output only. Aggregated attributions explaining the Model's prediction
	// outputs over the set of instances. The attributions are grouped by outputs.
	//
	// For Models that predict only one output, such as regression Models that
	// predict only one score, there is only one attibution that explains the
	// predicted output. For Models that predict multiple outputs, such as
	// multiclass Models that predict multiple classes, each element explains one
	// specific item.
	// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
	// can be used to identify which output this attribution is explaining.
	//
	// The
	// [baselineOutputValue][google.cloud.aiplatform.v1.Attribution.baseline_output_value],
	// [instanceOutputValue][google.cloud.aiplatform.v1.Attribution.instance_output_value]
	// and
	// [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
	// fields are averaged over the test data.
	//
	// NOTE: Currently AutoML tabular classification Models produce only one
	// attribution, which averages attributions over all the classes it predicts.
	// [Attribution.approximation_error][google.cloud.aiplatform.v1.Attribution.approximation_error]
	// is not populated.
	MeanAttributions []*Attribution `protobuf:"bytes,1,rep,name=mean_attributions,json=meanAttributions,proto3" json:"mean_attributions,omitempty"`
	// contains filtered or unexported fields
}

Aggregated explanation metrics for a Model over a set of instances.

func (*ModelExplanation) Descriptor deprecated

func (*ModelExplanation) Descriptor() ([]byte, []int)

Deprecated: Use ModelExplanation.ProtoReflect.Descriptor instead.

func (*ModelExplanation) GetMeanAttributions

func (x *ModelExplanation) GetMeanAttributions() []*Attribution

func (*ModelExplanation) ProtoMessage

func (*ModelExplanation) ProtoMessage()

func (*ModelExplanation) ProtoReflect

func (x *ModelExplanation) ProtoReflect() protoreflect.Message

func (*ModelExplanation) Reset

func (x *ModelExplanation) Reset()

func (*ModelExplanation) String

func (x *ModelExplanation) String() string

type ModelGardenServiceClient added in v1.44.0

type ModelGardenServiceClient interface {
	// Gets a Model Garden publisher model.
	GetPublisherModel(ctx context.Context, in *GetPublisherModelRequest, opts ...grpc.CallOption) (*PublisherModel, error)
}

ModelGardenServiceClient is the client API for ModelGardenService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewModelGardenServiceClient added in v1.44.0

func NewModelGardenServiceClient(cc grpc.ClientConnInterface) ModelGardenServiceClient

type ModelGardenServiceServer added in v1.44.0

type ModelGardenServiceServer interface {
	// Gets a Model Garden publisher model.
	GetPublisherModel(context.Context, *GetPublisherModelRequest) (*PublisherModel, error)
}

ModelGardenServiceServer is the server API for ModelGardenService service.

type ModelGardenSource added in v1.63.0

type ModelGardenSource struct {

	// Required. The model garden source model resource name.
	PublicModelName string `protobuf:"bytes,1,opt,name=public_model_name,json=publicModelName,proto3" json:"public_model_name,omitempty"`
	// contains filtered or unexported fields
}

Contains information about the source of the models generated from Model Garden.

func (*ModelGardenSource) Descriptor deprecated added in v1.63.0

func (*ModelGardenSource) Descriptor() ([]byte, []int)

Deprecated: Use ModelGardenSource.ProtoReflect.Descriptor instead.

func (*ModelGardenSource) GetPublicModelName added in v1.63.0

func (x *ModelGardenSource) GetPublicModelName() string

func (*ModelGardenSource) ProtoMessage added in v1.63.0

func (*ModelGardenSource) ProtoMessage()

func (*ModelGardenSource) ProtoReflect added in v1.63.0

func (x *ModelGardenSource) ProtoReflect() protoreflect.Message

func (*ModelGardenSource) Reset added in v1.63.0

func (x *ModelGardenSource) Reset()

func (*ModelGardenSource) String added in v1.63.0

func (x *ModelGardenSource) String() string

type ModelMonitoringAlertConfig

type ModelMonitoringAlertConfig struct {

	// Types that are assignable to Alert:
	//
	//	*ModelMonitoringAlertConfig_EmailAlertConfig_
	Alert isModelMonitoringAlertConfig_Alert `protobuf_oneof:"alert"`
	// Dump the anomalies to Cloud Logging. The anomalies will be put to json
	// payload encoded from proto
	// [google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry][].
	// This can be further sinked to Pub/Sub or any other services supported
	// by Cloud Logging.
	EnableLogging bool `protobuf:"varint,2,opt,name=enable_logging,json=enableLogging,proto3" json:"enable_logging,omitempty"`
	// Resource names of the NotificationChannels to send alert.
	// Must be of the format
	// `projects/<project_id_or_number>/notificationChannels/<channel_id>`
	NotificationChannels []string `protobuf:"bytes,3,rep,name=notification_channels,json=notificationChannels,proto3" json:"notification_channels,omitempty"`
	// contains filtered or unexported fields
}

The alert config for model monitoring.

func (*ModelMonitoringAlertConfig) Descriptor deprecated

func (*ModelMonitoringAlertConfig) Descriptor() ([]byte, []int)

Deprecated: Use ModelMonitoringAlertConfig.ProtoReflect.Descriptor instead.

func (*ModelMonitoringAlertConfig) GetAlert

func (m *ModelMonitoringAlertConfig) GetAlert() isModelMonitoringAlertConfig_Alert

func (*ModelMonitoringAlertConfig) GetEmailAlertConfig

func (*ModelMonitoringAlertConfig) GetEnableLogging

func (x *ModelMonitoringAlertConfig) GetEnableLogging() bool

func (*ModelMonitoringAlertConfig) GetNotificationChannels added in v1.51.0

func (x *ModelMonitoringAlertConfig) GetNotificationChannels() []string

func (*ModelMonitoringAlertConfig) ProtoMessage

func (*ModelMonitoringAlertConfig) ProtoMessage()

func (*ModelMonitoringAlertConfig) ProtoReflect

func (*ModelMonitoringAlertConfig) Reset

func (x *ModelMonitoringAlertConfig) Reset()

func (*ModelMonitoringAlertConfig) String

func (x *ModelMonitoringAlertConfig) String() string

type ModelMonitoringAlertConfig_EmailAlertConfig

type ModelMonitoringAlertConfig_EmailAlertConfig struct {

	// The email addresses to send the alert.
	UserEmails []string `protobuf:"bytes,1,rep,name=user_emails,json=userEmails,proto3" json:"user_emails,omitempty"`
	// contains filtered or unexported fields
}

The config for email alert.

func (*ModelMonitoringAlertConfig_EmailAlertConfig) Descriptor deprecated

Deprecated: Use ModelMonitoringAlertConfig_EmailAlertConfig.ProtoReflect.Descriptor instead.

func (*ModelMonitoringAlertConfig_EmailAlertConfig) GetUserEmails

func (*ModelMonitoringAlertConfig_EmailAlertConfig) ProtoMessage

func (*ModelMonitoringAlertConfig_EmailAlertConfig) ProtoReflect

func (*ModelMonitoringAlertConfig_EmailAlertConfig) Reset

func (*ModelMonitoringAlertConfig_EmailAlertConfig) String

type ModelMonitoringAlertConfig_EmailAlertConfig_

type ModelMonitoringAlertConfig_EmailAlertConfig_ struct {
	// Email alert config.
	EmailAlertConfig *ModelMonitoringAlertConfig_EmailAlertConfig `protobuf:"bytes,1,opt,name=email_alert_config,json=emailAlertConfig,proto3,oneof"`
}

type ModelMonitoringObjectiveConfig

type ModelMonitoringObjectiveConfig struct {

	// Training dataset for models. This field has to be set only if
	// TrainingPredictionSkewDetectionConfig is specified.
	TrainingDataset *ModelMonitoringObjectiveConfig_TrainingDataset `protobuf:"bytes,1,opt,name=training_dataset,json=trainingDataset,proto3" json:"training_dataset,omitempty"`
	// The config for skew between training data and prediction data.
	TrainingPredictionSkewDetectionConfig *ModelMonitoringObjectiveConfig_TrainingPredictionSkewDetectionConfig `` /* 178-byte string literal not displayed */
	// The config for drift of prediction data.
	PredictionDriftDetectionConfig *ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig `` /* 155-byte string literal not displayed */
	// The config for integrating with Vertex Explainable AI.
	ExplanationConfig *ModelMonitoringObjectiveConfig_ExplanationConfig `protobuf:"bytes,5,opt,name=explanation_config,json=explanationConfig,proto3" json:"explanation_config,omitempty"`
	// contains filtered or unexported fields
}

The objective configuration for model monitoring, including the information needed to detect anomalies for one particular model.

func (*ModelMonitoringObjectiveConfig) Descriptor deprecated

func (*ModelMonitoringObjectiveConfig) Descriptor() ([]byte, []int)

Deprecated: Use ModelMonitoringObjectiveConfig.ProtoReflect.Descriptor instead.

func (*ModelMonitoringObjectiveConfig) GetExplanationConfig

func (*ModelMonitoringObjectiveConfig) GetPredictionDriftDetectionConfig

func (*ModelMonitoringObjectiveConfig) GetTrainingDataset

func (*ModelMonitoringObjectiveConfig) GetTrainingPredictionSkewDetectionConfig

func (*ModelMonitoringObjectiveConfig) ProtoMessage

func (*ModelMonitoringObjectiveConfig) ProtoMessage()

func (*ModelMonitoringObjectiveConfig) ProtoReflect

func (*ModelMonitoringObjectiveConfig) Reset

func (x *ModelMonitoringObjectiveConfig) Reset()

func (*ModelMonitoringObjectiveConfig) String

type ModelMonitoringObjectiveConfig_ExplanationConfig

type ModelMonitoringObjectiveConfig_ExplanationConfig struct {

	// If want to analyze the Vertex Explainable AI feature attribute scores or
	// not. If set to true, Vertex AI will log the feature attributions from
	// explain response and do the skew/drift detection for them.
	EnableFeatureAttributes bool `` /* 133-byte string literal not displayed */
	// Predictions generated by the BatchPredictionJob using baseline dataset.
	ExplanationBaseline *ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline `protobuf:"bytes,2,opt,name=explanation_baseline,json=explanationBaseline,proto3" json:"explanation_baseline,omitempty"`
	// contains filtered or unexported fields
}

The config for integrating with Vertex Explainable AI. Only applicable if the Model has explanation_spec populated.

func (*ModelMonitoringObjectiveConfig_ExplanationConfig) Descriptor deprecated

Deprecated: Use ModelMonitoringObjectiveConfig_ExplanationConfig.ProtoReflect.Descriptor instead.

func (*ModelMonitoringObjectiveConfig_ExplanationConfig) GetEnableFeatureAttributes

func (x *ModelMonitoringObjectiveConfig_ExplanationConfig) GetEnableFeatureAttributes() bool

func (*ModelMonitoringObjectiveConfig_ExplanationConfig) GetExplanationBaseline

func (*ModelMonitoringObjectiveConfig_ExplanationConfig) ProtoMessage

func (*ModelMonitoringObjectiveConfig_ExplanationConfig) ProtoReflect

func (*ModelMonitoringObjectiveConfig_ExplanationConfig) Reset

func (*ModelMonitoringObjectiveConfig_ExplanationConfig) String

type ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline

type ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline struct {

	// The configuration specifying of BatchExplain job output. This can be
	// used to generate the baseline of feature attribution scores.
	//
	// Types that are assignable to Destination:
	//
	//	*ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_Gcs
	//	*ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_Bigquery
	Destination isModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_Destination `protobuf_oneof:"destination"`
	// The storage format of the predictions generated BatchPrediction job.
	PredictionFormat ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat `` /* 228-byte string literal not displayed */
	// contains filtered or unexported fields
}

Output from BatchPredictionJob[google.cloud.aiplatform.v1.BatchPredictionJob] for Model Monitoring baseline dataset, which can be used to generate baseline attribution scores.

func (*ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline) Descriptor deprecated

Deprecated: Use ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline.ProtoReflect.Descriptor instead.

func (*ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline) GetBigquery

func (*ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline) GetDestination

func (m *ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline) GetDestination() isModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_Destination

func (*ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline) GetGcs

func (*ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline) ProtoMessage

func (*ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline) ProtoReflect

func (*ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline) Reset

func (*ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline) String

type ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_Bigquery

type ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_Bigquery struct {
	// BigQuery location for BatchExplain output.
	Bigquery *BigQueryDestination `protobuf:"bytes,3,opt,name=bigquery,proto3,oneof"`
}

type ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_Gcs

type ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_Gcs struct {
	// Cloud Storage location for BatchExplain output.
	Gcs *GcsDestination `protobuf:"bytes,2,opt,name=gcs,proto3,oneof"`
}

type ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat

type ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat int32

The storage format of the predictions generated BatchPrediction job.

const (
	// Should not be set.
	ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PREDICTION_FORMAT_UNSPECIFIED ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat = 0
	// Predictions are in JSONL files.
	ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_JSONL ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat = 2
	// Predictions are in BigQuery.
	ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_BIGQUERY ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat = 3
)

func (ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat) Descriptor

func (ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat) EnumDescriptor deprecated

Deprecated: Use ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat.Descriptor instead.

func (ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat) Number

func (ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat) String

func (ModelMonitoringObjectiveConfig_ExplanationConfig_ExplanationBaseline_PredictionFormat) Type

type ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig

type ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig struct {

	// Key is the feature name and value is the threshold. If a feature needs to
	// be monitored for drift, a value threshold must be configured for that
	// feature. The threshold here is against feature distribution distance
	// between different time windws.
	DriftThresholds map[string]*ThresholdConfig `` /* 194-byte string literal not displayed */
	// Key is the feature name and value is the threshold. The threshold here is
	// against attribution score distance between different time windows.
	AttributionScoreDriftThresholds map[string]*ThresholdConfig `` /* 246-byte string literal not displayed */
	// Drift anomaly detection threshold used by all features.
	// When the per-feature thresholds are not set, this field can be used to
	// specify a threshold for all features.
	DefaultDriftThreshold *ThresholdConfig `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

The config for Prediction data drift detection.

func (*ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig) Descriptor deprecated

Deprecated: Use ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig.ProtoReflect.Descriptor instead.

func (*ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig) GetAttributionScoreDriftThresholds

func (x *ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig) GetAttributionScoreDriftThresholds() map[string]*ThresholdConfig

func (*ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig) GetDefaultDriftThreshold

func (*ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig) GetDriftThresholds

func (*ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig) ProtoMessage

func (*ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig) ProtoReflect

func (*ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig) Reset

func (*ModelMonitoringObjectiveConfig_PredictionDriftDetectionConfig) String

type ModelMonitoringObjectiveConfig_TrainingDataset

type ModelMonitoringObjectiveConfig_TrainingDataset struct {

	// Types that are assignable to DataSource:
	//
	//	*ModelMonitoringObjectiveConfig_TrainingDataset_Dataset
	//	*ModelMonitoringObjectiveConfig_TrainingDataset_GcsSource
	//	*ModelMonitoringObjectiveConfig_TrainingDataset_BigquerySource
	DataSource isModelMonitoringObjectiveConfig_TrainingDataset_DataSource `protobuf_oneof:"data_source"`
	// Data format of the dataset, only applicable if the input is from
	// Google Cloud Storage.
	// The possible formats are:
	//
	// "tf-record"
	// The source file is a TFRecord file.
	//
	// "csv"
	// The source file is a CSV file.
	// "jsonl"
	// The source file is a JSONL file.
	DataFormat string `protobuf:"bytes,2,opt,name=data_format,json=dataFormat,proto3" json:"data_format,omitempty"`
	// The target field name the model is to predict.
	// This field will be excluded when doing Predict and (or) Explain for the
	// training data.
	TargetField string `protobuf:"bytes,6,opt,name=target_field,json=targetField,proto3" json:"target_field,omitempty"`
	// Strategy to sample data from Training Dataset.
	// If not set, we process the whole dataset.
	LoggingSamplingStrategy *SamplingStrategy `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

Training Dataset information.

func (*ModelMonitoringObjectiveConfig_TrainingDataset) Descriptor deprecated

Deprecated: Use ModelMonitoringObjectiveConfig_TrainingDataset.ProtoReflect.Descriptor instead.

func (*ModelMonitoringObjectiveConfig_TrainingDataset) GetBigquerySource

func (*ModelMonitoringObjectiveConfig_TrainingDataset) GetDataFormat

func (*ModelMonitoringObjectiveConfig_TrainingDataset) GetDataSource

func (m *ModelMonitoringObjectiveConfig_TrainingDataset) GetDataSource() isModelMonitoringObjectiveConfig_TrainingDataset_DataSource

func (*ModelMonitoringObjectiveConfig_TrainingDataset) GetDataset

func (*ModelMonitoringObjectiveConfig_TrainingDataset) GetGcsSource

func (*ModelMonitoringObjectiveConfig_TrainingDataset) GetLoggingSamplingStrategy

func (x *ModelMonitoringObjectiveConfig_TrainingDataset) GetLoggingSamplingStrategy() *SamplingStrategy

func (*ModelMonitoringObjectiveConfig_TrainingDataset) GetTargetField

func (*ModelMonitoringObjectiveConfig_TrainingDataset) ProtoMessage

func (*ModelMonitoringObjectiveConfig_TrainingDataset) ProtoReflect

func (*ModelMonitoringObjectiveConfig_TrainingDataset) Reset

func (*ModelMonitoringObjectiveConfig_TrainingDataset) String

type ModelMonitoringObjectiveConfig_TrainingDataset_BigquerySource

type ModelMonitoringObjectiveConfig_TrainingDataset_BigquerySource struct {
	// The BigQuery table of the unmanaged Dataset used to train this
	// Model.
	BigquerySource *BigQuerySource `protobuf:"bytes,5,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}

type ModelMonitoringObjectiveConfig_TrainingDataset_Dataset

type ModelMonitoringObjectiveConfig_TrainingDataset_Dataset struct {
	// The resource name of the Dataset used to train this Model.
	Dataset string `protobuf:"bytes,3,opt,name=dataset,proto3,oneof"`
}

type ModelMonitoringObjectiveConfig_TrainingDataset_GcsSource

type ModelMonitoringObjectiveConfig_TrainingDataset_GcsSource struct {
	// The Google Cloud Storage uri of the unmanaged Dataset used to train
	// this Model.
	GcsSource *GcsSource `protobuf:"bytes,4,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type ModelMonitoringObjectiveConfig_TrainingPredictionSkewDetectionConfig

type ModelMonitoringObjectiveConfig_TrainingPredictionSkewDetectionConfig struct {

	// Key is the feature name and value is the threshold. If a feature needs to
	// be monitored for skew, a value threshold must be configured for that
	// feature. The threshold here is against feature distribution distance
	// between the training and prediction feature.
	SkewThresholds map[string]*ThresholdConfig `` /* 191-byte string literal not displayed */
	// Key is the feature name and value is the threshold. The threshold here is
	// against attribution score distance between the training and prediction
	// feature.
	AttributionScoreSkewThresholds map[string]*ThresholdConfig `` /* 243-byte string literal not displayed */
	// Skew anomaly detection threshold used by all features.
	// When the per-feature thresholds are not set, this field can be used to
	// specify a threshold for all features.
	DefaultSkewThreshold *ThresholdConfig `protobuf:"bytes,6,opt,name=default_skew_threshold,json=defaultSkewThreshold,proto3" json:"default_skew_threshold,omitempty"`
	// contains filtered or unexported fields
}

The config for Training & Prediction data skew detection. It specifies the training dataset sources and the skew detection parameters.

func (*ModelMonitoringObjectiveConfig_TrainingPredictionSkewDetectionConfig) Descriptor deprecated

Deprecated: Use ModelMonitoringObjectiveConfig_TrainingPredictionSkewDetectionConfig.ProtoReflect.Descriptor instead.

func (*ModelMonitoringObjectiveConfig_TrainingPredictionSkewDetectionConfig) GetAttributionScoreSkewThresholds

func (*ModelMonitoringObjectiveConfig_TrainingPredictionSkewDetectionConfig) GetDefaultSkewThreshold

func (*ModelMonitoringObjectiveConfig_TrainingPredictionSkewDetectionConfig) GetSkewThresholds

func (*ModelMonitoringObjectiveConfig_TrainingPredictionSkewDetectionConfig) ProtoMessage

func (*ModelMonitoringObjectiveConfig_TrainingPredictionSkewDetectionConfig) ProtoReflect

func (*ModelMonitoringObjectiveConfig_TrainingPredictionSkewDetectionConfig) Reset

func (*ModelMonitoringObjectiveConfig_TrainingPredictionSkewDetectionConfig) String

type ModelMonitoringStatsAnomalies

type ModelMonitoringStatsAnomalies struct {

	// Model Monitoring Objective those stats and anomalies belonging to.
	Objective ModelDeploymentMonitoringObjectiveType `` /* 143-byte string literal not displayed */
	// Deployed Model ID.
	DeployedModelId string `protobuf:"bytes,2,opt,name=deployed_model_id,json=deployedModelId,proto3" json:"deployed_model_id,omitempty"`
	// Number of anomalies within all stats.
	AnomalyCount int32 `protobuf:"varint,3,opt,name=anomaly_count,json=anomalyCount,proto3" json:"anomaly_count,omitempty"`
	// A list of historical Stats and Anomalies generated for all Features.
	FeatureStats []*ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies `protobuf:"bytes,4,rep,name=feature_stats,json=featureStats,proto3" json:"feature_stats,omitempty"`
	// contains filtered or unexported fields
}

Statistics and anomalies generated by Model Monitoring.

func (*ModelMonitoringStatsAnomalies) Descriptor deprecated

func (*ModelMonitoringStatsAnomalies) Descriptor() ([]byte, []int)

Deprecated: Use ModelMonitoringStatsAnomalies.ProtoReflect.Descriptor instead.

func (*ModelMonitoringStatsAnomalies) GetAnomalyCount

func (x *ModelMonitoringStatsAnomalies) GetAnomalyCount() int32

func (*ModelMonitoringStatsAnomalies) GetDeployedModelId

func (x *ModelMonitoringStatsAnomalies) GetDeployedModelId() string

func (*ModelMonitoringStatsAnomalies) GetFeatureStats

func (*ModelMonitoringStatsAnomalies) GetObjective

func (*ModelMonitoringStatsAnomalies) ProtoMessage

func (*ModelMonitoringStatsAnomalies) ProtoMessage()

func (*ModelMonitoringStatsAnomalies) ProtoReflect

func (*ModelMonitoringStatsAnomalies) Reset

func (x *ModelMonitoringStatsAnomalies) Reset()

func (*ModelMonitoringStatsAnomalies) String

type ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies

type ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies struct {

	// Display Name of the Feature.
	FeatureDisplayName string `protobuf:"bytes,1,opt,name=feature_display_name,json=featureDisplayName,proto3" json:"feature_display_name,omitempty"`
	// Threshold for anomaly detection.
	Threshold *ThresholdConfig `protobuf:"bytes,3,opt,name=threshold,proto3" json:"threshold,omitempty"`
	// Stats calculated for the Training Dataset.
	TrainingStats *FeatureStatsAnomaly `protobuf:"bytes,4,opt,name=training_stats,json=trainingStats,proto3" json:"training_stats,omitempty"`
	// A list of historical stats generated by different time window's
	// Prediction Dataset.
	PredictionStats []*FeatureStatsAnomaly `protobuf:"bytes,5,rep,name=prediction_stats,json=predictionStats,proto3" json:"prediction_stats,omitempty"`
	// contains filtered or unexported fields
}

Historical Stats (and Anomalies) for a specific Feature.

func (*ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies) Descriptor deprecated

Deprecated: Use ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies.ProtoReflect.Descriptor instead.

func (*ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies) GetFeatureDisplayName

func (*ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies) GetPredictionStats

func (*ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies) GetThreshold

func (*ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies) GetTrainingStats

func (*ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies) ProtoMessage

func (*ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies) ProtoReflect

func (*ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies) Reset

func (*ModelMonitoringStatsAnomalies_FeatureHistoricStatsAnomalies) String

type ModelServiceClient

type ModelServiceClient interface {
	// Uploads a Model artifact into Vertex AI.
	UploadModel(ctx context.Context, in *UploadModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a Model.
	GetModel(ctx context.Context, in *GetModelRequest, opts ...grpc.CallOption) (*Model, error)
	// Lists Models in a Location.
	ListModels(ctx context.Context, in *ListModelsRequest, opts ...grpc.CallOption) (*ListModelsResponse, error)
	// Lists versions of the specified model.
	ListModelVersions(ctx context.Context, in *ListModelVersionsRequest, opts ...grpc.CallOption) (*ListModelVersionsResponse, error)
	// Updates a Model.
	UpdateModel(ctx context.Context, in *UpdateModelRequest, opts ...grpc.CallOption) (*Model, error)
	// Incrementally update the dataset used for an examples model.
	UpdateExplanationDataset(ctx context.Context, in *UpdateExplanationDatasetRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a Model.
	//
	// A model cannot be deleted if any
	// [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a
	// [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the
	// model in its
	// [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
	// field.
	DeleteModel(ctx context.Context, in *DeleteModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a Model version.
	//
	// Model version can only be deleted if there are no
	// [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it.
	// Deleting the only version in the Model is not allowed. Use
	// [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for
	// deleting the Model instead.
	DeleteModelVersion(ctx context.Context, in *DeleteModelVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Merges a set of aliases for a Model version.
	MergeVersionAliases(ctx context.Context, in *MergeVersionAliasesRequest, opts ...grpc.CallOption) (*Model, error)
	// Exports a trained, exportable Model to a location specified by the
	// user. A Model is considered to be exportable if it has at least one
	// [supported export
	// format][google.cloud.aiplatform.v1.Model.supported_export_formats].
	ExportModel(ctx context.Context, in *ExportModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Copies an already existing Vertex AI Model into the specified Location.
	// The source Model must exist in the same Project.
	// When copying custom Models, the users themselves are responsible for
	// [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be
	// region-agnostic, as well as making sure that any resources (e.g. files) it
	// depends on remain accessible.
	CopyModel(ctx context.Context, in *CopyModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Imports an externally generated ModelEvaluation.
	ImportModelEvaluation(ctx context.Context, in *ImportModelEvaluationRequest, opts ...grpc.CallOption) (*ModelEvaluation, error)
	// Imports a list of externally generated ModelEvaluationSlice.
	BatchImportModelEvaluationSlices(ctx context.Context, in *BatchImportModelEvaluationSlicesRequest, opts ...grpc.CallOption) (*BatchImportModelEvaluationSlicesResponse, error)
	// Imports a list of externally generated EvaluatedAnnotations.
	BatchImportEvaluatedAnnotations(ctx context.Context, in *BatchImportEvaluatedAnnotationsRequest, opts ...grpc.CallOption) (*BatchImportEvaluatedAnnotationsResponse, error)
	// Gets a ModelEvaluation.
	GetModelEvaluation(ctx context.Context, in *GetModelEvaluationRequest, opts ...grpc.CallOption) (*ModelEvaluation, error)
	// Lists ModelEvaluations in a Model.
	ListModelEvaluations(ctx context.Context, in *ListModelEvaluationsRequest, opts ...grpc.CallOption) (*ListModelEvaluationsResponse, error)
	// Gets a ModelEvaluationSlice.
	GetModelEvaluationSlice(ctx context.Context, in *GetModelEvaluationSliceRequest, opts ...grpc.CallOption) (*ModelEvaluationSlice, error)
	// Lists ModelEvaluationSlices in a ModelEvaluation.
	ListModelEvaluationSlices(ctx context.Context, in *ListModelEvaluationSlicesRequest, opts ...grpc.CallOption) (*ListModelEvaluationSlicesResponse, error)
}

ModelServiceClient is the client API for ModelService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type ModelServiceServer

type ModelServiceServer interface {
	// Uploads a Model artifact into Vertex AI.
	UploadModel(context.Context, *UploadModelRequest) (*longrunningpb.Operation, error)
	// Gets a Model.
	GetModel(context.Context, *GetModelRequest) (*Model, error)
	// Lists Models in a Location.
	ListModels(context.Context, *ListModelsRequest) (*ListModelsResponse, error)
	// Lists versions of the specified model.
	ListModelVersions(context.Context, *ListModelVersionsRequest) (*ListModelVersionsResponse, error)
	// Updates a Model.
	UpdateModel(context.Context, *UpdateModelRequest) (*Model, error)
	// Incrementally update the dataset used for an examples model.
	UpdateExplanationDataset(context.Context, *UpdateExplanationDatasetRequest) (*longrunningpb.Operation, error)
	// Deletes a Model.
	//
	// A model cannot be deleted if any
	// [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a
	// [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the
	// model in its
	// [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
	// field.
	DeleteModel(context.Context, *DeleteModelRequest) (*longrunningpb.Operation, error)
	// Deletes a Model version.
	//
	// Model version can only be deleted if there are no
	// [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it.
	// Deleting the only version in the Model is not allowed. Use
	// [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for
	// deleting the Model instead.
	DeleteModelVersion(context.Context, *DeleteModelVersionRequest) (*longrunningpb.Operation, error)
	// Merges a set of aliases for a Model version.
	MergeVersionAliases(context.Context, *MergeVersionAliasesRequest) (*Model, error)
	// Exports a trained, exportable Model to a location specified by the
	// user. A Model is considered to be exportable if it has at least one
	// [supported export
	// format][google.cloud.aiplatform.v1.Model.supported_export_formats].
	ExportModel(context.Context, *ExportModelRequest) (*longrunningpb.Operation, error)
	// Copies an already existing Vertex AI Model into the specified Location.
	// The source Model must exist in the same Project.
	// When copying custom Models, the users themselves are responsible for
	// [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be
	// region-agnostic, as well as making sure that any resources (e.g. files) it
	// depends on remain accessible.
	CopyModel(context.Context, *CopyModelRequest) (*longrunningpb.Operation, error)
	// Imports an externally generated ModelEvaluation.
	ImportModelEvaluation(context.Context, *ImportModelEvaluationRequest) (*ModelEvaluation, error)
	// Imports a list of externally generated ModelEvaluationSlice.
	BatchImportModelEvaluationSlices(context.Context, *BatchImportModelEvaluationSlicesRequest) (*BatchImportModelEvaluationSlicesResponse, error)
	// Imports a list of externally generated EvaluatedAnnotations.
	BatchImportEvaluatedAnnotations(context.Context, *BatchImportEvaluatedAnnotationsRequest) (*BatchImportEvaluatedAnnotationsResponse, error)
	// Gets a ModelEvaluation.
	GetModelEvaluation(context.Context, *GetModelEvaluationRequest) (*ModelEvaluation, error)
	// Lists ModelEvaluations in a Model.
	ListModelEvaluations(context.Context, *ListModelEvaluationsRequest) (*ListModelEvaluationsResponse, error)
	// Gets a ModelEvaluationSlice.
	GetModelEvaluationSlice(context.Context, *GetModelEvaluationSliceRequest) (*ModelEvaluationSlice, error)
	// Lists ModelEvaluationSlices in a ModelEvaluation.
	ListModelEvaluationSlices(context.Context, *ListModelEvaluationSlicesRequest) (*ListModelEvaluationSlicesResponse, error)
}

ModelServiceServer is the server API for ModelService service.

type ModelSourceInfo

type ModelSourceInfo struct {

	// Type of the model source.
	SourceType ModelSourceInfo_ModelSourceType `` /* 156-byte string literal not displayed */
	// If this Model is copy of another Model. If true then
	// [source_type][google.cloud.aiplatform.v1.ModelSourceInfo.source_type]
	// pertains to the original.
	Copy bool `protobuf:"varint,2,opt,name=copy,proto3" json:"copy,omitempty"`
	// contains filtered or unexported fields
}

Detail description of the source information of the model.

func (*ModelSourceInfo) Descriptor deprecated

func (*ModelSourceInfo) Descriptor() ([]byte, []int)

Deprecated: Use ModelSourceInfo.ProtoReflect.Descriptor instead.

func (*ModelSourceInfo) GetCopy added in v1.37.0

func (x *ModelSourceInfo) GetCopy() bool

func (*ModelSourceInfo) GetSourceType

func (*ModelSourceInfo) ProtoMessage

func (*ModelSourceInfo) ProtoMessage()

func (*ModelSourceInfo) ProtoReflect

func (x *ModelSourceInfo) ProtoReflect() protoreflect.Message

func (*ModelSourceInfo) Reset

func (x *ModelSourceInfo) Reset()

func (*ModelSourceInfo) String

func (x *ModelSourceInfo) String() string

type ModelSourceInfo_ModelSourceType

type ModelSourceInfo_ModelSourceType int32

Source of the model. Different from `objective` field, this `ModelSourceType` enum indicates the source from which the model was accessed or obtained, whereas the `objective` indicates the overall aim or function of this model.

const (
	// Should not be used.
	ModelSourceInfo_MODEL_SOURCE_TYPE_UNSPECIFIED ModelSourceInfo_ModelSourceType = 0
	// The Model is uploaded by automl training pipeline.
	ModelSourceInfo_AUTOML ModelSourceInfo_ModelSourceType = 1
	// The Model is uploaded by user or custom training pipeline.
	ModelSourceInfo_CUSTOM ModelSourceInfo_ModelSourceType = 2
	// The Model is registered and sync'ed from BigQuery ML.
	ModelSourceInfo_BQML ModelSourceInfo_ModelSourceType = 3
	// The Model is saved or tuned from Model Garden.
	ModelSourceInfo_MODEL_GARDEN ModelSourceInfo_ModelSourceType = 4
	// The Model is saved or tuned from Genie.
	ModelSourceInfo_GENIE ModelSourceInfo_ModelSourceType = 5
	// The Model is uploaded by text embedding finetuning pipeline.
	ModelSourceInfo_CUSTOM_TEXT_EMBEDDING ModelSourceInfo_ModelSourceType = 6
	// The Model is saved or tuned from Marketplace.
	ModelSourceInfo_MARKETPLACE ModelSourceInfo_ModelSourceType = 7
)

func (ModelSourceInfo_ModelSourceType) Descriptor

func (ModelSourceInfo_ModelSourceType) Enum

func (ModelSourceInfo_ModelSourceType) EnumDescriptor deprecated

func (ModelSourceInfo_ModelSourceType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ModelSourceInfo_ModelSourceType.Descriptor instead.

func (ModelSourceInfo_ModelSourceType) Number

func (ModelSourceInfo_ModelSourceType) String

func (ModelSourceInfo_ModelSourceType) Type

type Model_BaseModelSource added in v1.63.0

type Model_BaseModelSource struct {

	// Types that are assignable to Source:
	//
	//	*Model_BaseModelSource_ModelGardenSource
	//	*Model_BaseModelSource_GenieSource
	Source isModel_BaseModelSource_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.

func (*Model_BaseModelSource) Descriptor deprecated added in v1.63.0

func (*Model_BaseModelSource) Descriptor() ([]byte, []int)

Deprecated: Use Model_BaseModelSource.ProtoReflect.Descriptor instead.

func (*Model_BaseModelSource) GetGenieSource added in v1.63.0

func (x *Model_BaseModelSource) GetGenieSource() *GenieSource

func (*Model_BaseModelSource) GetModelGardenSource added in v1.63.0

func (x *Model_BaseModelSource) GetModelGardenSource() *ModelGardenSource

func (*Model_BaseModelSource) GetSource added in v1.63.0

func (m *Model_BaseModelSource) GetSource() isModel_BaseModelSource_Source

func (*Model_BaseModelSource) ProtoMessage added in v1.63.0

func (*Model_BaseModelSource) ProtoMessage()

func (*Model_BaseModelSource) ProtoReflect added in v1.63.0

func (x *Model_BaseModelSource) ProtoReflect() protoreflect.Message

func (*Model_BaseModelSource) Reset added in v1.63.0

func (x *Model_BaseModelSource) Reset()

func (*Model_BaseModelSource) String added in v1.63.0

func (x *Model_BaseModelSource) String() string

type Model_BaseModelSource_GenieSource added in v1.63.0

type Model_BaseModelSource_GenieSource struct {
	// Information about the base model of Genie models.
	GenieSource *GenieSource `protobuf:"bytes,2,opt,name=genie_source,json=genieSource,proto3,oneof"`
}

type Model_BaseModelSource_ModelGardenSource added in v1.63.0

type Model_BaseModelSource_ModelGardenSource struct {
	// Source information of Model Garden models.
	ModelGardenSource *ModelGardenSource `protobuf:"bytes,1,opt,name=model_garden_source,json=modelGardenSource,proto3,oneof"`
}

type Model_DataStats added in v1.56.0

type Model_DataStats struct {

	// Number of DataItems that were used for training this Model.
	TrainingDataItemsCount int64 `` /* 132-byte string literal not displayed */
	// Number of DataItems that were used for validating this Model during
	// training.
	ValidationDataItemsCount int64 `` /* 138-byte string literal not displayed */
	// Number of DataItems that were used for evaluating this Model. If the
	// Model is evaluated multiple times, this will be the number of test
	// DataItems used by the first evaluation. If the Model is not evaluated,
	// the number is 0.
	TestDataItemsCount int64 `protobuf:"varint,3,opt,name=test_data_items_count,json=testDataItemsCount,proto3" json:"test_data_items_count,omitempty"`
	// Number of Annotations that are used for training this Model.
	TrainingAnnotationsCount int64 `` /* 136-byte string literal not displayed */
	// Number of Annotations that are used for validating this Model during
	// training.
	ValidationAnnotationsCount int64 `` /* 142-byte string literal not displayed */
	// Number of Annotations that are used for evaluating this Model. If the
	// Model is evaluated multiple times, this will be the number of test
	// Annotations used by the first evaluation. If the Model is not evaluated,
	// the number is 0.
	TestAnnotationsCount int64 `protobuf:"varint,6,opt,name=test_annotations_count,json=testAnnotationsCount,proto3" json:"test_annotations_count,omitempty"`
	// contains filtered or unexported fields
}

Stats of data used for train or evaluate the Model.

func (*Model_DataStats) Descriptor deprecated added in v1.56.0

func (*Model_DataStats) Descriptor() ([]byte, []int)

Deprecated: Use Model_DataStats.ProtoReflect.Descriptor instead.

func (*Model_DataStats) GetTestAnnotationsCount added in v1.56.0

func (x *Model_DataStats) GetTestAnnotationsCount() int64

func (*Model_DataStats) GetTestDataItemsCount added in v1.56.0

func (x *Model_DataStats) GetTestDataItemsCount() int64

func (*Model_DataStats) GetTrainingAnnotationsCount added in v1.56.0

func (x *Model_DataStats) GetTrainingAnnotationsCount() int64

func (*Model_DataStats) GetTrainingDataItemsCount added in v1.56.0

func (x *Model_DataStats) GetTrainingDataItemsCount() int64

func (*Model_DataStats) GetValidationAnnotationsCount added in v1.56.0

func (x *Model_DataStats) GetValidationAnnotationsCount() int64

func (*Model_DataStats) GetValidationDataItemsCount added in v1.56.0

func (x *Model_DataStats) GetValidationDataItemsCount() int64

func (*Model_DataStats) ProtoMessage added in v1.56.0

func (*Model_DataStats) ProtoMessage()

func (*Model_DataStats) ProtoReflect added in v1.56.0

func (x *Model_DataStats) ProtoReflect() protoreflect.Message

func (*Model_DataStats) Reset added in v1.56.0

func (x *Model_DataStats) Reset()

func (*Model_DataStats) String added in v1.56.0

func (x *Model_DataStats) String() string

type Model_DeploymentResourcesType

type Model_DeploymentResourcesType int32

Identifies a type of Model's prediction resources.

const (
	// Should not be used.
	Model_DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED Model_DeploymentResourcesType = 0
	// Resources that are dedicated to the
	// [DeployedModel][google.cloud.aiplatform.v1.DeployedModel], and that need
	// a higher degree of manual configuration.
	Model_DEDICATED_RESOURCES Model_DeploymentResourcesType = 1
	// Resources that to large degree are decided by Vertex AI, and require
	// only a modest additional configuration.
	Model_AUTOMATIC_RESOURCES Model_DeploymentResourcesType = 2
	// Resources that can be shared by multiple
	// [DeployedModels][google.cloud.aiplatform.v1.DeployedModel]. A
	// pre-configured
	// [DeploymentResourcePool][google.cloud.aiplatform.v1.DeploymentResourcePool]
	// is required.
	Model_SHARED_RESOURCES Model_DeploymentResourcesType = 3
)

func (Model_DeploymentResourcesType) Descriptor

func (Model_DeploymentResourcesType) Enum

func (Model_DeploymentResourcesType) EnumDescriptor deprecated

func (Model_DeploymentResourcesType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Model_DeploymentResourcesType.Descriptor instead.

func (Model_DeploymentResourcesType) Number

func (Model_DeploymentResourcesType) String

func (Model_DeploymentResourcesType) Type

type Model_ExportFormat

type Model_ExportFormat struct {

	// Output only. The ID of the export format.
	// The possible format IDs are:
	//
	// * `tflite`
	// Used for Android mobile devices.
	//
	// * `edgetpu-tflite`
	// Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
	//
	// * `tf-saved-model`
	// A tensorflow model in SavedModel format.
	//
	// * `tf-js`
	// A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
	// in the browser and in Node.js using JavaScript.
	//
	// * `core-ml`
	// Used for iOS mobile devices.
	//
	// * `custom-trained`
	// A Model that was uploaded or trained by custom code.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Output only. The content of this Model that may be exported.
	ExportableContents []Model_ExportFormat_ExportableContent `` /* 192-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents export format supported by the Model. All formats export to Google Cloud Storage.

func (*Model_ExportFormat) Descriptor deprecated

func (*Model_ExportFormat) Descriptor() ([]byte, []int)

Deprecated: Use Model_ExportFormat.ProtoReflect.Descriptor instead.

func (*Model_ExportFormat) GetExportableContents

func (x *Model_ExportFormat) GetExportableContents() []Model_ExportFormat_ExportableContent

func (*Model_ExportFormat) GetId

func (x *Model_ExportFormat) GetId() string

func (*Model_ExportFormat) ProtoMessage

func (*Model_ExportFormat) ProtoMessage()

func (*Model_ExportFormat) ProtoReflect

func (x *Model_ExportFormat) ProtoReflect() protoreflect.Message

func (*Model_ExportFormat) Reset

func (x *Model_ExportFormat) Reset()

func (*Model_ExportFormat) String

func (x *Model_ExportFormat) String() string

type Model_ExportFormat_ExportableContent

type Model_ExportFormat_ExportableContent int32

The Model content that can be exported.

const (
	// Should not be used.
	Model_ExportFormat_EXPORTABLE_CONTENT_UNSPECIFIED Model_ExportFormat_ExportableContent = 0
	// Model artifact and any of its supported files. Will be exported to the
	// location specified by the `artifactDestination` field of the
	// [ExportModelRequest.output_config][google.cloud.aiplatform.v1.ExportModelRequest.output_config]
	// object.
	Model_ExportFormat_ARTIFACT Model_ExportFormat_ExportableContent = 1
	// The container image that is to be used when deploying this Model. Will
	// be exported to the location specified by the `imageDestination` field
	// of the
	// [ExportModelRequest.output_config][google.cloud.aiplatform.v1.ExportModelRequest.output_config]
	// object.
	Model_ExportFormat_IMAGE Model_ExportFormat_ExportableContent = 2
)

func (Model_ExportFormat_ExportableContent) Descriptor

func (Model_ExportFormat_ExportableContent) Enum

func (Model_ExportFormat_ExportableContent) EnumDescriptor deprecated

func (Model_ExportFormat_ExportableContent) EnumDescriptor() ([]byte, []int)

Deprecated: Use Model_ExportFormat_ExportableContent.Descriptor instead.

func (Model_ExportFormat_ExportableContent) Number

func (Model_ExportFormat_ExportableContent) String

func (Model_ExportFormat_ExportableContent) Type

type Model_OriginalModelInfo added in v1.34.0

type Model_OriginalModelInfo struct {

	// Output only. The resource name of the Model this Model is a copy of,
	// including the revision. Format:
	// `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// contains filtered or unexported fields
}

Contains information about the original Model if this Model is a copy.

func (*Model_OriginalModelInfo) Descriptor deprecated added in v1.34.0

func (*Model_OriginalModelInfo) Descriptor() ([]byte, []int)

Deprecated: Use Model_OriginalModelInfo.ProtoReflect.Descriptor instead.

func (*Model_OriginalModelInfo) GetModel added in v1.34.0

func (x *Model_OriginalModelInfo) GetModel() string

func (*Model_OriginalModelInfo) ProtoMessage added in v1.34.0

func (*Model_OriginalModelInfo) ProtoMessage()

func (*Model_OriginalModelInfo) ProtoReflect added in v1.34.0

func (x *Model_OriginalModelInfo) ProtoReflect() protoreflect.Message

func (*Model_OriginalModelInfo) Reset added in v1.34.0

func (x *Model_OriginalModelInfo) Reset()

func (*Model_OriginalModelInfo) String added in v1.34.0

func (x *Model_OriginalModelInfo) String() string

type MutateDeployedIndexOperationMetadata

type MutateDeployedIndexOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// The unique index id specified by user
	DeployedIndexId string `protobuf:"bytes,2,opt,name=deployed_index_id,json=deployedIndexId,proto3" json:"deployed_index_id,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex].

func (*MutateDeployedIndexOperationMetadata) Descriptor deprecated

func (*MutateDeployedIndexOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use MutateDeployedIndexOperationMetadata.ProtoReflect.Descriptor instead.

func (*MutateDeployedIndexOperationMetadata) GetDeployedIndexId

func (x *MutateDeployedIndexOperationMetadata) GetDeployedIndexId() string

func (*MutateDeployedIndexOperationMetadata) GetGenericMetadata

func (*MutateDeployedIndexOperationMetadata) ProtoMessage

func (*MutateDeployedIndexOperationMetadata) ProtoMessage()

func (*MutateDeployedIndexOperationMetadata) ProtoReflect

func (*MutateDeployedIndexOperationMetadata) Reset

func (*MutateDeployedIndexOperationMetadata) String

type MutateDeployedIndexRequest

type MutateDeployedIndexRequest struct {

	// Required. The name of the IndexEndpoint resource into which to deploy an
	// Index. Format:
	// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
	IndexEndpoint string `protobuf:"bytes,1,opt,name=index_endpoint,json=indexEndpoint,proto3" json:"index_endpoint,omitempty"`
	// Required. The DeployedIndex to be updated within the IndexEndpoint.
	// Currently, the updatable fields are [DeployedIndex][automatic_resources]
	// and [DeployedIndex][dedicated_resources]
	DeployedIndex *DeployedIndex `protobuf:"bytes,2,opt,name=deployed_index,json=deployedIndex,proto3" json:"deployed_index,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex].

func (*MutateDeployedIndexRequest) Descriptor deprecated

func (*MutateDeployedIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use MutateDeployedIndexRequest.ProtoReflect.Descriptor instead.

func (*MutateDeployedIndexRequest) GetDeployedIndex

func (x *MutateDeployedIndexRequest) GetDeployedIndex() *DeployedIndex

func (*MutateDeployedIndexRequest) GetIndexEndpoint

func (x *MutateDeployedIndexRequest) GetIndexEndpoint() string

func (*MutateDeployedIndexRequest) ProtoMessage

func (*MutateDeployedIndexRequest) ProtoMessage()

func (*MutateDeployedIndexRequest) ProtoReflect

func (*MutateDeployedIndexRequest) Reset

func (x *MutateDeployedIndexRequest) Reset()

func (*MutateDeployedIndexRequest) String

func (x *MutateDeployedIndexRequest) String() string

type MutateDeployedIndexResponse

type MutateDeployedIndexResponse struct {

	// The DeployedIndex that had been updated in the IndexEndpoint.
	DeployedIndex *DeployedIndex `protobuf:"bytes,1,opt,name=deployed_index,json=deployedIndex,proto3" json:"deployed_index,omitempty"`
	// contains filtered or unexported fields
}

Response message for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex].

func (*MutateDeployedIndexResponse) Descriptor deprecated

func (*MutateDeployedIndexResponse) Descriptor() ([]byte, []int)

Deprecated: Use MutateDeployedIndexResponse.ProtoReflect.Descriptor instead.

func (*MutateDeployedIndexResponse) GetDeployedIndex

func (x *MutateDeployedIndexResponse) GetDeployedIndex() *DeployedIndex

func (*MutateDeployedIndexResponse) ProtoMessage

func (*MutateDeployedIndexResponse) ProtoMessage()

func (*MutateDeployedIndexResponse) ProtoReflect

func (*MutateDeployedIndexResponse) Reset

func (x *MutateDeployedIndexResponse) Reset()

func (*MutateDeployedIndexResponse) String

func (x *MutateDeployedIndexResponse) String() string

type MutateDeployedModelOperationMetadata added in v1.40.0

type MutateDeployedModelOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [EndpointService.MutateDeployedModel][google.cloud.aiplatform.v1.EndpointService.MutateDeployedModel].

func (*MutateDeployedModelOperationMetadata) Descriptor deprecated added in v1.40.0

func (*MutateDeployedModelOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use MutateDeployedModelOperationMetadata.ProtoReflect.Descriptor instead.

func (*MutateDeployedModelOperationMetadata) GetGenericMetadata added in v1.40.0

func (*MutateDeployedModelOperationMetadata) ProtoMessage added in v1.40.0

func (*MutateDeployedModelOperationMetadata) ProtoMessage()

func (*MutateDeployedModelOperationMetadata) ProtoReflect added in v1.40.0

func (*MutateDeployedModelOperationMetadata) Reset added in v1.40.0

func (*MutateDeployedModelOperationMetadata) String added in v1.40.0

type MutateDeployedModelRequest added in v1.40.0

type MutateDeployedModelRequest struct {

	// Required. The name of the Endpoint resource into which to mutate a
	// DeployedModel. Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Required. The DeployedModel to be mutated within the Endpoint. Only the
	// following fields can be mutated:
	//
	// * `min_replica_count` in either
	// [DedicatedResources][google.cloud.aiplatform.v1.DedicatedResources] or
	// [AutomaticResources][google.cloud.aiplatform.v1.AutomaticResources]
	// * `max_replica_count` in either
	// [DedicatedResources][google.cloud.aiplatform.v1.DedicatedResources] or
	// [AutomaticResources][google.cloud.aiplatform.v1.AutomaticResources]
	// * [autoscaling_metric_specs][google.cloud.aiplatform.v1.DedicatedResources.autoscaling_metric_specs]
	// * `disable_container_logging` (v1 only)
	// * `enable_container_logging` (v1beta1 only)
	DeployedModel *DeployedModel `protobuf:"bytes,2,opt,name=deployed_model,json=deployedModel,proto3" json:"deployed_model,omitempty"`
	// Required. The update mask applies to the resource. See
	// [google.protobuf.FieldMask][google.protobuf.FieldMask].
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EndpointService.MutateDeployedModel][google.cloud.aiplatform.v1.EndpointService.MutateDeployedModel].

func (*MutateDeployedModelRequest) Descriptor deprecated added in v1.40.0

func (*MutateDeployedModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use MutateDeployedModelRequest.ProtoReflect.Descriptor instead.

func (*MutateDeployedModelRequest) GetDeployedModel added in v1.40.0

func (x *MutateDeployedModelRequest) GetDeployedModel() *DeployedModel

func (*MutateDeployedModelRequest) GetEndpoint added in v1.40.0

func (x *MutateDeployedModelRequest) GetEndpoint() string

func (*MutateDeployedModelRequest) GetUpdateMask added in v1.40.0

func (x *MutateDeployedModelRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*MutateDeployedModelRequest) ProtoMessage added in v1.40.0

func (*MutateDeployedModelRequest) ProtoMessage()

func (*MutateDeployedModelRequest) ProtoReflect added in v1.40.0

func (*MutateDeployedModelRequest) Reset added in v1.40.0

func (x *MutateDeployedModelRequest) Reset()

func (*MutateDeployedModelRequest) String added in v1.40.0

func (x *MutateDeployedModelRequest) String() string

type MutateDeployedModelResponse added in v1.40.0

type MutateDeployedModelResponse struct {

	// The DeployedModel that's being mutated.
	DeployedModel *DeployedModel `protobuf:"bytes,1,opt,name=deployed_model,json=deployedModel,proto3" json:"deployed_model,omitempty"`
	// contains filtered or unexported fields
}

Response message for [EndpointService.MutateDeployedModel][google.cloud.aiplatform.v1.EndpointService.MutateDeployedModel].

func (*MutateDeployedModelResponse) Descriptor deprecated added in v1.40.0

func (*MutateDeployedModelResponse) Descriptor() ([]byte, []int)

Deprecated: Use MutateDeployedModelResponse.ProtoReflect.Descriptor instead.

func (*MutateDeployedModelResponse) GetDeployedModel added in v1.40.0

func (x *MutateDeployedModelResponse) GetDeployedModel() *DeployedModel

func (*MutateDeployedModelResponse) ProtoMessage added in v1.40.0

func (*MutateDeployedModelResponse) ProtoMessage()

func (*MutateDeployedModelResponse) ProtoReflect added in v1.40.0

func (*MutateDeployedModelResponse) Reset added in v1.40.0

func (x *MutateDeployedModelResponse) Reset()

func (*MutateDeployedModelResponse) String added in v1.40.0

func (x *MutateDeployedModelResponse) String() string

type NasJob added in v1.34.0

type NasJob struct {

	// Output only. Resource name of the NasJob.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The display name of the NasJob.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Required. The specification of a NasJob.
	NasJobSpec *NasJobSpec `protobuf:"bytes,4,opt,name=nas_job_spec,json=nasJobSpec,proto3" json:"nas_job_spec,omitempty"`
	// Output only. Output of the NasJob.
	NasJobOutput *NasJobOutput `protobuf:"bytes,5,opt,name=nas_job_output,json=nasJobOutput,proto3" json:"nas_job_output,omitempty"`
	// Output only. The detailed state of the job.
	State JobState `protobuf:"varint,6,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.JobState" json:"state,omitempty"`
	// Output only. Time when the NasJob was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Time when the NasJob for the first time entered the
	// `JOB_STATE_RUNNING` state.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. Time when the NasJob entered any of the following states:
	// `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Time when the NasJob was most recently updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Only populated when job's state is JOB_STATE_FAILED or
	// JOB_STATE_CANCELLED.
	Error *status.Status `protobuf:"bytes,11,opt,name=error,proto3" json:"error,omitempty"`
	// The labels with user-defined metadata to organize NasJobs.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Customer-managed encryption key options for a NasJob.
	// If this is set, then all resources created by the NasJob
	// will be encrypted with the provided encryption key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,13,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// Optional. Enable a separation of Custom model training
	// and restricted image training for tenant project.
	//
	// Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/nas_job.proto.
	EnableRestrictedImageTraining bool `` /* 154-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents a Neural Architecture Search (NAS) job.

func (*NasJob) Descriptor deprecated added in v1.34.0

func (*NasJob) Descriptor() ([]byte, []int)

Deprecated: Use NasJob.ProtoReflect.Descriptor instead.

func (*NasJob) GetCreateTime added in v1.34.0

func (x *NasJob) GetCreateTime() *timestamppb.Timestamp

func (*NasJob) GetDisplayName added in v1.34.0

func (x *NasJob) GetDisplayName() string

func (*NasJob) GetEnableRestrictedImageTraining deprecated added in v1.34.0

func (x *NasJob) GetEnableRestrictedImageTraining() bool

Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/nas_job.proto.

func (*NasJob) GetEncryptionSpec added in v1.34.0

func (x *NasJob) GetEncryptionSpec() *EncryptionSpec

func (*NasJob) GetEndTime added in v1.34.0

func (x *NasJob) GetEndTime() *timestamppb.Timestamp

func (*NasJob) GetError added in v1.34.0

func (x *NasJob) GetError() *status.Status

func (*NasJob) GetLabels added in v1.34.0

func (x *NasJob) GetLabels() map[string]string

func (*NasJob) GetName added in v1.34.0

func (x *NasJob) GetName() string

func (*NasJob) GetNasJobOutput added in v1.34.0

func (x *NasJob) GetNasJobOutput() *NasJobOutput

func (*NasJob) GetNasJobSpec added in v1.34.0

func (x *NasJob) GetNasJobSpec() *NasJobSpec

func (*NasJob) GetStartTime added in v1.34.0

func (x *NasJob) GetStartTime() *timestamppb.Timestamp

func (*NasJob) GetState added in v1.34.0

func (x *NasJob) GetState() JobState

func (*NasJob) GetUpdateTime added in v1.34.0

func (x *NasJob) GetUpdateTime() *timestamppb.Timestamp

func (*NasJob) ProtoMessage added in v1.34.0

func (*NasJob) ProtoMessage()

func (*NasJob) ProtoReflect added in v1.34.0

func (x *NasJob) ProtoReflect() protoreflect.Message

func (*NasJob) Reset added in v1.34.0

func (x *NasJob) Reset()

func (*NasJob) String added in v1.34.0

func (x *NasJob) String() string

type NasJobOutput added in v1.34.0

type NasJobOutput struct {

	// The output of this Neural Architecture Search (NAS) job.
	//
	// Types that are assignable to Output:
	//
	//	*NasJobOutput_MultiTrialJobOutput_
	Output isNasJobOutput_Output `protobuf_oneof:"output"`
	// contains filtered or unexported fields
}

Represents a uCAIP NasJob output.

func (*NasJobOutput) Descriptor deprecated added in v1.34.0

func (*NasJobOutput) Descriptor() ([]byte, []int)

Deprecated: Use NasJobOutput.ProtoReflect.Descriptor instead.

func (*NasJobOutput) GetMultiTrialJobOutput added in v1.34.0

func (x *NasJobOutput) GetMultiTrialJobOutput() *NasJobOutput_MultiTrialJobOutput

func (*NasJobOutput) GetOutput added in v1.34.0

func (m *NasJobOutput) GetOutput() isNasJobOutput_Output

func (*NasJobOutput) ProtoMessage added in v1.34.0

func (*NasJobOutput) ProtoMessage()

func (*NasJobOutput) ProtoReflect added in v1.34.0

func (x *NasJobOutput) ProtoReflect() protoreflect.Message

func (*NasJobOutput) Reset added in v1.34.0

func (x *NasJobOutput) Reset()

func (*NasJobOutput) String added in v1.34.0

func (x *NasJobOutput) String() string

type NasJobOutput_MultiTrialJobOutput added in v1.34.0

type NasJobOutput_MultiTrialJobOutput struct {

	// Output only. List of NasTrials that were started as part of search stage.
	SearchTrials []*NasTrial `protobuf:"bytes,1,rep,name=search_trials,json=searchTrials,proto3" json:"search_trials,omitempty"`
	// Output only. List of NasTrials that were started as part of train stage.
	TrainTrials []*NasTrial `protobuf:"bytes,2,rep,name=train_trials,json=trainTrials,proto3" json:"train_trials,omitempty"`
	// contains filtered or unexported fields
}

The output of a multi-trial Neural Architecture Search (NAS) jobs.

func (*NasJobOutput_MultiTrialJobOutput) Descriptor deprecated added in v1.34.0

func (*NasJobOutput_MultiTrialJobOutput) Descriptor() ([]byte, []int)

Deprecated: Use NasJobOutput_MultiTrialJobOutput.ProtoReflect.Descriptor instead.

func (*NasJobOutput_MultiTrialJobOutput) GetSearchTrials added in v1.34.0

func (x *NasJobOutput_MultiTrialJobOutput) GetSearchTrials() []*NasTrial

func (*NasJobOutput_MultiTrialJobOutput) GetTrainTrials added in v1.34.0

func (x *NasJobOutput_MultiTrialJobOutput) GetTrainTrials() []*NasTrial

func (*NasJobOutput_MultiTrialJobOutput) ProtoMessage added in v1.34.0

func (*NasJobOutput_MultiTrialJobOutput) ProtoMessage()

func (*NasJobOutput_MultiTrialJobOutput) ProtoReflect added in v1.34.0

func (*NasJobOutput_MultiTrialJobOutput) Reset added in v1.34.0

func (*NasJobOutput_MultiTrialJobOutput) String added in v1.34.0

type NasJobOutput_MultiTrialJobOutput_ added in v1.34.0

type NasJobOutput_MultiTrialJobOutput_ struct {
	// Output only. The output of this multi-trial Neural Architecture Search
	// (NAS) job.
	MultiTrialJobOutput *NasJobOutput_MultiTrialJobOutput `protobuf:"bytes,1,opt,name=multi_trial_job_output,json=multiTrialJobOutput,proto3,oneof"`
}

type NasJobSpec added in v1.34.0

type NasJobSpec struct {

	// The Neural Architecture Search (NAS) algorithm specification.
	//
	// Types that are assignable to NasAlgorithmSpec:
	//
	//	*NasJobSpec_MultiTrialAlgorithmSpec_
	NasAlgorithmSpec isNasJobSpec_NasAlgorithmSpec `protobuf_oneof:"nas_algorithm_spec"`
	// The ID of the existing NasJob in the same Project and Location
	// which will be used to resume search. search_space_spec and
	// nas_algorithm_spec are obtained from previous NasJob hence should not
	// provide them again for this NasJob.
	ResumeNasJobId string `protobuf:"bytes,3,opt,name=resume_nas_job_id,json=resumeNasJobId,proto3" json:"resume_nas_job_id,omitempty"`
	// It defines the search space for Neural Architecture Search (NAS).
	SearchSpaceSpec string `protobuf:"bytes,1,opt,name=search_space_spec,json=searchSpaceSpec,proto3" json:"search_space_spec,omitempty"`
	// contains filtered or unexported fields
}

Represents the spec of a NasJob.

func (*NasJobSpec) Descriptor deprecated added in v1.34.0

func (*NasJobSpec) Descriptor() ([]byte, []int)

Deprecated: Use NasJobSpec.ProtoReflect.Descriptor instead.

func (*NasJobSpec) GetMultiTrialAlgorithmSpec added in v1.34.0

func (x *NasJobSpec) GetMultiTrialAlgorithmSpec() *NasJobSpec_MultiTrialAlgorithmSpec

func (*NasJobSpec) GetNasAlgorithmSpec added in v1.34.0

func (m *NasJobSpec) GetNasAlgorithmSpec() isNasJobSpec_NasAlgorithmSpec

func (*NasJobSpec) GetResumeNasJobId added in v1.34.0

func (x *NasJobSpec) GetResumeNasJobId() string

func (*NasJobSpec) GetSearchSpaceSpec added in v1.34.0

func (x *NasJobSpec) GetSearchSpaceSpec() string

func (*NasJobSpec) ProtoMessage added in v1.34.0

func (*NasJobSpec) ProtoMessage()

func (*NasJobSpec) ProtoReflect added in v1.34.0

func (x *NasJobSpec) ProtoReflect() protoreflect.Message

func (*NasJobSpec) Reset added in v1.34.0

func (x *NasJobSpec) Reset()

func (*NasJobSpec) String added in v1.34.0

func (x *NasJobSpec) String() string

type NasJobSpec_MultiTrialAlgorithmSpec added in v1.34.0

type NasJobSpec_MultiTrialAlgorithmSpec struct {

	// The multi-trial Neural Architecture Search (NAS) algorithm
	// type. Defaults to `REINFORCEMENT_LEARNING`.
	MultiTrialAlgorithm NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm `` /* 208-byte string literal not displayed */
	// Metric specs for the NAS job.
	// Validation for this field is done at `multi_trial_algorithm_spec` field.
	Metric *NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec `protobuf:"bytes,2,opt,name=metric,proto3" json:"metric,omitempty"`
	// Required. Spec for search trials.
	SearchTrialSpec *NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec `protobuf:"bytes,3,opt,name=search_trial_spec,json=searchTrialSpec,proto3" json:"search_trial_spec,omitempty"`
	// Spec for train trials. Top N [TrainTrialSpec.max_parallel_trial_count]
	// search trials will be trained for every M
	// [TrainTrialSpec.frequency] trials searched.
	TrainTrialSpec *NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec `protobuf:"bytes,4,opt,name=train_trial_spec,json=trainTrialSpec,proto3" json:"train_trial_spec,omitempty"`
	// contains filtered or unexported fields
}

The spec of multi-trial Neural Architecture Search (NAS).

func (*NasJobSpec_MultiTrialAlgorithmSpec) Descriptor deprecated added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec) Descriptor() ([]byte, []int)

Deprecated: Use NasJobSpec_MultiTrialAlgorithmSpec.ProtoReflect.Descriptor instead.

func (*NasJobSpec_MultiTrialAlgorithmSpec) GetMetric added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec) GetMultiTrialAlgorithm added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec) GetSearchTrialSpec added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec) GetTrainTrialSpec added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec) ProtoMessage added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec) ProtoMessage()

func (*NasJobSpec_MultiTrialAlgorithmSpec) ProtoReflect added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec) Reset added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec) String added in v1.34.0

type NasJobSpec_MultiTrialAlgorithmSpec_ added in v1.34.0

type NasJobSpec_MultiTrialAlgorithmSpec_ struct {
	// The spec of multi-trial algorithms.
	MultiTrialAlgorithmSpec *NasJobSpec_MultiTrialAlgorithmSpec `protobuf:"bytes,2,opt,name=multi_trial_algorithm_spec,json=multiTrialAlgorithmSpec,proto3,oneof"`
}

type NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec added in v1.34.0

type NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec struct {

	// Required. The ID of the metric. Must not contain whitespaces.
	MetricId string `protobuf:"bytes,1,opt,name=metric_id,json=metricId,proto3" json:"metric_id,omitempty"`
	// Required. The optimization goal of the metric.
	Goal NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents a metric to optimize.

func (*NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec) Descriptor deprecated added in v1.34.0

Deprecated: Use NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec.ProtoReflect.Descriptor instead.

func (*NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec) GetGoal added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec) GetMetricId added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec) ProtoMessage added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec) ProtoReflect added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec) Reset added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec) String added in v1.34.0

type NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType added in v1.34.0

type NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType int32

The available types of optimization goals.

const (
	// Goal Type will default to maximize.
	NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GOAL_TYPE_UNSPECIFIED NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType = 0
	// Maximize the goal metric.
	NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_MAXIMIZE NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType = 1
	// Minimize the goal metric.
	NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_MINIMIZE NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType = 2
)

func (NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType) Descriptor added in v1.34.0

func (NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType) Enum added in v1.34.0

func (NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType) EnumDescriptor deprecated added in v1.34.0

Deprecated: Use NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType.Descriptor instead.

func (NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType) Number added in v1.34.0

func (NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType) String added in v1.34.0

func (NasJobSpec_MultiTrialAlgorithmSpec_MetricSpec_GoalType) Type added in v1.34.0

type NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm added in v1.34.0

type NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm int32

The available types of multi-trial algorithms.

const (
	// Defaults to `REINFORCEMENT_LEARNING`.
	NasJobSpec_MultiTrialAlgorithmSpec_MULTI_TRIAL_ALGORITHM_UNSPECIFIED NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm = 0
	// The Reinforcement Learning Algorithm for Multi-trial Neural
	// Architecture Search (NAS).
	NasJobSpec_MultiTrialAlgorithmSpec_REINFORCEMENT_LEARNING NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm = 1
	// The Grid Search Algorithm for Multi-trial Neural
	// Architecture Search (NAS).
	NasJobSpec_MultiTrialAlgorithmSpec_GRID_SEARCH NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm = 2
)

func (NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm) Descriptor added in v1.34.0

func (NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm) Enum added in v1.34.0

func (NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm) EnumDescriptor deprecated added in v1.34.0

Deprecated: Use NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm.Descriptor instead.

func (NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm) Number added in v1.34.0

func (NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm) String added in v1.34.0

func (NasJobSpec_MultiTrialAlgorithmSpec_MultiTrialAlgorithm) Type added in v1.34.0

type NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec added in v1.34.0

type NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec struct {

	// Required. The spec of a search trial job. The same spec applies to
	// all search trials.
	SearchTrialJobSpec *CustomJobSpec `protobuf:"bytes,1,opt,name=search_trial_job_spec,json=searchTrialJobSpec,proto3" json:"search_trial_job_spec,omitempty"`
	// Required. The maximum number of Neural Architecture Search (NAS) trials
	// to run.
	MaxTrialCount int32 `protobuf:"varint,2,opt,name=max_trial_count,json=maxTrialCount,proto3" json:"max_trial_count,omitempty"`
	// Required. The maximum number of trials to run in parallel.
	MaxParallelTrialCount int32 `` /* 129-byte string literal not displayed */
	// The number of failed trials that need to be seen before failing
	// the NasJob.
	//
	// If set to 0, Vertex AI decides how many trials must fail
	// before the whole job fails.
	MaxFailedTrialCount int32 `protobuf:"varint,4,opt,name=max_failed_trial_count,json=maxFailedTrialCount,proto3" json:"max_failed_trial_count,omitempty"`
	// contains filtered or unexported fields
}

Represent spec for search trials.

func (*NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec) Descriptor deprecated added in v1.34.0

Deprecated: Use NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec.ProtoReflect.Descriptor instead.

func (*NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec) GetMaxFailedTrialCount added in v1.34.0

func (x *NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec) GetMaxFailedTrialCount() int32

func (*NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec) GetMaxParallelTrialCount added in v1.34.0

func (x *NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec) GetMaxParallelTrialCount() int32

func (*NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec) GetMaxTrialCount added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec) GetSearchTrialJobSpec added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec) ProtoMessage added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec) ProtoReflect added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec) Reset added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_SearchTrialSpec) String added in v1.34.0

type NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec added in v1.34.0

type NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec struct {

	// Required. The spec of a train trial job. The same spec applies to
	// all train trials.
	TrainTrialJobSpec *CustomJobSpec `protobuf:"bytes,1,opt,name=train_trial_job_spec,json=trainTrialJobSpec,proto3" json:"train_trial_job_spec,omitempty"`
	// Required. The maximum number of trials to run in parallel.
	MaxParallelTrialCount int32 `` /* 129-byte string literal not displayed */
	// Required. Frequency of search trials to start train stage. Top N
	// [TrainTrialSpec.max_parallel_trial_count]
	// search trials will be trained for every M
	// [TrainTrialSpec.frequency] trials searched.
	Frequency int32 `protobuf:"varint,3,opt,name=frequency,proto3" json:"frequency,omitempty"`
	// contains filtered or unexported fields
}

Represent spec for train trials.

func (*NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec) Descriptor deprecated added in v1.34.0

Deprecated: Use NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec.ProtoReflect.Descriptor instead.

func (*NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec) GetFrequency added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec) GetMaxParallelTrialCount added in v1.34.0

func (x *NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec) GetMaxParallelTrialCount() int32

func (*NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec) GetTrainTrialJobSpec added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec) ProtoMessage added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec) ProtoReflect added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec) Reset added in v1.34.0

func (*NasJobSpec_MultiTrialAlgorithmSpec_TrainTrialSpec) String added in v1.34.0

type NasTrial added in v1.34.0

type NasTrial struct {

	// Output only. The identifier of the NasTrial assigned by the service.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Output only. The detailed state of the NasTrial.
	State NasTrial_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.NasTrial_State" json:"state,omitempty"`
	// Output only. The final measurement containing the objective value.
	FinalMeasurement *Measurement `protobuf:"bytes,3,opt,name=final_measurement,json=finalMeasurement,proto3" json:"final_measurement,omitempty"`
	// Output only. Time when the NasTrial was started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. Time when the NasTrial's status changed to `SUCCEEDED` or
	// `INFEASIBLE`.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Represents a uCAIP NasJob trial.

func (*NasTrial) Descriptor deprecated added in v1.34.0

func (*NasTrial) Descriptor() ([]byte, []int)

Deprecated: Use NasTrial.ProtoReflect.Descriptor instead.

func (*NasTrial) GetEndTime added in v1.34.0

func (x *NasTrial) GetEndTime() *timestamppb.Timestamp

func (*NasTrial) GetFinalMeasurement added in v1.34.0

func (x *NasTrial) GetFinalMeasurement() *Measurement

func (*NasTrial) GetId added in v1.34.0

func (x *NasTrial) GetId() string

func (*NasTrial) GetStartTime added in v1.34.0

func (x *NasTrial) GetStartTime() *timestamppb.Timestamp

func (*NasTrial) GetState added in v1.34.0

func (x *NasTrial) GetState() NasTrial_State

func (*NasTrial) ProtoMessage added in v1.34.0

func (*NasTrial) ProtoMessage()

func (*NasTrial) ProtoReflect added in v1.34.0

func (x *NasTrial) ProtoReflect() protoreflect.Message

func (*NasTrial) Reset added in v1.34.0

func (x *NasTrial) Reset()

func (*NasTrial) String added in v1.34.0

func (x *NasTrial) String() string

type NasTrialDetail added in v1.34.0

type NasTrialDetail struct {

	// Output only. Resource name of the NasTrialDetail.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The parameters for the NasJob NasTrial.
	Parameters string `protobuf:"bytes,2,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// The requested search NasTrial.
	SearchTrial *NasTrial `protobuf:"bytes,3,opt,name=search_trial,json=searchTrial,proto3" json:"search_trial,omitempty"`
	// The train NasTrial corresponding to
	// [search_trial][google.cloud.aiplatform.v1.NasTrialDetail.search_trial].
	// Only populated if
	// [search_trial][google.cloud.aiplatform.v1.NasTrialDetail.search_trial] is
	// used for training.
	TrainTrial *NasTrial `protobuf:"bytes,4,opt,name=train_trial,json=trainTrial,proto3" json:"train_trial,omitempty"`
	// contains filtered or unexported fields
}

Represents a NasTrial details along with its parameters. If there is a corresponding train NasTrial, the train NasTrial is also returned.

func (*NasTrialDetail) Descriptor deprecated added in v1.34.0

func (*NasTrialDetail) Descriptor() ([]byte, []int)

Deprecated: Use NasTrialDetail.ProtoReflect.Descriptor instead.

func (*NasTrialDetail) GetName added in v1.34.0

func (x *NasTrialDetail) GetName() string

func (*NasTrialDetail) GetParameters added in v1.34.0

func (x *NasTrialDetail) GetParameters() string

func (*NasTrialDetail) GetSearchTrial added in v1.34.0

func (x *NasTrialDetail) GetSearchTrial() *NasTrial

func (*NasTrialDetail) GetTrainTrial added in v1.34.0

func (x *NasTrialDetail) GetTrainTrial() *NasTrial

func (*NasTrialDetail) ProtoMessage added in v1.34.0

func (*NasTrialDetail) ProtoMessage()

func (*NasTrialDetail) ProtoReflect added in v1.34.0

func (x *NasTrialDetail) ProtoReflect() protoreflect.Message

func (*NasTrialDetail) Reset added in v1.34.0

func (x *NasTrialDetail) Reset()

func (*NasTrialDetail) String added in v1.34.0

func (x *NasTrialDetail) String() string

type NasTrial_State added in v1.34.0

type NasTrial_State int32

Describes a NasTrial state.

const (
	// The NasTrial state is unspecified.
	NasTrial_STATE_UNSPECIFIED NasTrial_State = 0
	// Indicates that a specific NasTrial has been requested, but it has not yet
	// been suggested by the service.
	NasTrial_REQUESTED NasTrial_State = 1
	// Indicates that the NasTrial has been suggested.
	NasTrial_ACTIVE NasTrial_State = 2
	// Indicates that the NasTrial should stop according to the service.
	NasTrial_STOPPING NasTrial_State = 3
	// Indicates that the NasTrial is completed successfully.
	NasTrial_SUCCEEDED NasTrial_State = 4
	// Indicates that the NasTrial should not be attempted again.
	// The service will set a NasTrial to INFEASIBLE when it's done but missing
	// the final_measurement.
	NasTrial_INFEASIBLE NasTrial_State = 5
)

func (NasTrial_State) Descriptor added in v1.34.0

func (NasTrial_State) Enum added in v1.34.0

func (x NasTrial_State) Enum() *NasTrial_State

func (NasTrial_State) EnumDescriptor deprecated added in v1.34.0

func (NasTrial_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use NasTrial_State.Descriptor instead.

func (NasTrial_State) Number added in v1.34.0

func (NasTrial_State) String added in v1.34.0

func (x NasTrial_State) String() string

func (NasTrial_State) Type added in v1.34.0

type NearestNeighborQuery added in v1.60.0

type NearestNeighborQuery struct {

	// Types that are assignable to Instance:
	//
	//	*NearestNeighborQuery_EntityId
	//	*NearestNeighborQuery_Embedding_
	Instance isNearestNeighborQuery_Instance `protobuf_oneof:"instance"`
	// Optional. The number of similar entities to be retrieved from feature view
	// for each query.
	NeighborCount int32 `protobuf:"varint,3,opt,name=neighbor_count,json=neighborCount,proto3" json:"neighbor_count,omitempty"`
	// Optional. The list of string filters.
	StringFilters []*NearestNeighborQuery_StringFilter `protobuf:"bytes,4,rep,name=string_filters,json=stringFilters,proto3" json:"string_filters,omitempty"`
	// Optional. Crowding is a constraint on a neighbor list produced by nearest
	// neighbor search requiring that no more than
	// sper_crowding_attribute_neighbor_count of the k neighbors returned have the
	// same value of crowding_attribute. It's used for improving result diversity.
	PerCrowdingAttributeNeighborCount int32 `` /* 167-byte string literal not displayed */
	// Optional. Parameters that can be set to tune query on the fly.
	Parameters *NearestNeighborQuery_Parameters `protobuf:"bytes,7,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

A query to find a number of similar entities.

func (*NearestNeighborQuery) Descriptor deprecated added in v1.60.0

func (*NearestNeighborQuery) Descriptor() ([]byte, []int)

Deprecated: Use NearestNeighborQuery.ProtoReflect.Descriptor instead.

func (*NearestNeighborQuery) GetEmbedding added in v1.60.0

func (*NearestNeighborQuery) GetEntityId added in v1.60.0

func (x *NearestNeighborQuery) GetEntityId() string

func (*NearestNeighborQuery) GetInstance added in v1.60.0

func (m *NearestNeighborQuery) GetInstance() isNearestNeighborQuery_Instance

func (*NearestNeighborQuery) GetNeighborCount added in v1.60.0

func (x *NearestNeighborQuery) GetNeighborCount() int32

func (*NearestNeighborQuery) GetParameters added in v1.60.0

func (*NearestNeighborQuery) GetPerCrowdingAttributeNeighborCount added in v1.60.0

func (x *NearestNeighborQuery) GetPerCrowdingAttributeNeighborCount() int32

func (*NearestNeighborQuery) GetStringFilters added in v1.60.0

func (*NearestNeighborQuery) ProtoMessage added in v1.60.0

func (*NearestNeighborQuery) ProtoMessage()

func (*NearestNeighborQuery) ProtoReflect added in v1.60.0

func (x *NearestNeighborQuery) ProtoReflect() protoreflect.Message

func (*NearestNeighborQuery) Reset added in v1.60.0

func (x *NearestNeighborQuery) Reset()

func (*NearestNeighborQuery) String added in v1.60.0

func (x *NearestNeighborQuery) String() string

type NearestNeighborQuery_Embedding added in v1.60.0

type NearestNeighborQuery_Embedding struct {

	// Optional. Individual value in the embedding.
	Value []float32 `protobuf:"fixed32,1,rep,packed,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

The embedding vector.

func (*NearestNeighborQuery_Embedding) Descriptor deprecated added in v1.60.0

func (*NearestNeighborQuery_Embedding) Descriptor() ([]byte, []int)

Deprecated: Use NearestNeighborQuery_Embedding.ProtoReflect.Descriptor instead.

func (*NearestNeighborQuery_Embedding) GetValue added in v1.60.0

func (x *NearestNeighborQuery_Embedding) GetValue() []float32

func (*NearestNeighborQuery_Embedding) ProtoMessage added in v1.60.0

func (*NearestNeighborQuery_Embedding) ProtoMessage()

func (*NearestNeighborQuery_Embedding) ProtoReflect added in v1.60.0

func (*NearestNeighborQuery_Embedding) Reset added in v1.60.0

func (x *NearestNeighborQuery_Embedding) Reset()

func (*NearestNeighborQuery_Embedding) String added in v1.60.0

type NearestNeighborQuery_Embedding_ added in v1.60.0

type NearestNeighborQuery_Embedding_ struct {
	// Optional. The embedding vector that be used for similar search.
	Embedding *NearestNeighborQuery_Embedding `protobuf:"bytes,2,opt,name=embedding,proto3,oneof"`
}

type NearestNeighborQuery_EntityId added in v1.60.0

type NearestNeighborQuery_EntityId struct {
	// Optional. The entity id whose similar entities should be searched for.
	// If embedding is set, search will use embedding instead of
	// entity_id.
	EntityId string `protobuf:"bytes,1,opt,name=entity_id,json=entityId,proto3,oneof"`
}

type NearestNeighborQuery_Parameters added in v1.60.0

type NearestNeighborQuery_Parameters struct {

	// Optional. The number of neighbors to find via approximate search before
	// exact reordering is performed; if set, this value must be >
	// neighbor_count.
	ApproximateNeighborCandidates int32 `` /* 151-byte string literal not displayed */
	// Optional. The fraction of the number of leaves to search, set at query
	// time allows user to tune search performance. This value increase result
	// in both search accuracy and latency increase. The value should be between
	// 0.0 and 1.0.
	LeafNodesSearchFraction float64 `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

Parameters that can be overrided in each query to tune query latency and recall.

func (*NearestNeighborQuery_Parameters) Descriptor deprecated added in v1.60.0

func (*NearestNeighborQuery_Parameters) Descriptor() ([]byte, []int)

Deprecated: Use NearestNeighborQuery_Parameters.ProtoReflect.Descriptor instead.

func (*NearestNeighborQuery_Parameters) GetApproximateNeighborCandidates added in v1.60.0

func (x *NearestNeighborQuery_Parameters) GetApproximateNeighborCandidates() int32

func (*NearestNeighborQuery_Parameters) GetLeafNodesSearchFraction added in v1.60.0

func (x *NearestNeighborQuery_Parameters) GetLeafNodesSearchFraction() float64

func (*NearestNeighborQuery_Parameters) ProtoMessage added in v1.60.0

func (*NearestNeighborQuery_Parameters) ProtoMessage()

func (*NearestNeighborQuery_Parameters) ProtoReflect added in v1.60.0

func (*NearestNeighborQuery_Parameters) Reset added in v1.60.0

func (*NearestNeighborQuery_Parameters) String added in v1.60.0

type NearestNeighborQuery_StringFilter added in v1.60.0

type NearestNeighborQuery_StringFilter struct {

	// Required. Column names in BigQuery that used as filters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The allowed tokens.
	AllowTokens []string `protobuf:"bytes,2,rep,name=allow_tokens,json=allowTokens,proto3" json:"allow_tokens,omitempty"`
	// Optional. The denied tokens.
	DenyTokens []string `protobuf:"bytes,3,rep,name=deny_tokens,json=denyTokens,proto3" json:"deny_tokens,omitempty"`
	// contains filtered or unexported fields
}

String filter is used to search a subset of the entities by using boolean rules on string columns. For example: if a query specifies string filter with 'name = color, allow_tokens = {red, blue}, deny_tokens = {purple}',' then that query will match entities that are red or blue, but if those points are also purple, then they will be excluded even if they are red/blue. Only string filter is supported for now, numeric filter will be supported in the near future.

func (*NearestNeighborQuery_StringFilter) Descriptor deprecated added in v1.60.0

func (*NearestNeighborQuery_StringFilter) Descriptor() ([]byte, []int)

Deprecated: Use NearestNeighborQuery_StringFilter.ProtoReflect.Descriptor instead.

func (*NearestNeighborQuery_StringFilter) GetAllowTokens added in v1.60.0

func (x *NearestNeighborQuery_StringFilter) GetAllowTokens() []string

func (*NearestNeighborQuery_StringFilter) GetDenyTokens added in v1.60.0

func (x *NearestNeighborQuery_StringFilter) GetDenyTokens() []string

func (*NearestNeighborQuery_StringFilter) GetName added in v1.60.0

func (*NearestNeighborQuery_StringFilter) ProtoMessage added in v1.60.0

func (*NearestNeighborQuery_StringFilter) ProtoMessage()

func (*NearestNeighborQuery_StringFilter) ProtoReflect added in v1.60.0

func (*NearestNeighborQuery_StringFilter) Reset added in v1.60.0

func (*NearestNeighborQuery_StringFilter) String added in v1.60.0

type NearestNeighborSearchOperationMetadata

type NearestNeighborSearchOperationMetadata struct {

	// The validation stats of the content (per file) to be inserted or
	// updated on the Matching Engine Index resource. Populated if
	// contentsDeltaUri is provided as part of
	// [Index.metadata][google.cloud.aiplatform.v1.Index.metadata]. Please note
	// that, currently for those files that are broken or has unsupported file
	// format, we will not have the stats for those files.
	ContentValidationStats []*NearestNeighborSearchOperationMetadata_ContentValidationStats `` /* 129-byte string literal not displayed */
	// The ingested data size in bytes.
	DataBytesCount int64 `protobuf:"varint,2,opt,name=data_bytes_count,json=dataBytesCount,proto3" json:"data_bytes_count,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation metadata with regard to Matching Engine Index.

func (*NearestNeighborSearchOperationMetadata) Descriptor deprecated

func (*NearestNeighborSearchOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use NearestNeighborSearchOperationMetadata.ProtoReflect.Descriptor instead.

func (*NearestNeighborSearchOperationMetadata) GetContentValidationStats

func (*NearestNeighborSearchOperationMetadata) GetDataBytesCount

func (x *NearestNeighborSearchOperationMetadata) GetDataBytesCount() int64

func (*NearestNeighborSearchOperationMetadata) ProtoMessage

func (*NearestNeighborSearchOperationMetadata) ProtoReflect

func (*NearestNeighborSearchOperationMetadata) Reset

func (*NearestNeighborSearchOperationMetadata) String

type NearestNeighborSearchOperationMetadata_ContentValidationStats

type NearestNeighborSearchOperationMetadata_ContentValidationStats struct {

	// Cloud Storage URI pointing to the original file in user's bucket.
	SourceGcsUri string `protobuf:"bytes,1,opt,name=source_gcs_uri,json=sourceGcsUri,proto3" json:"source_gcs_uri,omitempty"`
	// Number of records in this file that were successfully processed.
	ValidRecordCount int64 `protobuf:"varint,2,opt,name=valid_record_count,json=validRecordCount,proto3" json:"valid_record_count,omitempty"`
	// Number of records in this file we skipped due to validate errors.
	InvalidRecordCount int64 `protobuf:"varint,3,opt,name=invalid_record_count,json=invalidRecordCount,proto3" json:"invalid_record_count,omitempty"`
	// The detail information of the partial failures encountered for those
	// invalid records that couldn't be parsed.
	// Up to 50 partial errors will be reported.
	PartialErrors []*NearestNeighborSearchOperationMetadata_RecordError `protobuf:"bytes,4,rep,name=partial_errors,json=partialErrors,proto3" json:"partial_errors,omitempty"`
	// contains filtered or unexported fields
}

func (*NearestNeighborSearchOperationMetadata_ContentValidationStats) Descriptor deprecated

Deprecated: Use NearestNeighborSearchOperationMetadata_ContentValidationStats.ProtoReflect.Descriptor instead.

func (*NearestNeighborSearchOperationMetadata_ContentValidationStats) GetInvalidRecordCount

func (*NearestNeighborSearchOperationMetadata_ContentValidationStats) GetPartialErrors

func (*NearestNeighborSearchOperationMetadata_ContentValidationStats) GetSourceGcsUri

func (*NearestNeighborSearchOperationMetadata_ContentValidationStats) GetValidRecordCount

func (*NearestNeighborSearchOperationMetadata_ContentValidationStats) ProtoMessage

func (*NearestNeighborSearchOperationMetadata_ContentValidationStats) ProtoReflect

func (*NearestNeighborSearchOperationMetadata_ContentValidationStats) Reset

func (*NearestNeighborSearchOperationMetadata_ContentValidationStats) String

type NearestNeighborSearchOperationMetadata_RecordError

type NearestNeighborSearchOperationMetadata_RecordError struct {

	// The error type of this record.
	ErrorType NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType `` /* 188-byte string literal not displayed */
	// A human-readable message that is shown to the user to help them fix the
	// error. Note that this message may change from time to time, your code
	// should check against error_type as the source of truth.
	ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// Cloud Storage URI pointing to the original file in user's bucket.
	SourceGcsUri string `protobuf:"bytes,3,opt,name=source_gcs_uri,json=sourceGcsUri,proto3" json:"source_gcs_uri,omitempty"`
	// Empty if the embedding id is failed to parse.
	EmbeddingId string `protobuf:"bytes,4,opt,name=embedding_id,json=embeddingId,proto3" json:"embedding_id,omitempty"`
	// The original content of this record.
	RawRecord string `protobuf:"bytes,5,opt,name=raw_record,json=rawRecord,proto3" json:"raw_record,omitempty"`
	// contains filtered or unexported fields
}

func (*NearestNeighborSearchOperationMetadata_RecordError) Descriptor deprecated

Deprecated: Use NearestNeighborSearchOperationMetadata_RecordError.ProtoReflect.Descriptor instead.

func (*NearestNeighborSearchOperationMetadata_RecordError) GetEmbeddingId

func (*NearestNeighborSearchOperationMetadata_RecordError) GetErrorMessage

func (*NearestNeighborSearchOperationMetadata_RecordError) GetErrorType

func (*NearestNeighborSearchOperationMetadata_RecordError) GetRawRecord

func (*NearestNeighborSearchOperationMetadata_RecordError) GetSourceGcsUri

func (*NearestNeighborSearchOperationMetadata_RecordError) ProtoMessage

func (*NearestNeighborSearchOperationMetadata_RecordError) ProtoReflect

func (*NearestNeighborSearchOperationMetadata_RecordError) Reset

func (*NearestNeighborSearchOperationMetadata_RecordError) String

type NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType

type NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType int32
const (
	// Default, shall not be used.
	NearestNeighborSearchOperationMetadata_RecordError_ERROR_TYPE_UNSPECIFIED NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 0
	// The record is empty.
	NearestNeighborSearchOperationMetadata_RecordError_EMPTY_LINE NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 1
	// Invalid json format.
	NearestNeighborSearchOperationMetadata_RecordError_INVALID_JSON_SYNTAX NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 2
	// Invalid csv format.
	NearestNeighborSearchOperationMetadata_RecordError_INVALID_CSV_SYNTAX NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 3
	// Invalid avro format.
	NearestNeighborSearchOperationMetadata_RecordError_INVALID_AVRO_SYNTAX NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 4
	// The embedding id is not valid.
	NearestNeighborSearchOperationMetadata_RecordError_INVALID_EMBEDDING_ID NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 5
	// The size of the embedding vectors does not match with the specified
	// dimension.
	NearestNeighborSearchOperationMetadata_RecordError_EMBEDDING_SIZE_MISMATCH NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 6
	// The `namespace` field is missing.
	NearestNeighborSearchOperationMetadata_RecordError_NAMESPACE_MISSING NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 7
	// Generic catch-all error. Only used for validation failure where the
	// root cause cannot be easily retrieved programmatically.
	NearestNeighborSearchOperationMetadata_RecordError_PARSING_ERROR NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 8
	// There are multiple restricts with the same `namespace` value.
	NearestNeighborSearchOperationMetadata_RecordError_DUPLICATE_NAMESPACE NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 9
	// Numeric restrict has operator specified in datapoint.
	NearestNeighborSearchOperationMetadata_RecordError_OP_IN_DATAPOINT NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 10
	// Numeric restrict has multiple values specified.
	NearestNeighborSearchOperationMetadata_RecordError_MULTIPLE_VALUES NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 11
	// Numeric restrict has invalid numeric value specified.
	NearestNeighborSearchOperationMetadata_RecordError_INVALID_NUMERIC_VALUE NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 12
	// File is not in UTF_8 format.
	NearestNeighborSearchOperationMetadata_RecordError_INVALID_ENCODING NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType = 13
)

func (NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType) Descriptor

func (NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType) Enum

func (NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType) EnumDescriptor deprecated

Deprecated: Use NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType.Descriptor instead.

func (NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType) Number

func (NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType) String

func (NearestNeighborSearchOperationMetadata_RecordError_RecordErrorType) Type

type NearestNeighbors added in v1.60.0

type NearestNeighbors struct {

	// All its neighbors.
	Neighbors []*NearestNeighbors_Neighbor `protobuf:"bytes,1,rep,name=neighbors,proto3" json:"neighbors,omitempty"`
	// contains filtered or unexported fields
}

Nearest neighbors for one query.

func (*NearestNeighbors) Descriptor deprecated added in v1.60.0

func (*NearestNeighbors) Descriptor() ([]byte, []int)

Deprecated: Use NearestNeighbors.ProtoReflect.Descriptor instead.

func (*NearestNeighbors) GetNeighbors added in v1.60.0

func (x *NearestNeighbors) GetNeighbors() []*NearestNeighbors_Neighbor

func (*NearestNeighbors) ProtoMessage added in v1.60.0

func (*NearestNeighbors) ProtoMessage()

func (*NearestNeighbors) ProtoReflect added in v1.60.0

func (x *NearestNeighbors) ProtoReflect() protoreflect.Message

func (*NearestNeighbors) Reset added in v1.60.0

func (x *NearestNeighbors) Reset()

func (*NearestNeighbors) String added in v1.60.0

func (x *NearestNeighbors) String() string

type NearestNeighbors_Neighbor added in v1.60.0

type NearestNeighbors_Neighbor struct {

	// The id of the similar entity.
	EntityId string `protobuf:"bytes,1,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
	// The distance between the neighbor and the query vector.
	Distance float64 `protobuf:"fixed64,2,opt,name=distance,proto3" json:"distance,omitempty"`
	// The attributes of the neighbor, e.g. filters, crowding and metadata
	// Note that full entities are returned only when "return_full_entity"
	// is set to true. Otherwise, only the "entity_id" and "distance" fields
	// are populated.
	EntityKeyValues *FetchFeatureValuesResponse `protobuf:"bytes,3,opt,name=entity_key_values,json=entityKeyValues,proto3" json:"entity_key_values,omitempty"`
	// contains filtered or unexported fields
}

A neighbor of the query vector.

func (*NearestNeighbors_Neighbor) Descriptor deprecated added in v1.60.0

func (*NearestNeighbors_Neighbor) Descriptor() ([]byte, []int)

Deprecated: Use NearestNeighbors_Neighbor.ProtoReflect.Descriptor instead.

func (*NearestNeighbors_Neighbor) GetDistance added in v1.60.0

func (x *NearestNeighbors_Neighbor) GetDistance() float64

func (*NearestNeighbors_Neighbor) GetEntityId added in v1.60.0

func (x *NearestNeighbors_Neighbor) GetEntityId() string

func (*NearestNeighbors_Neighbor) GetEntityKeyValues added in v1.60.0

func (x *NearestNeighbors_Neighbor) GetEntityKeyValues() *FetchFeatureValuesResponse

func (*NearestNeighbors_Neighbor) ProtoMessage added in v1.60.0

func (*NearestNeighbors_Neighbor) ProtoMessage()

func (*NearestNeighbors_Neighbor) ProtoReflect added in v1.60.0

func (*NearestNeighbors_Neighbor) Reset added in v1.60.0

func (x *NearestNeighbors_Neighbor) Reset()

func (*NearestNeighbors_Neighbor) String added in v1.60.0

func (x *NearestNeighbors_Neighbor) String() string

type Neighbor

type Neighbor struct {

	// Output only. The neighbor id.
	NeighborId string `protobuf:"bytes,1,opt,name=neighbor_id,json=neighborId,proto3" json:"neighbor_id,omitempty"`
	// Output only. The neighbor distance.
	NeighborDistance float64 `protobuf:"fixed64,2,opt,name=neighbor_distance,json=neighborDistance,proto3" json:"neighbor_distance,omitempty"`
	// contains filtered or unexported fields
}

Neighbors for example-based explanations.

func (*Neighbor) Descriptor deprecated

func (*Neighbor) Descriptor() ([]byte, []int)

Deprecated: Use Neighbor.ProtoReflect.Descriptor instead.

func (*Neighbor) GetNeighborDistance

func (x *Neighbor) GetNeighborDistance() float64

func (*Neighbor) GetNeighborId

func (x *Neighbor) GetNeighborId() string

func (*Neighbor) ProtoMessage

func (*Neighbor) ProtoMessage()

func (*Neighbor) ProtoReflect

func (x *Neighbor) ProtoReflect() protoreflect.Message

func (*Neighbor) Reset

func (x *Neighbor) Reset()

func (*Neighbor) String

func (x *Neighbor) String() string

type NetworkSpec added in v1.67.0

type NetworkSpec struct {

	// Whether to enable public internet access. Default false.
	EnableInternetAccess bool `protobuf:"varint,1,opt,name=enable_internet_access,json=enableInternetAccess,proto3" json:"enable_internet_access,omitempty"`
	// The full name of the Google Compute Engine
	// [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
	Network string `protobuf:"bytes,2,opt,name=network,proto3" json:"network,omitempty"`
	// The name of the subnet that this instance is in.
	// Format:
	// `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
	Subnetwork string `protobuf:"bytes,3,opt,name=subnetwork,proto3" json:"subnetwork,omitempty"`
	// contains filtered or unexported fields
}

Network spec.

func (*NetworkSpec) Descriptor deprecated added in v1.67.0

func (*NetworkSpec) Descriptor() ([]byte, []int)

Deprecated: Use NetworkSpec.ProtoReflect.Descriptor instead.

func (*NetworkSpec) GetEnableInternetAccess added in v1.67.0

func (x *NetworkSpec) GetEnableInternetAccess() bool

func (*NetworkSpec) GetNetwork added in v1.67.0

func (x *NetworkSpec) GetNetwork() string

func (*NetworkSpec) GetSubnetwork added in v1.67.0

func (x *NetworkSpec) GetSubnetwork() string

func (*NetworkSpec) ProtoMessage added in v1.67.0

func (*NetworkSpec) ProtoMessage()

func (*NetworkSpec) ProtoReflect added in v1.67.0

func (x *NetworkSpec) ProtoReflect() protoreflect.Message

func (*NetworkSpec) Reset added in v1.67.0

func (x *NetworkSpec) Reset()

func (*NetworkSpec) String added in v1.67.0

func (x *NetworkSpec) String() string

type NfsMount

type NfsMount struct {

	// Required. IP address of the NFS server.
	Server string `protobuf:"bytes,1,opt,name=server,proto3" json:"server,omitempty"`
	// Required. Source path exported from NFS server.
	// Has to start with '/', and combined with the ip address, it indicates
	// the source mount path in the form of `server:path`
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// Required. Destination mount path. The NFS will be mounted for the user
	// under /mnt/nfs/<mount_point>
	MountPoint string `protobuf:"bytes,3,opt,name=mount_point,json=mountPoint,proto3" json:"mount_point,omitempty"`
	// contains filtered or unexported fields
}

Represents a mount configuration for Network File System (NFS) to mount.

func (*NfsMount) Descriptor deprecated

func (*NfsMount) Descriptor() ([]byte, []int)

Deprecated: Use NfsMount.ProtoReflect.Descriptor instead.

func (*NfsMount) GetMountPoint

func (x *NfsMount) GetMountPoint() string

func (*NfsMount) GetPath

func (x *NfsMount) GetPath() string

func (*NfsMount) GetServer

func (x *NfsMount) GetServer() string

func (*NfsMount) ProtoMessage

func (*NfsMount) ProtoMessage()

func (*NfsMount) ProtoReflect

func (x *NfsMount) ProtoReflect() protoreflect.Message

func (*NfsMount) Reset

func (x *NfsMount) Reset()

func (*NfsMount) String

func (x *NfsMount) String() string

type NotebookEucConfig added in v1.67.0

type NotebookEucConfig struct {

	// Input only. Whether EUC is disabled in this NotebookRuntimeTemplate.
	// In proto3, the default value of a boolean is false. In this way, by default
	// EUC will be enabled for NotebookRuntimeTemplate.
	EucDisabled bool `protobuf:"varint,1,opt,name=euc_disabled,json=eucDisabled,proto3" json:"euc_disabled,omitempty"`
	// Output only. Whether ActAs check is bypassed for service account attached
	// to the VM. If false, we need ActAs check for the default Compute Engine
	// Service account. When a Runtime is created, a VM is allocated using Default
	// Compute Engine Service Account. Any user requesting to use this Runtime
	// requires Service Account User (ActAs) permission over this SA. If true,
	// Runtime owner is using EUC and does not require the above permission as VM
	// no longer use default Compute Engine SA, but a P4SA.
	BypassActasCheck bool `protobuf:"varint,2,opt,name=bypass_actas_check,json=bypassActasCheck,proto3" json:"bypass_actas_check,omitempty"`
	// contains filtered or unexported fields
}

The euc configuration of NotebookRuntimeTemplate.

func (*NotebookEucConfig) Descriptor deprecated added in v1.67.0

func (*NotebookEucConfig) Descriptor() ([]byte, []int)

Deprecated: Use NotebookEucConfig.ProtoReflect.Descriptor instead.

func (*NotebookEucConfig) GetBypassActasCheck added in v1.67.0

func (x *NotebookEucConfig) GetBypassActasCheck() bool

func (*NotebookEucConfig) GetEucDisabled added in v1.67.0

func (x *NotebookEucConfig) GetEucDisabled() bool

func (*NotebookEucConfig) ProtoMessage added in v1.67.0

func (*NotebookEucConfig) ProtoMessage()

func (*NotebookEucConfig) ProtoReflect added in v1.67.0

func (x *NotebookEucConfig) ProtoReflect() protoreflect.Message

func (*NotebookEucConfig) Reset added in v1.67.0

func (x *NotebookEucConfig) Reset()

func (*NotebookEucConfig) String added in v1.67.0

func (x *NotebookEucConfig) String() string

type NotebookIdleShutdownConfig added in v1.67.0

type NotebookIdleShutdownConfig struct {

	// Required. Duration is accurate to the second. In Notebook, Idle Timeout is
	// accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440
	// * 60.
	IdleTimeout *durationpb.Duration `protobuf:"bytes,1,opt,name=idle_timeout,json=idleTimeout,proto3" json:"idle_timeout,omitempty"`
	// Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
	IdleShutdownDisabled bool `protobuf:"varint,2,opt,name=idle_shutdown_disabled,json=idleShutdownDisabled,proto3" json:"idle_shutdown_disabled,omitempty"`
	// contains filtered or unexported fields
}

The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.

func (*NotebookIdleShutdownConfig) Descriptor deprecated added in v1.67.0

func (*NotebookIdleShutdownConfig) Descriptor() ([]byte, []int)

Deprecated: Use NotebookIdleShutdownConfig.ProtoReflect.Descriptor instead.

func (*NotebookIdleShutdownConfig) GetIdleShutdownDisabled added in v1.67.0

func (x *NotebookIdleShutdownConfig) GetIdleShutdownDisabled() bool

func (*NotebookIdleShutdownConfig) GetIdleTimeout added in v1.67.0

func (x *NotebookIdleShutdownConfig) GetIdleTimeout() *durationpb.Duration

func (*NotebookIdleShutdownConfig) ProtoMessage added in v1.67.0

func (*NotebookIdleShutdownConfig) ProtoMessage()

func (*NotebookIdleShutdownConfig) ProtoReflect added in v1.67.0

func (*NotebookIdleShutdownConfig) Reset added in v1.67.0

func (x *NotebookIdleShutdownConfig) Reset()

func (*NotebookIdleShutdownConfig) String added in v1.67.0

func (x *NotebookIdleShutdownConfig) String() string

type NotebookRuntime added in v1.67.0

type NotebookRuntime struct {

	// Output only. The resource name of the NotebookRuntime.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The user email of the NotebookRuntime.
	RuntimeUser string `protobuf:"bytes,2,opt,name=runtime_user,json=runtimeUser,proto3" json:"runtime_user,omitempty"`
	// Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is
	// created from.
	NotebookRuntimeTemplateRef *NotebookRuntimeTemplateRef `` /* 143-byte string literal not displayed */
	// Output only. The proxy endpoint used to access the NotebookRuntime.
	ProxyUri string `protobuf:"bytes,5,opt,name=proxy_uri,json=proxyUri,proto3" json:"proxy_uri,omitempty"`
	// Output only. Timestamp when this NotebookRuntime was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this NotebookRuntime was most recently updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The health state of the NotebookRuntime.
	HealthState NotebookRuntime_HealthState `` /* 155-byte string literal not displayed */
	// Required. The display name of the NotebookRuntime.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,10,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The description of the NotebookRuntime.
	Description string `protobuf:"bytes,11,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. The service account that the NotebookRuntime workload runs as.
	ServiceAccount string `protobuf:"bytes,13,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// Output only. The runtime (instance) state of the NotebookRuntime.
	RuntimeState NotebookRuntime_RuntimeState `` /* 160-byte string literal not displayed */
	// Output only. Whether NotebookRuntime is upgradable.
	IsUpgradable bool `protobuf:"varint,15,opt,name=is_upgradable,json=isUpgradable,proto3" json:"is_upgradable,omitempty"`
	// The labels with user-defined metadata to organize your
	// NotebookRuntime.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one NotebookRuntime
	// (System labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable. Following system labels exist for NotebookRuntime:
	//
	// * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output
	// only, its value is the Compute Engine instance id.
	// * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is
	// either "bigquery" or "vertex"; if absent, it should be "vertex". This is to
	// describe the entry service, either BigQuery or Vertex.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Output only. Timestamp when this NotebookRuntime will be expired:
	// 1. System Predefined NotebookRuntime: 24 hours after creation. After
	// expiration, system predifined runtime will be deleted.
	// 2. User created NotebookRuntime: 6 months after last upgrade. After
	// expiration, user created runtime will be stopped and allowed for upgrade.
	ExpirationTime *timestamppb.Timestamp `protobuf:"bytes,17,opt,name=expiration_time,json=expirationTime,proto3" json:"expiration_time,omitempty"`
	// Output only. The VM os image version of NotebookRuntime.
	Version string `protobuf:"bytes,18,opt,name=version,proto3" json:"version,omitempty"`
	// Output only. The type of the notebook runtime.
	NotebookRuntimeType NotebookRuntimeType `` /* 174-byte string literal not displayed */
	// Optional. The Compute Engine tags to add to runtime (see [Tagging
	// instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
	NetworkTags []string `protobuf:"bytes,25,rep,name=network_tags,json=networkTags,proto3" json:"network_tags,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*NotebookRuntime) Descriptor deprecated added in v1.67.0

func (*NotebookRuntime) Descriptor() ([]byte, []int)

Deprecated: Use NotebookRuntime.ProtoReflect.Descriptor instead.

func (*NotebookRuntime) GetCreateTime added in v1.67.0

func (x *NotebookRuntime) GetCreateTime() *timestamppb.Timestamp

func (*NotebookRuntime) GetDescription added in v1.67.0

func (x *NotebookRuntime) GetDescription() string

func (*NotebookRuntime) GetDisplayName added in v1.67.0

func (x *NotebookRuntime) GetDisplayName() string

func (*NotebookRuntime) GetExpirationTime added in v1.67.0

func (x *NotebookRuntime) GetExpirationTime() *timestamppb.Timestamp

func (*NotebookRuntime) GetHealthState added in v1.67.0

func (x *NotebookRuntime) GetHealthState() NotebookRuntime_HealthState

func (*NotebookRuntime) GetIsUpgradable added in v1.67.0

func (x *NotebookRuntime) GetIsUpgradable() bool

func (*NotebookRuntime) GetLabels added in v1.67.0

func (x *NotebookRuntime) GetLabels() map[string]string

func (*NotebookRuntime) GetName added in v1.67.0

func (x *NotebookRuntime) GetName() string

func (*NotebookRuntime) GetNetworkTags added in v1.67.0

func (x *NotebookRuntime) GetNetworkTags() []string

func (*NotebookRuntime) GetNotebookRuntimeTemplateRef added in v1.67.0

func (x *NotebookRuntime) GetNotebookRuntimeTemplateRef() *NotebookRuntimeTemplateRef

func (*NotebookRuntime) GetNotebookRuntimeType added in v1.67.0

func (x *NotebookRuntime) GetNotebookRuntimeType() NotebookRuntimeType

func (*NotebookRuntime) GetProxyUri added in v1.67.0

func (x *NotebookRuntime) GetProxyUri() string

func (*NotebookRuntime) GetRuntimeState added in v1.67.0

func (x *NotebookRuntime) GetRuntimeState() NotebookRuntime_RuntimeState

func (*NotebookRuntime) GetRuntimeUser added in v1.67.0

func (x *NotebookRuntime) GetRuntimeUser() string

func (*NotebookRuntime) GetServiceAccount added in v1.67.0

func (x *NotebookRuntime) GetServiceAccount() string

func (*NotebookRuntime) GetUpdateTime added in v1.67.0

func (x *NotebookRuntime) GetUpdateTime() *timestamppb.Timestamp

func (*NotebookRuntime) GetVersion added in v1.67.0

func (x *NotebookRuntime) GetVersion() string

func (*NotebookRuntime) ProtoMessage added in v1.67.0

func (*NotebookRuntime) ProtoMessage()

func (*NotebookRuntime) ProtoReflect added in v1.67.0

func (x *NotebookRuntime) ProtoReflect() protoreflect.Message

func (*NotebookRuntime) Reset added in v1.67.0

func (x *NotebookRuntime) Reset()

func (*NotebookRuntime) String added in v1.67.0

func (x *NotebookRuntime) String() string

type NotebookRuntimeTemplate added in v1.67.0

type NotebookRuntimeTemplate struct {

	// Output only. The resource name of the NotebookRuntimeTemplate.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The display name of the NotebookRuntimeTemplate.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The description of the NotebookRuntimeTemplate.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. The default template to use if not specified.
	IsDefault bool `protobuf:"varint,4,opt,name=is_default,json=isDefault,proto3" json:"is_default,omitempty"`
	// Optional. Immutable. The specification of a single machine for the
	// template.
	MachineSpec *MachineSpec `protobuf:"bytes,5,opt,name=machine_spec,json=machineSpec,proto3" json:"machine_spec,omitempty"`
	// Optional. The specification of [persistent
	// disk][https://cloud.google.com/compute/docs/disks/persistent-disks]
	// attached to the runtime as data disk storage.
	DataPersistentDiskSpec *PersistentDiskSpec `` /* 131-byte string literal not displayed */
	// Optional. Network spec.
	NetworkSpec *NetworkSpec `protobuf:"bytes,12,opt,name=network_spec,json=networkSpec,proto3" json:"network_spec,omitempty"`
	// The service account that the runtime workload runs as.
	// You can use any service account within the same project, but you
	// must have the service account user permission to use the instance.
	//
	// If not specified, the [Compute Engine default service
	// account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
	// is used.
	ServiceAccount string `protobuf:"bytes,13,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// Used to perform consistent read-modify-write updates. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,14,opt,name=etag,proto3" json:"etag,omitempty"`
	// The labels with user-defined metadata to organize the
	// NotebookRuntimeTemplates.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// The idle shutdown configuration of NotebookRuntimeTemplate. This config
	// will only be set when idle shutdown is enabled.
	IdleShutdownConfig *NotebookIdleShutdownConfig `protobuf:"bytes,17,opt,name=idle_shutdown_config,json=idleShutdownConfig,proto3" json:"idle_shutdown_config,omitempty"`
	// EUC configuration of the NotebookRuntimeTemplate.
	EucConfig *NotebookEucConfig `protobuf:"bytes,18,opt,name=euc_config,json=eucConfig,proto3" json:"euc_config,omitempty"`
	// Output only. Timestamp when this NotebookRuntimeTemplate was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this NotebookRuntimeTemplate was most recently
	// updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. Immutable. The type of the notebook runtime template.
	NotebookRuntimeType NotebookRuntimeType `` /* 174-byte string literal not displayed */
	// Optional. Immutable. Runtime Shielded VM spec.
	ShieldedVmConfig *ShieldedVmConfig `protobuf:"bytes,20,opt,name=shielded_vm_config,json=shieldedVmConfig,proto3" json:"shielded_vm_config,omitempty"`
	// Optional. The Compute Engine tags to add to runtime (see [Tagging
	// instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
	NetworkTags []string `protobuf:"bytes,21,rep,name=network_tags,json=networkTags,proto3" json:"network_tags,omitempty"`
	// contains filtered or unexported fields
}

A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template.

func (*NotebookRuntimeTemplate) Descriptor deprecated added in v1.67.0

func (*NotebookRuntimeTemplate) Descriptor() ([]byte, []int)

Deprecated: Use NotebookRuntimeTemplate.ProtoReflect.Descriptor instead.

func (*NotebookRuntimeTemplate) GetCreateTime added in v1.67.0

func (x *NotebookRuntimeTemplate) GetCreateTime() *timestamppb.Timestamp

func (*NotebookRuntimeTemplate) GetDataPersistentDiskSpec added in v1.67.0

func (x *NotebookRuntimeTemplate) GetDataPersistentDiskSpec() *PersistentDiskSpec

func (*NotebookRuntimeTemplate) GetDescription added in v1.67.0

func (x *NotebookRuntimeTemplate) GetDescription() string

func (*NotebookRuntimeTemplate) GetDisplayName added in v1.67.0

func (x *NotebookRuntimeTemplate) GetDisplayName() string

func (*NotebookRuntimeTemplate) GetEtag added in v1.67.0

func (x *NotebookRuntimeTemplate) GetEtag() string

func (*NotebookRuntimeTemplate) GetEucConfig added in v1.67.0

func (x *NotebookRuntimeTemplate) GetEucConfig() *NotebookEucConfig

func (*NotebookRuntimeTemplate) GetIdleShutdownConfig added in v1.67.0

func (x *NotebookRuntimeTemplate) GetIdleShutdownConfig() *NotebookIdleShutdownConfig

func (*NotebookRuntimeTemplate) GetIsDefault added in v1.67.0

func (x *NotebookRuntimeTemplate) GetIsDefault() bool

func (*NotebookRuntimeTemplate) GetLabels added in v1.67.0

func (x *NotebookRuntimeTemplate) GetLabels() map[string]string

func (*NotebookRuntimeTemplate) GetMachineSpec added in v1.67.0

func (x *NotebookRuntimeTemplate) GetMachineSpec() *MachineSpec

func (*NotebookRuntimeTemplate) GetName added in v1.67.0

func (x *NotebookRuntimeTemplate) GetName() string

func (*NotebookRuntimeTemplate) GetNetworkSpec added in v1.67.0

func (x *NotebookRuntimeTemplate) GetNetworkSpec() *NetworkSpec

func (*NotebookRuntimeTemplate) GetNetworkTags added in v1.67.0

func (x *NotebookRuntimeTemplate) GetNetworkTags() []string

func (*NotebookRuntimeTemplate) GetNotebookRuntimeType added in v1.67.0

func (x *NotebookRuntimeTemplate) GetNotebookRuntimeType() NotebookRuntimeType

func (*NotebookRuntimeTemplate) GetServiceAccount added in v1.67.0

func (x *NotebookRuntimeTemplate) GetServiceAccount() string

func (*NotebookRuntimeTemplate) GetShieldedVmConfig added in v1.67.0

func (x *NotebookRuntimeTemplate) GetShieldedVmConfig() *ShieldedVmConfig

func (*NotebookRuntimeTemplate) GetUpdateTime added in v1.67.0

func (x *NotebookRuntimeTemplate) GetUpdateTime() *timestamppb.Timestamp

func (*NotebookRuntimeTemplate) ProtoMessage added in v1.67.0

func (*NotebookRuntimeTemplate) ProtoMessage()

func (*NotebookRuntimeTemplate) ProtoReflect added in v1.67.0

func (x *NotebookRuntimeTemplate) ProtoReflect() protoreflect.Message

func (*NotebookRuntimeTemplate) Reset added in v1.67.0

func (x *NotebookRuntimeTemplate) Reset()

func (*NotebookRuntimeTemplate) String added in v1.67.0

func (x *NotebookRuntimeTemplate) String() string

type NotebookRuntimeTemplateRef added in v1.67.0

type NotebookRuntimeTemplateRef struct {

	// Immutable. A resource name of the NotebookRuntimeTemplate.
	NotebookRuntimeTemplate string `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

Points to a NotebookRuntimeTemplateRef.

func (*NotebookRuntimeTemplateRef) Descriptor deprecated added in v1.67.0

func (*NotebookRuntimeTemplateRef) Descriptor() ([]byte, []int)

Deprecated: Use NotebookRuntimeTemplateRef.ProtoReflect.Descriptor instead.

func (*NotebookRuntimeTemplateRef) GetNotebookRuntimeTemplate added in v1.67.0

func (x *NotebookRuntimeTemplateRef) GetNotebookRuntimeTemplate() string

func (*NotebookRuntimeTemplateRef) ProtoMessage added in v1.67.0

func (*NotebookRuntimeTemplateRef) ProtoMessage()

func (*NotebookRuntimeTemplateRef) ProtoReflect added in v1.67.0

func (*NotebookRuntimeTemplateRef) Reset added in v1.67.0

func (x *NotebookRuntimeTemplateRef) Reset()

func (*NotebookRuntimeTemplateRef) String added in v1.67.0

func (x *NotebookRuntimeTemplateRef) String() string

type NotebookRuntimeType added in v1.67.0

type NotebookRuntimeType int32

Represents a notebook runtime type.

const (
	// Unspecified notebook runtime type, NotebookRuntimeType will default to
	// USER_DEFINED.
	NotebookRuntimeType_NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED NotebookRuntimeType = 0
	// runtime or template with coustomized configurations from user.
	NotebookRuntimeType_USER_DEFINED NotebookRuntimeType = 1
	// runtime or template with system defined configurations.
	NotebookRuntimeType_ONE_CLICK NotebookRuntimeType = 2
)

func (NotebookRuntimeType) Descriptor added in v1.67.0

func (NotebookRuntimeType) Enum added in v1.67.0

func (NotebookRuntimeType) EnumDescriptor deprecated added in v1.67.0

func (NotebookRuntimeType) EnumDescriptor() ([]byte, []int)

Deprecated: Use NotebookRuntimeType.Descriptor instead.

func (NotebookRuntimeType) Number added in v1.67.0

func (NotebookRuntimeType) String added in v1.67.0

func (x NotebookRuntimeType) String() string

func (NotebookRuntimeType) Type added in v1.67.0

type NotebookRuntime_HealthState added in v1.67.0

type NotebookRuntime_HealthState int32

The substate of the NotebookRuntime to display health information.

const (
	// Unspecified health state.
	NotebookRuntime_HEALTH_STATE_UNSPECIFIED NotebookRuntime_HealthState = 0
	// NotebookRuntime is in healthy state. Applies to ACTIVE state.
	NotebookRuntime_HEALTHY NotebookRuntime_HealthState = 1
	// NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
	NotebookRuntime_UNHEALTHY NotebookRuntime_HealthState = 2
)

func (NotebookRuntime_HealthState) Descriptor added in v1.67.0

func (NotebookRuntime_HealthState) Enum added in v1.67.0

func (NotebookRuntime_HealthState) EnumDescriptor deprecated added in v1.67.0

func (NotebookRuntime_HealthState) EnumDescriptor() ([]byte, []int)

Deprecated: Use NotebookRuntime_HealthState.Descriptor instead.

func (NotebookRuntime_HealthState) Number added in v1.67.0

func (NotebookRuntime_HealthState) String added in v1.67.0

func (NotebookRuntime_HealthState) Type added in v1.67.0

type NotebookRuntime_RuntimeState added in v1.67.0

type NotebookRuntime_RuntimeState int32

The substate of the NotebookRuntime to display state of runtime. The resource of NotebookRuntime is in ACTIVE state for these sub state.

const (
	// Unspecified runtime state.
	NotebookRuntime_RUNTIME_STATE_UNSPECIFIED NotebookRuntime_RuntimeState = 0
	// NotebookRuntime is in running state.
	NotebookRuntime_RUNNING NotebookRuntime_RuntimeState = 1
	// NotebookRuntime is in starting state.
	NotebookRuntime_BEING_STARTED NotebookRuntime_RuntimeState = 2
	// NotebookRuntime is in stopping state.
	NotebookRuntime_BEING_STOPPED NotebookRuntime_RuntimeState = 3
	// NotebookRuntime is in stopped state.
	NotebookRuntime_STOPPED NotebookRuntime_RuntimeState = 4
	// NotebookRuntime is in upgrading state. It is in the middle of upgrading
	// process.
	NotebookRuntime_BEING_UPGRADED NotebookRuntime_RuntimeState = 5
	// NotebookRuntime was unable to start/stop properly.
	NotebookRuntime_ERROR NotebookRuntime_RuntimeState = 100
	// NotebookRuntime is in invalid state. Cannot be recovered.
	NotebookRuntime_INVALID NotebookRuntime_RuntimeState = 101
)

func (NotebookRuntime_RuntimeState) Descriptor added in v1.67.0

func (NotebookRuntime_RuntimeState) Enum added in v1.67.0

func (NotebookRuntime_RuntimeState) EnumDescriptor deprecated added in v1.67.0

func (NotebookRuntime_RuntimeState) EnumDescriptor() ([]byte, []int)

Deprecated: Use NotebookRuntime_RuntimeState.Descriptor instead.

func (NotebookRuntime_RuntimeState) Number added in v1.67.0

func (NotebookRuntime_RuntimeState) String added in v1.67.0

func (NotebookRuntime_RuntimeState) Type added in v1.67.0

type NotebookServiceClient added in v1.67.0

type NotebookServiceClient interface {
	// Creates a NotebookRuntimeTemplate.
	CreateNotebookRuntimeTemplate(ctx context.Context, in *CreateNotebookRuntimeTemplateRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a NotebookRuntimeTemplate.
	GetNotebookRuntimeTemplate(ctx context.Context, in *GetNotebookRuntimeTemplateRequest, opts ...grpc.CallOption) (*NotebookRuntimeTemplate, error)
	// Lists NotebookRuntimeTemplates in a Location.
	ListNotebookRuntimeTemplates(ctx context.Context, in *ListNotebookRuntimeTemplatesRequest, opts ...grpc.CallOption) (*ListNotebookRuntimeTemplatesResponse, error)
	// Deletes a NotebookRuntimeTemplate.
	DeleteNotebookRuntimeTemplate(ctx context.Context, in *DeleteNotebookRuntimeTemplateRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Assigns a NotebookRuntime to a user for a particular Notebook file. This
	// method will either returns an existing assignment or generates a new one.
	AssignNotebookRuntime(ctx context.Context, in *AssignNotebookRuntimeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a NotebookRuntime.
	GetNotebookRuntime(ctx context.Context, in *GetNotebookRuntimeRequest, opts ...grpc.CallOption) (*NotebookRuntime, error)
	// Lists NotebookRuntimes in a Location.
	ListNotebookRuntimes(ctx context.Context, in *ListNotebookRuntimesRequest, opts ...grpc.CallOption) (*ListNotebookRuntimesResponse, error)
	// Deletes a NotebookRuntime.
	DeleteNotebookRuntime(ctx context.Context, in *DeleteNotebookRuntimeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Upgrades a NotebookRuntime.
	UpgradeNotebookRuntime(ctx context.Context, in *UpgradeNotebookRuntimeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Starts a NotebookRuntime.
	StartNotebookRuntime(ctx context.Context, in *StartNotebookRuntimeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

NotebookServiceClient is the client API for NotebookService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewNotebookServiceClient added in v1.67.0

func NewNotebookServiceClient(cc grpc.ClientConnInterface) NotebookServiceClient

type NotebookServiceServer added in v1.67.0

type NotebookServiceServer interface {
	// Creates a NotebookRuntimeTemplate.
	CreateNotebookRuntimeTemplate(context.Context, *CreateNotebookRuntimeTemplateRequest) (*longrunningpb.Operation, error)
	// Gets a NotebookRuntimeTemplate.
	GetNotebookRuntimeTemplate(context.Context, *GetNotebookRuntimeTemplateRequest) (*NotebookRuntimeTemplate, error)
	// Lists NotebookRuntimeTemplates in a Location.
	ListNotebookRuntimeTemplates(context.Context, *ListNotebookRuntimeTemplatesRequest) (*ListNotebookRuntimeTemplatesResponse, error)
	// Deletes a NotebookRuntimeTemplate.
	DeleteNotebookRuntimeTemplate(context.Context, *DeleteNotebookRuntimeTemplateRequest) (*longrunningpb.Operation, error)
	// Assigns a NotebookRuntime to a user for a particular Notebook file. This
	// method will either returns an existing assignment or generates a new one.
	AssignNotebookRuntime(context.Context, *AssignNotebookRuntimeRequest) (*longrunningpb.Operation, error)
	// Gets a NotebookRuntime.
	GetNotebookRuntime(context.Context, *GetNotebookRuntimeRequest) (*NotebookRuntime, error)
	// Lists NotebookRuntimes in a Location.
	ListNotebookRuntimes(context.Context, *ListNotebookRuntimesRequest) (*ListNotebookRuntimesResponse, error)
	// Deletes a NotebookRuntime.
	DeleteNotebookRuntime(context.Context, *DeleteNotebookRuntimeRequest) (*longrunningpb.Operation, error)
	// Upgrades a NotebookRuntime.
	UpgradeNotebookRuntime(context.Context, *UpgradeNotebookRuntimeRequest) (*longrunningpb.Operation, error)
	// Starts a NotebookRuntime.
	StartNotebookRuntime(context.Context, *StartNotebookRuntimeRequest) (*longrunningpb.Operation, error)
}

NotebookServiceServer is the server API for NotebookService service.

type Part added in v1.57.0

type Part struct {

	// Types that are assignable to Data:
	//
	//	*Part_Text
	//	*Part_InlineData
	//	*Part_FileData
	//	*Part_FunctionCall
	//	*Part_FunctionResponse
	Data isPart_Data `protobuf_oneof:"data"`
	// Types that are assignable to Metadata:
	//
	//	*Part_VideoMetadata
	Metadata isPart_Metadata `protobuf_oneof:"metadata"`
	// contains filtered or unexported fields
}

A datatype containing media that is part of a multi-part `Content` message.

A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`.

A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.

func (*Part) Descriptor deprecated added in v1.57.0

func (*Part) Descriptor() ([]byte, []int)

Deprecated: Use Part.ProtoReflect.Descriptor instead.

func (*Part) GetData added in v1.57.0

func (m *Part) GetData() isPart_Data

func (*Part) GetFileData added in v1.57.0

func (x *Part) GetFileData() *FileData

func (*Part) GetFunctionCall added in v1.57.0

func (x *Part) GetFunctionCall() *FunctionCall

func (*Part) GetFunctionResponse added in v1.57.0

func (x *Part) GetFunctionResponse() *FunctionResponse

func (*Part) GetInlineData added in v1.57.0

func (x *Part) GetInlineData() *Blob

func (*Part) GetMetadata added in v1.57.0

func (m *Part) GetMetadata() isPart_Metadata

func (*Part) GetText added in v1.57.0

func (x *Part) GetText() string

func (*Part) GetVideoMetadata added in v1.57.0

func (x *Part) GetVideoMetadata() *VideoMetadata

func (*Part) ProtoMessage added in v1.57.0

func (*Part) ProtoMessage()

func (*Part) ProtoReflect added in v1.57.0

func (x *Part) ProtoReflect() protoreflect.Message

func (*Part) Reset added in v1.57.0

func (x *Part) Reset()

func (*Part) String added in v1.57.0

func (x *Part) String() string

type Part_FileData added in v1.57.0

type Part_FileData struct {
	// Optional. URI based data.
	FileData *FileData `protobuf:"bytes,3,opt,name=file_data,json=fileData,proto3,oneof"`
}

type Part_FunctionCall added in v1.57.0

type Part_FunctionCall struct {
	// Optional. A predicted [FunctionCall] returned from the model that
	// contains a string representing the [FunctionDeclaration.name] with the
	// parameters and their values.
	FunctionCall *FunctionCall `protobuf:"bytes,5,opt,name=function_call,json=functionCall,proto3,oneof"`
}

type Part_FunctionResponse added in v1.57.0

type Part_FunctionResponse struct {
	// Optional. The result output of a [FunctionCall] that contains a string
	// representing the [FunctionDeclaration.name] and a structured JSON object
	// containing any output from the function call. It is used as context to
	// the model.
	FunctionResponse *FunctionResponse `protobuf:"bytes,6,opt,name=function_response,json=functionResponse,proto3,oneof"`
}

type Part_InlineData added in v1.57.0

type Part_InlineData struct {
	// Optional. Inlined bytes data.
	InlineData *Blob `protobuf:"bytes,2,opt,name=inline_data,json=inlineData,proto3,oneof"`
}

type Part_Text added in v1.57.0

type Part_Text struct {
	// Optional. Text part (can be code).
	Text string `protobuf:"bytes,1,opt,name=text,proto3,oneof"`
}

type Part_VideoMetadata added in v1.57.0

type Part_VideoMetadata struct {
	// Optional. Video metadata. The metadata should only be specified while the
	// video data is presented in inline_data or file_data.
	VideoMetadata *VideoMetadata `protobuf:"bytes,4,opt,name=video_metadata,json=videoMetadata,proto3,oneof"`
}

type PauseModelDeploymentMonitoringJobRequest

type PauseModelDeploymentMonitoringJobRequest struct {

	// Required. The resource name of the ModelDeploymentMonitoringJob to pause.
	// Format:
	// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.PauseModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.PauseModelDeploymentMonitoringJob].

func (*PauseModelDeploymentMonitoringJobRequest) Descriptor deprecated

func (*PauseModelDeploymentMonitoringJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use PauseModelDeploymentMonitoringJobRequest.ProtoReflect.Descriptor instead.

func (*PauseModelDeploymentMonitoringJobRequest) GetName

func (*PauseModelDeploymentMonitoringJobRequest) ProtoMessage

func (*PauseModelDeploymentMonitoringJobRequest) ProtoReflect

func (*PauseModelDeploymentMonitoringJobRequest) Reset

func (*PauseModelDeploymentMonitoringJobRequest) String

type PauseScheduleRequest added in v1.47.0

type PauseScheduleRequest struct {

	// Required. The name of the Schedule resource to be paused.
	// Format:
	// `projects/{project}/locations/{location}/schedules/{schedule}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ScheduleService.PauseSchedule][google.cloud.aiplatform.v1.ScheduleService.PauseSchedule].

func (*PauseScheduleRequest) Descriptor deprecated added in v1.47.0

func (*PauseScheduleRequest) Descriptor() ([]byte, []int)

Deprecated: Use PauseScheduleRequest.ProtoReflect.Descriptor instead.

func (*PauseScheduleRequest) GetName added in v1.47.0

func (x *PauseScheduleRequest) GetName() string

func (*PauseScheduleRequest) ProtoMessage added in v1.47.0

func (*PauseScheduleRequest) ProtoMessage()

func (*PauseScheduleRequest) ProtoReflect added in v1.47.0

func (x *PauseScheduleRequest) ProtoReflect() protoreflect.Message

func (*PauseScheduleRequest) Reset added in v1.47.0

func (x *PauseScheduleRequest) Reset()

func (*PauseScheduleRequest) String added in v1.47.0

func (x *PauseScheduleRequest) String() string

type PersistentDiskSpec added in v1.51.0

type PersistentDiskSpec struct {

	// Type of the disk (default is "pd-standard").
	// Valid values: "pd-ssd" (Persistent Disk Solid State Drive)
	// "pd-standard" (Persistent Disk Hard Disk Drive)
	// "pd-balanced" (Balanced Persistent Disk)
	// "pd-extreme" (Extreme Persistent Disk)
	DiskType string `protobuf:"bytes,1,opt,name=disk_type,json=diskType,proto3" json:"disk_type,omitempty"`
	// Size in GB of the disk (default is 100GB).
	DiskSizeGb int64 `protobuf:"varint,2,opt,name=disk_size_gb,json=diskSizeGb,proto3" json:"disk_size_gb,omitempty"`
	// contains filtered or unexported fields
}

Represents the spec of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] options.

func (*PersistentDiskSpec) Descriptor deprecated added in v1.51.0

func (*PersistentDiskSpec) Descriptor() ([]byte, []int)

Deprecated: Use PersistentDiskSpec.ProtoReflect.Descriptor instead.

func (*PersistentDiskSpec) GetDiskSizeGb added in v1.51.0

func (x *PersistentDiskSpec) GetDiskSizeGb() int64

func (*PersistentDiskSpec) GetDiskType added in v1.51.0

func (x *PersistentDiskSpec) GetDiskType() string

func (*PersistentDiskSpec) ProtoMessage added in v1.51.0

func (*PersistentDiskSpec) ProtoMessage()

func (*PersistentDiskSpec) ProtoReflect added in v1.51.0

func (x *PersistentDiskSpec) ProtoReflect() protoreflect.Message

func (*PersistentDiskSpec) Reset added in v1.51.0

func (x *PersistentDiskSpec) Reset()

func (*PersistentDiskSpec) String added in v1.51.0

func (x *PersistentDiskSpec) String() string

type PersistentResource added in v1.67.0

type PersistentResource struct {

	// Immutable. Resource name of a PersistentResource.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The display name of the PersistentResource.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Required. The spec of the pools of different resources.
	ResourcePools []*ResourcePool `protobuf:"bytes,4,rep,name=resource_pools,json=resourcePools,proto3" json:"resource_pools,omitempty"`
	// Output only. The detailed state of a Study.
	State PersistentResource_State `protobuf:"varint,5,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.PersistentResource_State" json:"state,omitempty"`
	// Output only. Only populated when persistent resource's state is `STOPPING`
	// or `ERROR`.
	Error *status.Status `protobuf:"bytes,6,opt,name=error,proto3" json:"error,omitempty"`
	// Output only. Time when the PersistentResource was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Time when the PersistentResource for the first time entered
	// the `RUNNING` state.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. Time when the PersistentResource was most recently updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. The labels with user-defined metadata to organize
	// PersistentResource.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Optional. The full name of the Compute Engine
	// [network](/compute/docs/networks-and-firewalls#networks) to peered with
	// Vertex AI to host the persistent resources.
	// For example, `projects/12345/global/networks/myVPC`.
	// [Format](/compute/docs/reference/rest/v1/networks/insert)
	// is of the form `projects/{project}/global/networks/{network}`.
	// Where {project} is a project number, as in `12345`, and {network} is a
	// network name.
	//
	// To specify this field, you must have already [configured VPC Network
	// Peering for Vertex
	// AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).
	//
	// If this field is left unspecified, the resources aren't peered with any
	// network.
	Network string `protobuf:"bytes,11,opt,name=network,proto3" json:"network,omitempty"`
	// Optional. Customer-managed encryption key spec for a PersistentResource.
	// If set, this PersistentResource and all sub-resources of this
	// PersistentResource will be secured by this key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,12,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// Optional. Persistent Resource runtime spec.
	// For example, used for Ray cluster configuration.
	ResourceRuntimeSpec *ResourceRuntimeSpec `protobuf:"bytes,13,opt,name=resource_runtime_spec,json=resourceRuntimeSpec,proto3" json:"resource_runtime_spec,omitempty"`
	// Output only. Runtime information of the Persistent Resource.
	ResourceRuntime *ResourceRuntime `protobuf:"bytes,14,opt,name=resource_runtime,json=resourceRuntime,proto3" json:"resource_runtime,omitempty"`
	// Optional. A list of names for the reserved IP ranges under the VPC network
	// that can be used for this persistent resource.
	//
	// If set, we will deploy the persistent resource within the provided IP
	// ranges. Otherwise, the persistent resource is deployed to any IP
	// ranges under the provided VPC network.
	//
	// Example: ['vertex-ai-ip-range'].
	ReservedIpRanges []string `protobuf:"bytes,15,rep,name=reserved_ip_ranges,json=reservedIpRanges,proto3" json:"reserved_ip_ranges,omitempty"`
	// contains filtered or unexported fields
}

Represents long-lasting resources that are dedicated to users to runs custom workloads. A PersistentResource can have multiple node pools and each node pool can have its own machine spec.

func (*PersistentResource) Descriptor deprecated added in v1.67.0

func (*PersistentResource) Descriptor() ([]byte, []int)

Deprecated: Use PersistentResource.ProtoReflect.Descriptor instead.

func (*PersistentResource) GetCreateTime added in v1.67.0

func (x *PersistentResource) GetCreateTime() *timestamppb.Timestamp

func (*PersistentResource) GetDisplayName added in v1.67.0

func (x *PersistentResource) GetDisplayName() string

func (*PersistentResource) GetEncryptionSpec added in v1.67.0

func (x *PersistentResource) GetEncryptionSpec() *EncryptionSpec

func (*PersistentResource) GetError added in v1.67.0

func (x *PersistentResource) GetError() *status.Status

func (*PersistentResource) GetLabels added in v1.67.0

func (x *PersistentResource) GetLabels() map[string]string

func (*PersistentResource) GetName added in v1.67.0

func (x *PersistentResource) GetName() string

func (*PersistentResource) GetNetwork added in v1.67.0

func (x *PersistentResource) GetNetwork() string

func (*PersistentResource) GetReservedIpRanges added in v1.67.0

func (x *PersistentResource) GetReservedIpRanges() []string

func (*PersistentResource) GetResourcePools added in v1.67.0

func (x *PersistentResource) GetResourcePools() []*ResourcePool

func (*PersistentResource) GetResourceRuntime added in v1.67.0

func (x *PersistentResource) GetResourceRuntime() *ResourceRuntime

func (*PersistentResource) GetResourceRuntimeSpec added in v1.67.0

func (x *PersistentResource) GetResourceRuntimeSpec() *ResourceRuntimeSpec

func (*PersistentResource) GetStartTime added in v1.67.0

func (x *PersistentResource) GetStartTime() *timestamppb.Timestamp

func (*PersistentResource) GetState added in v1.67.0

func (*PersistentResource) GetUpdateTime added in v1.67.0

func (x *PersistentResource) GetUpdateTime() *timestamppb.Timestamp

func (*PersistentResource) ProtoMessage added in v1.67.0

func (*PersistentResource) ProtoMessage()

func (*PersistentResource) ProtoReflect added in v1.67.0

func (x *PersistentResource) ProtoReflect() protoreflect.Message

func (*PersistentResource) Reset added in v1.67.0

func (x *PersistentResource) Reset()

func (*PersistentResource) String added in v1.67.0

func (x *PersistentResource) String() string

type PersistentResourceServiceClient added in v1.67.0

type PersistentResourceServiceClient interface {
	// Creates a PersistentResource.
	CreatePersistentResource(ctx context.Context, in *CreatePersistentResourceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a PersistentResource.
	GetPersistentResource(ctx context.Context, in *GetPersistentResourceRequest, opts ...grpc.CallOption) (*PersistentResource, error)
	// Lists PersistentResources in a Location.
	ListPersistentResources(ctx context.Context, in *ListPersistentResourcesRequest, opts ...grpc.CallOption) (*ListPersistentResourcesResponse, error)
	// Deletes a PersistentResource.
	DeletePersistentResource(ctx context.Context, in *DeletePersistentResourceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates a PersistentResource.
	UpdatePersistentResource(ctx context.Context, in *UpdatePersistentResourceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Reboots a PersistentResource.
	RebootPersistentResource(ctx context.Context, in *RebootPersistentResourceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

PersistentResourceServiceClient is the client API for PersistentResourceService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewPersistentResourceServiceClient added in v1.67.0

func NewPersistentResourceServiceClient(cc grpc.ClientConnInterface) PersistentResourceServiceClient

type PersistentResourceServiceServer added in v1.67.0

type PersistentResourceServiceServer interface {
	// Creates a PersistentResource.
	CreatePersistentResource(context.Context, *CreatePersistentResourceRequest) (*longrunningpb.Operation, error)
	// Gets a PersistentResource.
	GetPersistentResource(context.Context, *GetPersistentResourceRequest) (*PersistentResource, error)
	// Lists PersistentResources in a Location.
	ListPersistentResources(context.Context, *ListPersistentResourcesRequest) (*ListPersistentResourcesResponse, error)
	// Deletes a PersistentResource.
	DeletePersistentResource(context.Context, *DeletePersistentResourceRequest) (*longrunningpb.Operation, error)
	// Updates a PersistentResource.
	UpdatePersistentResource(context.Context, *UpdatePersistentResourceRequest) (*longrunningpb.Operation, error)
	// Reboots a PersistentResource.
	RebootPersistentResource(context.Context, *RebootPersistentResourceRequest) (*longrunningpb.Operation, error)
}

PersistentResourceServiceServer is the server API for PersistentResourceService service.

type PersistentResource_State added in v1.67.0

type PersistentResource_State int32

Describes the PersistentResource state.

const (
	// Not set.
	PersistentResource_STATE_UNSPECIFIED PersistentResource_State = 0
	// The PROVISIONING state indicates the persistent resources is being
	// created.
	PersistentResource_PROVISIONING PersistentResource_State = 1
	// The RUNNING state indicates the persistent resource is healthy and fully
	// usable.
	PersistentResource_RUNNING PersistentResource_State = 3
	// The STOPPING state indicates the persistent resource is being deleted.
	PersistentResource_STOPPING PersistentResource_State = 4
	// The ERROR state indicates the persistent resource may be unusable.
	// Details can be found in the `error` field.
	PersistentResource_ERROR PersistentResource_State = 5
	// The REBOOTING state indicates the persistent resource is being rebooted
	// (PR is not available right now but is expected to be ready again later).
	PersistentResource_REBOOTING PersistentResource_State = 6
	// The UPDATING state indicates the persistent resource is being updated.
	PersistentResource_UPDATING PersistentResource_State = 7
)

func (PersistentResource_State) Descriptor added in v1.67.0

func (PersistentResource_State) Enum added in v1.67.0

func (PersistentResource_State) EnumDescriptor deprecated added in v1.67.0

func (PersistentResource_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use PersistentResource_State.Descriptor instead.

func (PersistentResource_State) Number added in v1.67.0

func (PersistentResource_State) String added in v1.67.0

func (x PersistentResource_State) String() string

func (PersistentResource_State) Type added in v1.67.0

type PipelineFailurePolicy

type PipelineFailurePolicy int32

Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.

const (
	// Default value, and follows fail slow behavior.
	PipelineFailurePolicy_PIPELINE_FAILURE_POLICY_UNSPECIFIED PipelineFailurePolicy = 0
	// Indicates that the pipeline should continue to run until all possible
	// tasks have been scheduled and completed.
	PipelineFailurePolicy_PIPELINE_FAILURE_POLICY_FAIL_SLOW PipelineFailurePolicy = 1
	// Indicates that the pipeline should stop scheduling new tasks after a task
	// has failed.
	PipelineFailurePolicy_PIPELINE_FAILURE_POLICY_FAIL_FAST PipelineFailurePolicy = 2
)

func (PipelineFailurePolicy) Descriptor

func (PipelineFailurePolicy) Enum

func (PipelineFailurePolicy) EnumDescriptor deprecated

func (PipelineFailurePolicy) EnumDescriptor() ([]byte, []int)

Deprecated: Use PipelineFailurePolicy.Descriptor instead.

func (PipelineFailurePolicy) Number

func (PipelineFailurePolicy) String

func (x PipelineFailurePolicy) String() string

func (PipelineFailurePolicy) Type

type PipelineJob

type PipelineJob struct {

	// Output only. The resource name of the PipelineJob.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The display name of the Pipeline.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. Pipeline creation time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Pipeline start time.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. Pipeline end time.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Timestamp when this PipelineJob was most recently updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The spec of the pipeline.
	PipelineSpec *structpb.Struct `protobuf:"bytes,7,opt,name=pipeline_spec,json=pipelineSpec,proto3" json:"pipeline_spec,omitempty"`
	// Output only. The detailed state of the job.
	State PipelineState `protobuf:"varint,8,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.PipelineState" json:"state,omitempty"`
	// Output only. The details of pipeline run. Not available in the list view.
	JobDetail *PipelineJobDetail `protobuf:"bytes,9,opt,name=job_detail,json=jobDetail,proto3" json:"job_detail,omitempty"`
	// Output only. The error that occurred during pipeline execution.
	// Only populated when the pipeline's state is FAILED or CANCELLED.
	Error *status.Status `protobuf:"bytes,10,opt,name=error,proto3" json:"error,omitempty"`
	// The labels with user-defined metadata to organize PipelineJob.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	//
	// Note there is some reserved label key for Vertex AI Pipelines.
	// - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Runtime config of the pipeline.
	RuntimeConfig *PipelineJob_RuntimeConfig `protobuf:"bytes,12,opt,name=runtime_config,json=runtimeConfig,proto3" json:"runtime_config,omitempty"`
	// Customer-managed encryption key spec for a pipelineJob. If set, this
	// PipelineJob and all of its sub-resources will be secured by this key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,16,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// The service account that the pipeline workload runs as.
	// If not specified, the Compute Engine default service account in the project
	// will be used.
	// See
	// https://cloud.google.com/compute/docs/access/service-accounts#default_service_account
	//
	// Users starting the pipeline must have the `iam.serviceAccounts.actAs`
	// permission on this service account.
	ServiceAccount string `protobuf:"bytes,17,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// The full name of the Compute Engine
	// [network](/compute/docs/networks-and-firewalls#networks) to which the
	// Pipeline Job's workload should be peered. For example,
	// `projects/12345/global/networks/myVPC`.
	// [Format](/compute/docs/reference/rest/v1/networks/insert)
	// is of the form `projects/{project}/global/networks/{network}`.
	// Where {project} is a project number, as in `12345`, and {network} is a
	// network name.
	//
	// Private services access must already be configured for the network.
	// Pipeline job will apply the network configuration to the Google Cloud
	// resources being launched, if applied, such as Vertex AI
	// Training or Dataflow job. If left unspecified, the workload is not peered
	// with any network.
	Network string `protobuf:"bytes,18,opt,name=network,proto3" json:"network,omitempty"`
	// A list of names for the reserved ip ranges under the VPC network
	// that can be used for this Pipeline Job's workload.
	//
	// If set, we will deploy the Pipeline Job's workload within the provided ip
	// ranges. Otherwise, the job will be deployed to any ip ranges under the
	// provided VPC network.
	//
	// Example: ['vertex-ai-ip-range'].
	ReservedIpRanges []string `protobuf:"bytes,25,rep,name=reserved_ip_ranges,json=reservedIpRanges,proto3" json:"reserved_ip_ranges,omitempty"`
	// A template uri from where the
	// [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec],
	// if empty, will be downloaded. Currently, only uri from Vertex Template
	// Registry & Gallery is supported. Reference to
	// https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
	TemplateUri string `protobuf:"bytes,19,opt,name=template_uri,json=templateUri,proto3" json:"template_uri,omitempty"`
	// Output only. Pipeline template metadata. Will fill up fields if
	// [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri]
	// is from supported template registry.
	TemplateMetadata *PipelineTemplateMetadata `protobuf:"bytes,20,opt,name=template_metadata,json=templateMetadata,proto3" json:"template_metadata,omitempty"`
	// Output only. The schedule resource name.
	// Only returned if the Pipeline is created by Schedule API.
	ScheduleName string `protobuf:"bytes,22,opt,name=schedule_name,json=scheduleName,proto3" json:"schedule_name,omitempty"`
	// contains filtered or unexported fields
}

An instance of a machine learning PipelineJob.

func (*PipelineJob) Descriptor deprecated

func (*PipelineJob) Descriptor() ([]byte, []int)

Deprecated: Use PipelineJob.ProtoReflect.Descriptor instead.

func (*PipelineJob) GetCreateTime

func (x *PipelineJob) GetCreateTime() *timestamppb.Timestamp

func (*PipelineJob) GetDisplayName

func (x *PipelineJob) GetDisplayName() string

func (*PipelineJob) GetEncryptionSpec

func (x *PipelineJob) GetEncryptionSpec() *EncryptionSpec

func (*PipelineJob) GetEndTime

func (x *PipelineJob) GetEndTime() *timestamppb.Timestamp

func (*PipelineJob) GetError

func (x *PipelineJob) GetError() *status.Status

func (*PipelineJob) GetJobDetail

func (x *PipelineJob) GetJobDetail() *PipelineJobDetail

func (*PipelineJob) GetLabels

func (x *PipelineJob) GetLabels() map[string]string

func (*PipelineJob) GetName

func (x *PipelineJob) GetName() string

func (*PipelineJob) GetNetwork

func (x *PipelineJob) GetNetwork() string

func (*PipelineJob) GetPipelineSpec

func (x *PipelineJob) GetPipelineSpec() *structpb.Struct

func (*PipelineJob) GetReservedIpRanges added in v1.46.0

func (x *PipelineJob) GetReservedIpRanges() []string

func (*PipelineJob) GetRuntimeConfig

func (x *PipelineJob) GetRuntimeConfig() *PipelineJob_RuntimeConfig

func (*PipelineJob) GetScheduleName added in v1.49.0

func (x *PipelineJob) GetScheduleName() string

func (*PipelineJob) GetServiceAccount

func (x *PipelineJob) GetServiceAccount() string

func (*PipelineJob) GetStartTime

func (x *PipelineJob) GetStartTime() *timestamppb.Timestamp

func (*PipelineJob) GetState

func (x *PipelineJob) GetState() PipelineState

func (*PipelineJob) GetTemplateMetadata

func (x *PipelineJob) GetTemplateMetadata() *PipelineTemplateMetadata

func (*PipelineJob) GetTemplateUri

func (x *PipelineJob) GetTemplateUri() string

func (*PipelineJob) GetUpdateTime

func (x *PipelineJob) GetUpdateTime() *timestamppb.Timestamp

func (*PipelineJob) ProtoMessage

func (*PipelineJob) ProtoMessage()

func (*PipelineJob) ProtoReflect

func (x *PipelineJob) ProtoReflect() protoreflect.Message

func (*PipelineJob) Reset

func (x *PipelineJob) Reset()

func (*PipelineJob) String

func (x *PipelineJob) String() string

type PipelineJobDetail

type PipelineJobDetail struct {

	// Output only. The context of the pipeline.
	PipelineContext *Context `protobuf:"bytes,1,opt,name=pipeline_context,json=pipelineContext,proto3" json:"pipeline_context,omitempty"`
	// Output only. The context of the current pipeline run.
	PipelineRunContext *Context `protobuf:"bytes,2,opt,name=pipeline_run_context,json=pipelineRunContext,proto3" json:"pipeline_run_context,omitempty"`
	// Output only. The runtime details of the tasks under the pipeline.
	TaskDetails []*PipelineTaskDetail `protobuf:"bytes,3,rep,name=task_details,json=taskDetails,proto3" json:"task_details,omitempty"`
	// contains filtered or unexported fields
}

The runtime detail of PipelineJob.

func (*PipelineJobDetail) Descriptor deprecated

func (*PipelineJobDetail) Descriptor() ([]byte, []int)

Deprecated: Use PipelineJobDetail.ProtoReflect.Descriptor instead.

func (*PipelineJobDetail) GetPipelineContext

func (x *PipelineJobDetail) GetPipelineContext() *Context

func (*PipelineJobDetail) GetPipelineRunContext

func (x *PipelineJobDetail) GetPipelineRunContext() *Context

func (*PipelineJobDetail) GetTaskDetails

func (x *PipelineJobDetail) GetTaskDetails() []*PipelineTaskDetail

func (*PipelineJobDetail) ProtoMessage

func (*PipelineJobDetail) ProtoMessage()

func (*PipelineJobDetail) ProtoReflect

func (x *PipelineJobDetail) ProtoReflect() protoreflect.Message

func (*PipelineJobDetail) Reset

func (x *PipelineJobDetail) Reset()

func (*PipelineJobDetail) String

func (x *PipelineJobDetail) String() string

type PipelineJob_RuntimeConfig

type PipelineJob_RuntimeConfig struct {

	// Deprecated. Use
	// [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.parameter_values]
	// instead. The runtime parameters of the PipelineJob. The parameters will
	// be passed into
	// [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
	// to replace the placeholders at runtime. This field is used by pipelines
	// built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
	// such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
	//
	// Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/pipeline_job.proto.
	Parameters map[string]*Value `` /* 161-byte string literal not displayed */
	// Required. A path in a Cloud Storage bucket, which will be treated as the
	// root output directory of the pipeline. It is used by the system to
	// generate the paths of output artifacts. The artifact paths are generated
	// with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
	// specified output directory. The service account specified in this
	// pipeline must have the `storage.objects.get` and `storage.objects.create`
	// permissions for this bucket.
	GcsOutputDirectory string `protobuf:"bytes,2,opt,name=gcs_output_directory,json=gcsOutputDirectory,proto3" json:"gcs_output_directory,omitempty"`
	// The runtime parameters of the PipelineJob. The parameters will be
	// passed into
	// [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
	// to replace the placeholders at runtime. This field is used by pipelines
	// built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
	// pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
	// DSL.
	ParameterValues map[string]*structpb.Value `` /* 194-byte string literal not displayed */
	// Represents the failure policy of a pipeline. Currently, the default of a
	// pipeline is that the pipeline will continue to run until no more tasks
	// can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
	// However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
	// will stop scheduling any new tasks when a task has failed. Any scheduled
	// tasks will continue to completion.
	FailurePolicy PipelineFailurePolicy `` /* 155-byte string literal not displayed */
	// The runtime artifacts of the PipelineJob. The key will be the input
	// artifact name and the value would be one of the InputArtifact.
	InputArtifacts map[string]*PipelineJob_RuntimeConfig_InputArtifact `` /* 191-byte string literal not displayed */
	// contains filtered or unexported fields
}

The runtime config of a PipelineJob.

func (*PipelineJob_RuntimeConfig) Descriptor deprecated

func (*PipelineJob_RuntimeConfig) Descriptor() ([]byte, []int)

Deprecated: Use PipelineJob_RuntimeConfig.ProtoReflect.Descriptor instead.

func (*PipelineJob_RuntimeConfig) GetFailurePolicy

func (x *PipelineJob_RuntimeConfig) GetFailurePolicy() PipelineFailurePolicy

func (*PipelineJob_RuntimeConfig) GetGcsOutputDirectory

func (x *PipelineJob_RuntimeConfig) GetGcsOutputDirectory() string

func (*PipelineJob_RuntimeConfig) GetInputArtifacts

func (*PipelineJob_RuntimeConfig) GetParameterValues

func (x *PipelineJob_RuntimeConfig) GetParameterValues() map[string]*structpb.Value

func (*PipelineJob_RuntimeConfig) GetParameters deprecated

func (x *PipelineJob_RuntimeConfig) GetParameters() map[string]*Value

Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/pipeline_job.proto.

func (*PipelineJob_RuntimeConfig) ProtoMessage

func (*PipelineJob_RuntimeConfig) ProtoMessage()

func (*PipelineJob_RuntimeConfig) ProtoReflect

func (*PipelineJob_RuntimeConfig) Reset

func (x *PipelineJob_RuntimeConfig) Reset()

func (*PipelineJob_RuntimeConfig) String

func (x *PipelineJob_RuntimeConfig) String() string

type PipelineJob_RuntimeConfig_InputArtifact

type PipelineJob_RuntimeConfig_InputArtifact struct {

	// Types that are assignable to Kind:
	//
	//	*PipelineJob_RuntimeConfig_InputArtifact_ArtifactId
	Kind isPipelineJob_RuntimeConfig_InputArtifact_Kind `protobuf_oneof:"kind"`
	// contains filtered or unexported fields
}

The type of an input artifact.

func (*PipelineJob_RuntimeConfig_InputArtifact) Descriptor deprecated

func (*PipelineJob_RuntimeConfig_InputArtifact) Descriptor() ([]byte, []int)

Deprecated: Use PipelineJob_RuntimeConfig_InputArtifact.ProtoReflect.Descriptor instead.

func (*PipelineJob_RuntimeConfig_InputArtifact) GetArtifactId

func (*PipelineJob_RuntimeConfig_InputArtifact) GetKind

func (m *PipelineJob_RuntimeConfig_InputArtifact) GetKind() isPipelineJob_RuntimeConfig_InputArtifact_Kind

func (*PipelineJob_RuntimeConfig_InputArtifact) ProtoMessage

func (*PipelineJob_RuntimeConfig_InputArtifact) ProtoReflect

func (*PipelineJob_RuntimeConfig_InputArtifact) Reset

func (*PipelineJob_RuntimeConfig_InputArtifact) String

type PipelineJob_RuntimeConfig_InputArtifact_ArtifactId

type PipelineJob_RuntimeConfig_InputArtifact_ArtifactId struct {
	// Artifact resource id from MLMD. Which is the last portion of an
	// artifact resource name:
	// `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
	// The artifact must stay within the same project, location and default
	// metadatastore as the pipeline.
	ArtifactId string `protobuf:"bytes,1,opt,name=artifact_id,json=artifactId,proto3,oneof"`
}

type PipelineServiceClient

type PipelineServiceClient interface {
	// Creates a TrainingPipeline. A created TrainingPipeline right away will be
	// attempted to be run.
	CreateTrainingPipeline(ctx context.Context, in *CreateTrainingPipelineRequest, opts ...grpc.CallOption) (*TrainingPipeline, error)
	// Gets a TrainingPipeline.
	GetTrainingPipeline(ctx context.Context, in *GetTrainingPipelineRequest, opts ...grpc.CallOption) (*TrainingPipeline, error)
	// Lists TrainingPipelines in a Location.
	ListTrainingPipelines(ctx context.Context, in *ListTrainingPipelinesRequest, opts ...grpc.CallOption) (*ListTrainingPipelinesResponse, error)
	// Deletes a TrainingPipeline.
	DeleteTrainingPipeline(ctx context.Context, in *DeleteTrainingPipelineRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Cancels a TrainingPipeline.
	// Starts asynchronous cancellation on the TrainingPipeline. The server
	// makes a best effort to cancel the pipeline, but success is not
	// guaranteed. Clients can use
	// [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
	// or other methods to check whether the cancellation succeeded or whether the
	// pipeline completed despite cancellation. On successful cancellation,
	// the TrainingPipeline is not deleted; instead it becomes a pipeline with
	// a
	// [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error]
	// value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
	// corresponding to `Code.CANCELLED`, and
	// [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state]
	// is set to `CANCELLED`.
	CancelTrainingPipeline(ctx context.Context, in *CancelTrainingPipelineRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Creates a PipelineJob. A PipelineJob will run immediately when created.
	CreatePipelineJob(ctx context.Context, in *CreatePipelineJobRequest, opts ...grpc.CallOption) (*PipelineJob, error)
	// Gets a PipelineJob.
	GetPipelineJob(ctx context.Context, in *GetPipelineJobRequest, opts ...grpc.CallOption) (*PipelineJob, error)
	// Lists PipelineJobs in a Location.
	ListPipelineJobs(ctx context.Context, in *ListPipelineJobsRequest, opts ...grpc.CallOption) (*ListPipelineJobsResponse, error)
	// Deletes a PipelineJob.
	DeletePipelineJob(ctx context.Context, in *DeletePipelineJobRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Batch deletes PipelineJobs
	// The Operation is atomic. If it fails, none of the PipelineJobs are deleted.
	// If it succeeds, all of the PipelineJobs are deleted.
	BatchDeletePipelineJobs(ctx context.Context, in *BatchDeletePipelineJobsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Cancels a PipelineJob.
	// Starts asynchronous cancellation on the PipelineJob. The server
	// makes a best effort to cancel the pipeline, but success is not
	// guaranteed. Clients can use
	// [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob]
	// or other methods to check whether the cancellation succeeded or whether the
	// pipeline completed despite cancellation. On successful cancellation,
	// the PipelineJob is not deleted; instead it becomes a pipeline with
	// a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value
	// with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding
	// to `Code.CANCELLED`, and
	// [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to
	// `CANCELLED`.
	CancelPipelineJob(ctx context.Context, in *CancelPipelineJobRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Batch cancel PipelineJobs.
	// Firstly the server will check if all the jobs are in non-terminal states,
	// and skip the jobs that are already terminated.
	// If the operation failed, none of the pipeline jobs are cancelled.
	// The server will poll the states of all the pipeline jobs periodically
	// to check the cancellation status.
	// This operation will return an LRO.
	BatchCancelPipelineJobs(ctx context.Context, in *BatchCancelPipelineJobsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

PipelineServiceClient is the client API for PipelineService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type PipelineServiceServer

type PipelineServiceServer interface {
	// Creates a TrainingPipeline. A created TrainingPipeline right away will be
	// attempted to be run.
	CreateTrainingPipeline(context.Context, *CreateTrainingPipelineRequest) (*TrainingPipeline, error)
	// Gets a TrainingPipeline.
	GetTrainingPipeline(context.Context, *GetTrainingPipelineRequest) (*TrainingPipeline, error)
	// Lists TrainingPipelines in a Location.
	ListTrainingPipelines(context.Context, *ListTrainingPipelinesRequest) (*ListTrainingPipelinesResponse, error)
	// Deletes a TrainingPipeline.
	DeleteTrainingPipeline(context.Context, *DeleteTrainingPipelineRequest) (*longrunningpb.Operation, error)
	// Cancels a TrainingPipeline.
	// Starts asynchronous cancellation on the TrainingPipeline. The server
	// makes a best effort to cancel the pipeline, but success is not
	// guaranteed. Clients can use
	// [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
	// or other methods to check whether the cancellation succeeded or whether the
	// pipeline completed despite cancellation. On successful cancellation,
	// the TrainingPipeline is not deleted; instead it becomes a pipeline with
	// a
	// [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error]
	// value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
	// corresponding to `Code.CANCELLED`, and
	// [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state]
	// is set to `CANCELLED`.
	CancelTrainingPipeline(context.Context, *CancelTrainingPipelineRequest) (*emptypb.Empty, error)
	// Creates a PipelineJob. A PipelineJob will run immediately when created.
	CreatePipelineJob(context.Context, *CreatePipelineJobRequest) (*PipelineJob, error)
	// Gets a PipelineJob.
	GetPipelineJob(context.Context, *GetPipelineJobRequest) (*PipelineJob, error)
	// Lists PipelineJobs in a Location.
	ListPipelineJobs(context.Context, *ListPipelineJobsRequest) (*ListPipelineJobsResponse, error)
	// Deletes a PipelineJob.
	DeletePipelineJob(context.Context, *DeletePipelineJobRequest) (*longrunningpb.Operation, error)
	// Batch deletes PipelineJobs
	// The Operation is atomic. If it fails, none of the PipelineJobs are deleted.
	// If it succeeds, all of the PipelineJobs are deleted.
	BatchDeletePipelineJobs(context.Context, *BatchDeletePipelineJobsRequest) (*longrunningpb.Operation, error)
	// Cancels a PipelineJob.
	// Starts asynchronous cancellation on the PipelineJob. The server
	// makes a best effort to cancel the pipeline, but success is not
	// guaranteed. Clients can use
	// [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob]
	// or other methods to check whether the cancellation succeeded or whether the
	// pipeline completed despite cancellation. On successful cancellation,
	// the PipelineJob is not deleted; instead it becomes a pipeline with
	// a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value
	// with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding
	// to `Code.CANCELLED`, and
	// [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to
	// `CANCELLED`.
	CancelPipelineJob(context.Context, *CancelPipelineJobRequest) (*emptypb.Empty, error)
	// Batch cancel PipelineJobs.
	// Firstly the server will check if all the jobs are in non-terminal states,
	// and skip the jobs that are already terminated.
	// If the operation failed, none of the pipeline jobs are cancelled.
	// The server will poll the states of all the pipeline jobs periodically
	// to check the cancellation status.
	// This operation will return an LRO.
	BatchCancelPipelineJobs(context.Context, *BatchCancelPipelineJobsRequest) (*longrunningpb.Operation, error)
}

PipelineServiceServer is the server API for PipelineService service.

type PipelineState

type PipelineState int32

Describes the state of a pipeline.

const (
	// The pipeline state is unspecified.
	PipelineState_PIPELINE_STATE_UNSPECIFIED PipelineState = 0
	// The pipeline has been created or resumed, and processing has not yet
	// begun.
	PipelineState_PIPELINE_STATE_QUEUED PipelineState = 1
	// The service is preparing to run the pipeline.
	PipelineState_PIPELINE_STATE_PENDING PipelineState = 2
	// The pipeline is in progress.
	PipelineState_PIPELINE_STATE_RUNNING PipelineState = 3
	// The pipeline completed successfully.
	PipelineState_PIPELINE_STATE_SUCCEEDED PipelineState = 4
	// The pipeline failed.
	PipelineState_PIPELINE_STATE_FAILED PipelineState = 5
	// The pipeline is being cancelled. From this state, the pipeline may only go
	// to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED or
	// PIPELINE_STATE_CANCELLED.
	PipelineState_PIPELINE_STATE_CANCELLING PipelineState = 6
	// The pipeline has been cancelled.
	PipelineState_PIPELINE_STATE_CANCELLED PipelineState = 7
	// The pipeline has been stopped, and can be resumed.
	PipelineState_PIPELINE_STATE_PAUSED PipelineState = 8
)

func (PipelineState) Descriptor

func (PipelineState) Enum

func (x PipelineState) Enum() *PipelineState

func (PipelineState) EnumDescriptor deprecated

func (PipelineState) EnumDescriptor() ([]byte, []int)

Deprecated: Use PipelineState.Descriptor instead.

func (PipelineState) Number

func (PipelineState) String

func (x PipelineState) String() string

func (PipelineState) Type

type PipelineTaskDetail

type PipelineTaskDetail struct {

	// Output only. The system generated ID of the task.
	TaskId int64 `protobuf:"varint,1,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`
	// Output only. The id of the parent task if the task is within a component
	// scope. Empty if the task is at the root level.
	ParentTaskId int64 `protobuf:"varint,12,opt,name=parent_task_id,json=parentTaskId,proto3" json:"parent_task_id,omitempty"`
	// Output only. The user specified name of the task that is defined in
	// [pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec].
	TaskName string `protobuf:"bytes,2,opt,name=task_name,json=taskName,proto3" json:"task_name,omitempty"`
	// Output only. Task create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Task start time.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. Task end time.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. The detailed execution info.
	ExecutorDetail *PipelineTaskExecutorDetail `protobuf:"bytes,6,opt,name=executor_detail,json=executorDetail,proto3" json:"executor_detail,omitempty"`
	// Output only. State of the task.
	State PipelineTaskDetail_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.PipelineTaskDetail_State" json:"state,omitempty"`
	// Output only. The execution metadata of the task.
	Execution *Execution `protobuf:"bytes,8,opt,name=execution,proto3" json:"execution,omitempty"`
	// Output only. The error that occurred during task execution.
	// Only populated when the task's state is FAILED or CANCELLED.
	Error *status.Status `protobuf:"bytes,9,opt,name=error,proto3" json:"error,omitempty"`
	// Output only. A list of task status. This field keeps a record of task
	// status evolving over time.
	PipelineTaskStatus []*PipelineTaskDetail_PipelineTaskStatus `protobuf:"bytes,13,rep,name=pipeline_task_status,json=pipelineTaskStatus,proto3" json:"pipeline_task_status,omitempty"`
	// Output only. The runtime input artifacts of the task.
	Inputs map[string]*PipelineTaskDetail_ArtifactList `` /* 154-byte string literal not displayed */
	// Output only. The runtime output artifacts of the task.
	Outputs map[string]*PipelineTaskDetail_ArtifactList `` /* 156-byte string literal not displayed */
	// contains filtered or unexported fields
}

The runtime detail of a task execution.

func (*PipelineTaskDetail) Descriptor deprecated

func (*PipelineTaskDetail) Descriptor() ([]byte, []int)

Deprecated: Use PipelineTaskDetail.ProtoReflect.Descriptor instead.

func (*PipelineTaskDetail) GetCreateTime

func (x *PipelineTaskDetail) GetCreateTime() *timestamppb.Timestamp

func (*PipelineTaskDetail) GetEndTime

func (x *PipelineTaskDetail) GetEndTime() *timestamppb.Timestamp

func (*PipelineTaskDetail) GetError

func (x *PipelineTaskDetail) GetError() *status.Status

func (*PipelineTaskDetail) GetExecution

func (x *PipelineTaskDetail) GetExecution() *Execution

func (*PipelineTaskDetail) GetExecutorDetail

func (x *PipelineTaskDetail) GetExecutorDetail() *PipelineTaskExecutorDetail

func (*PipelineTaskDetail) GetInputs

func (*PipelineTaskDetail) GetOutputs

func (*PipelineTaskDetail) GetParentTaskId

func (x *PipelineTaskDetail) GetParentTaskId() int64

func (*PipelineTaskDetail) GetPipelineTaskStatus

func (x *PipelineTaskDetail) GetPipelineTaskStatus() []*PipelineTaskDetail_PipelineTaskStatus

func (*PipelineTaskDetail) GetStartTime

func (x *PipelineTaskDetail) GetStartTime() *timestamppb.Timestamp

func (*PipelineTaskDetail) GetState

func (*PipelineTaskDetail) GetTaskId

func (x *PipelineTaskDetail) GetTaskId() int64

func (*PipelineTaskDetail) GetTaskName

func (x *PipelineTaskDetail) GetTaskName() string

func (*PipelineTaskDetail) ProtoMessage

func (*PipelineTaskDetail) ProtoMessage()

func (*PipelineTaskDetail) ProtoReflect

func (x *PipelineTaskDetail) ProtoReflect() protoreflect.Message

func (*PipelineTaskDetail) Reset

func (x *PipelineTaskDetail) Reset()

func (*PipelineTaskDetail) String

func (x *PipelineTaskDetail) String() string

type PipelineTaskDetail_ArtifactList

type PipelineTaskDetail_ArtifactList struct {

	// Output only. A list of artifact metadata.
	Artifacts []*Artifact `protobuf:"bytes,1,rep,name=artifacts,proto3" json:"artifacts,omitempty"`
	// contains filtered or unexported fields
}

A list of artifact metadata.

func (*PipelineTaskDetail_ArtifactList) Descriptor deprecated

func (*PipelineTaskDetail_ArtifactList) Descriptor() ([]byte, []int)

Deprecated: Use PipelineTaskDetail_ArtifactList.ProtoReflect.Descriptor instead.

func (*PipelineTaskDetail_ArtifactList) GetArtifacts

func (x *PipelineTaskDetail_ArtifactList) GetArtifacts() []*Artifact

func (*PipelineTaskDetail_ArtifactList) ProtoMessage

func (*PipelineTaskDetail_ArtifactList) ProtoMessage()

func (*PipelineTaskDetail_ArtifactList) ProtoReflect

func (*PipelineTaskDetail_ArtifactList) Reset

func (*PipelineTaskDetail_ArtifactList) String

type PipelineTaskDetail_PipelineTaskStatus

type PipelineTaskDetail_PipelineTaskStatus struct {

	// Output only. Update time of this status.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The state of the task.
	State PipelineTaskDetail_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.PipelineTaskDetail_State" json:"state,omitempty"`
	// Output only. The error that occurred during the state. May be set when
	// the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or
	// FAILED state. If the state is FAILED, the error here is final and not
	// going to be retried. If the state is a non-final state, the error
	// indicates a system-error being retried.
	Error *status.Status `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

A single record of the task status.

func (*PipelineTaskDetail_PipelineTaskStatus) Descriptor deprecated

func (*PipelineTaskDetail_PipelineTaskStatus) Descriptor() ([]byte, []int)

Deprecated: Use PipelineTaskDetail_PipelineTaskStatus.ProtoReflect.Descriptor instead.

func (*PipelineTaskDetail_PipelineTaskStatus) GetError

func (*PipelineTaskDetail_PipelineTaskStatus) GetState

func (*PipelineTaskDetail_PipelineTaskStatus) GetUpdateTime

func (*PipelineTaskDetail_PipelineTaskStatus) ProtoMessage

func (*PipelineTaskDetail_PipelineTaskStatus) ProtoMessage()

func (*PipelineTaskDetail_PipelineTaskStatus) ProtoReflect

func (*PipelineTaskDetail_PipelineTaskStatus) Reset

func (*PipelineTaskDetail_PipelineTaskStatus) String

type PipelineTaskDetail_State

type PipelineTaskDetail_State int32

Specifies state of TaskExecution

const (
	// Unspecified.
	PipelineTaskDetail_STATE_UNSPECIFIED PipelineTaskDetail_State = 0
	// Specifies pending state for the task.
	PipelineTaskDetail_PENDING PipelineTaskDetail_State = 1
	// Specifies task is being executed.
	PipelineTaskDetail_RUNNING PipelineTaskDetail_State = 2
	// Specifies task completed successfully.
	PipelineTaskDetail_SUCCEEDED PipelineTaskDetail_State = 3
	// Specifies Task cancel is in pending state.
	PipelineTaskDetail_CANCEL_PENDING PipelineTaskDetail_State = 4
	// Specifies task is being cancelled.
	PipelineTaskDetail_CANCELLING PipelineTaskDetail_State = 5
	// Specifies task was cancelled.
	PipelineTaskDetail_CANCELLED PipelineTaskDetail_State = 6
	// Specifies task failed.
	PipelineTaskDetail_FAILED PipelineTaskDetail_State = 7
	// Specifies task was skipped due to cache hit.
	PipelineTaskDetail_SKIPPED PipelineTaskDetail_State = 8
	// Specifies that the task was not triggered because the task's trigger
	// policy is not satisfied. The trigger policy is specified in the
	// `condition` field of
	// [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec].
	PipelineTaskDetail_NOT_TRIGGERED PipelineTaskDetail_State = 9
)

func (PipelineTaskDetail_State) Descriptor

func (PipelineTaskDetail_State) Enum

func (PipelineTaskDetail_State) EnumDescriptor deprecated

func (PipelineTaskDetail_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use PipelineTaskDetail_State.Descriptor instead.

func (PipelineTaskDetail_State) Number

func (PipelineTaskDetail_State) String

func (x PipelineTaskDetail_State) String() string

func (PipelineTaskDetail_State) Type

type PipelineTaskExecutorDetail

type PipelineTaskExecutorDetail struct {

	// Types that are assignable to Details:
	//
	//	*PipelineTaskExecutorDetail_ContainerDetail_
	//	*PipelineTaskExecutorDetail_CustomJobDetail_
	Details isPipelineTaskExecutorDetail_Details `protobuf_oneof:"details"`
	// contains filtered or unexported fields
}

The runtime detail of a pipeline executor.

func (*PipelineTaskExecutorDetail) Descriptor deprecated

func (*PipelineTaskExecutorDetail) Descriptor() ([]byte, []int)

Deprecated: Use PipelineTaskExecutorDetail.ProtoReflect.Descriptor instead.

func (*PipelineTaskExecutorDetail) GetContainerDetail

func (*PipelineTaskExecutorDetail) GetCustomJobDetail

func (*PipelineTaskExecutorDetail) GetDetails

func (m *PipelineTaskExecutorDetail) GetDetails() isPipelineTaskExecutorDetail_Details

func (*PipelineTaskExecutorDetail) ProtoMessage

func (*PipelineTaskExecutorDetail) ProtoMessage()

func (*PipelineTaskExecutorDetail) ProtoReflect

func (*PipelineTaskExecutorDetail) Reset

func (x *PipelineTaskExecutorDetail) Reset()

func (*PipelineTaskExecutorDetail) String

func (x *PipelineTaskExecutorDetail) String() string

type PipelineTaskExecutorDetail_ContainerDetail

type PipelineTaskExecutorDetail_ContainerDetail struct {

	// Output only. The name of the
	// [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the main container
	// execution.
	MainJob string `protobuf:"bytes,1,opt,name=main_job,json=mainJob,proto3" json:"main_job,omitempty"`
	// Output only. The name of the
	// [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the
	// pre-caching-check container execution. This job will be available if the
	// [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
	// specifies the `pre_caching_check` hook in the lifecycle events.
	PreCachingCheckJob string `protobuf:"bytes,2,opt,name=pre_caching_check_job,json=preCachingCheckJob,proto3" json:"pre_caching_check_job,omitempty"`
	// Output only. The names of the previously failed
	// [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the main container
	// executions. The list includes the all attempts in chronological order.
	FailedMainJobs []string `protobuf:"bytes,3,rep,name=failed_main_jobs,json=failedMainJobs,proto3" json:"failed_main_jobs,omitempty"`
	// Output only. The names of the previously failed
	// [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the
	// pre-caching-check container executions. This job will be available if the
	// [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
	// specifies the `pre_caching_check` hook in the lifecycle events. The list
	// includes the all attempts in chronological order.
	FailedPreCachingCheckJobs []string `` /* 142-byte string literal not displayed */
	// contains filtered or unexported fields
}

The detail of a container execution. It contains the job names of the lifecycle of a container execution.

func (*PipelineTaskExecutorDetail_ContainerDetail) Descriptor deprecated

Deprecated: Use PipelineTaskExecutorDetail_ContainerDetail.ProtoReflect.Descriptor instead.

func (*PipelineTaskExecutorDetail_ContainerDetail) GetFailedMainJobs

func (x *PipelineTaskExecutorDetail_ContainerDetail) GetFailedMainJobs() []string

func (*PipelineTaskExecutorDetail_ContainerDetail) GetFailedPreCachingCheckJobs

func (x *PipelineTaskExecutorDetail_ContainerDetail) GetFailedPreCachingCheckJobs() []string

func (*PipelineTaskExecutorDetail_ContainerDetail) GetMainJob

func (*PipelineTaskExecutorDetail_ContainerDetail) GetPreCachingCheckJob

func (x *PipelineTaskExecutorDetail_ContainerDetail) GetPreCachingCheckJob() string

func (*PipelineTaskExecutorDetail_ContainerDetail) ProtoMessage

func (*PipelineTaskExecutorDetail_ContainerDetail) ProtoReflect

func (*PipelineTaskExecutorDetail_ContainerDetail) Reset

func (*PipelineTaskExecutorDetail_ContainerDetail) String

type PipelineTaskExecutorDetail_ContainerDetail_

type PipelineTaskExecutorDetail_ContainerDetail_ struct {
	// Output only. The detailed info for a container executor.
	ContainerDetail *PipelineTaskExecutorDetail_ContainerDetail `protobuf:"bytes,1,opt,name=container_detail,json=containerDetail,proto3,oneof"`
}

type PipelineTaskExecutorDetail_CustomJobDetail

type PipelineTaskExecutorDetail_CustomJobDetail struct {

	// Output only. The name of the
	// [CustomJob][google.cloud.aiplatform.v1.CustomJob].
	Job string `protobuf:"bytes,1,opt,name=job,proto3" json:"job,omitempty"`
	// Output only. The names of the previously failed
	// [CustomJob][google.cloud.aiplatform.v1.CustomJob]. The list includes the
	// all attempts in chronological order.
	FailedJobs []string `protobuf:"bytes,3,rep,name=failed_jobs,json=failedJobs,proto3" json:"failed_jobs,omitempty"`
	// contains filtered or unexported fields
}

The detailed info for a custom job executor.

func (*PipelineTaskExecutorDetail_CustomJobDetail) Descriptor deprecated

Deprecated: Use PipelineTaskExecutorDetail_CustomJobDetail.ProtoReflect.Descriptor instead.

func (*PipelineTaskExecutorDetail_CustomJobDetail) GetFailedJobs added in v1.34.0

func (*PipelineTaskExecutorDetail_CustomJobDetail) GetJob

func (*PipelineTaskExecutorDetail_CustomJobDetail) ProtoMessage

func (*PipelineTaskExecutorDetail_CustomJobDetail) ProtoReflect

func (*PipelineTaskExecutorDetail_CustomJobDetail) Reset

func (*PipelineTaskExecutorDetail_CustomJobDetail) String

type PipelineTaskExecutorDetail_CustomJobDetail_

type PipelineTaskExecutorDetail_CustomJobDetail_ struct {
	// Output only. The detailed info for a custom job executor.
	CustomJobDetail *PipelineTaskExecutorDetail_CustomJobDetail `protobuf:"bytes,2,opt,name=custom_job_detail,json=customJobDetail,proto3,oneof"`
}

type PipelineTemplateMetadata

type PipelineTemplateMetadata struct {

	// The version_name in artifact registry.
	//
	// Will always be presented in output if the
	// [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri]
	// is from supported template registry.
	//
	// Format is "sha256:abcdef123456...".
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

Pipeline template metadata if [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] is from supported template registry. Currently, the only supported registry is Artifact Registry.

func (*PipelineTemplateMetadata) Descriptor deprecated

func (*PipelineTemplateMetadata) Descriptor() ([]byte, []int)

Deprecated: Use PipelineTemplateMetadata.ProtoReflect.Descriptor instead.

func (*PipelineTemplateMetadata) GetVersion

func (x *PipelineTemplateMetadata) GetVersion() string

func (*PipelineTemplateMetadata) ProtoMessage

func (*PipelineTemplateMetadata) ProtoMessage()

func (*PipelineTemplateMetadata) ProtoReflect

func (x *PipelineTemplateMetadata) ProtoReflect() protoreflect.Message

func (*PipelineTemplateMetadata) Reset

func (x *PipelineTemplateMetadata) Reset()

func (*PipelineTemplateMetadata) String

func (x *PipelineTemplateMetadata) String() string

type Port

type Port struct {

	// The number of the port to expose on the pod's IP address.
	// Must be a valid port number, between 1 and 65535 inclusive.
	ContainerPort int32 `protobuf:"varint,3,opt,name=container_port,json=containerPort,proto3" json:"container_port,omitempty"`
	// contains filtered or unexported fields
}

Represents a network port in a container.

func (*Port) Descriptor deprecated

func (*Port) Descriptor() ([]byte, []int)

Deprecated: Use Port.ProtoReflect.Descriptor instead.

func (*Port) GetContainerPort

func (x *Port) GetContainerPort() int32

func (*Port) ProtoMessage

func (*Port) ProtoMessage()

func (*Port) ProtoReflect

func (x *Port) ProtoReflect() protoreflect.Message

func (*Port) Reset

func (x *Port) Reset()

func (*Port) String

func (x *Port) String() string

type PredefinedSplit

type PredefinedSplit struct {

	// Required. The key is a name of one of the Dataset's data columns.
	// The value of the key (either the label's value or value in the column)
	// must be one of {`training`, `validation`, `test`}, and it defines to which
	// set the given piece of data is assigned. If for a piece of data the key
	// is not present or has an invalid value, that piece is ignored by the
	// pipeline.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

Assigns input data to training, validation, and test sets based on the value of a provided key.

Supported only for tabular Datasets.

func (*PredefinedSplit) Descriptor deprecated

func (*PredefinedSplit) Descriptor() ([]byte, []int)

Deprecated: Use PredefinedSplit.ProtoReflect.Descriptor instead.

func (*PredefinedSplit) GetKey

func (x *PredefinedSplit) GetKey() string

func (*PredefinedSplit) ProtoMessage

func (*PredefinedSplit) ProtoMessage()

func (*PredefinedSplit) ProtoReflect

func (x *PredefinedSplit) ProtoReflect() protoreflect.Message

func (*PredefinedSplit) Reset

func (x *PredefinedSplit) Reset()

func (*PredefinedSplit) String

func (x *PredefinedSplit) String() string

type PredictRequest

type PredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Required. The instances that are the input to the prediction call.
	// A DeployedModel may have an upper limit on the number of instances it
	// supports per request, and when it is exceeded the prediction call errors
	// in case of AutoML Models, or, in case of customer created Models, the
	// behaviour is as documented by that Model.
	// The schema of any single instance may be specified via Endpoint's
	// DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
	// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
	Instances []*structpb.Value `protobuf:"bytes,2,rep,name=instances,proto3" json:"instances,omitempty"`
	// The parameters that govern the prediction. The schema of the parameters may
	// be specified via Endpoint's DeployedModels' [Model's
	// ][google.cloud.aiplatform.v1.DeployedModel.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
	// [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
	Parameters *structpb.Value `protobuf:"bytes,3,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].

func (*PredictRequest) Descriptor deprecated

func (*PredictRequest) Descriptor() ([]byte, []int)

Deprecated: Use PredictRequest.ProtoReflect.Descriptor instead.

func (*PredictRequest) GetEndpoint

func (x *PredictRequest) GetEndpoint() string

func (*PredictRequest) GetInstances

func (x *PredictRequest) GetInstances() []*structpb.Value

func (*PredictRequest) GetParameters

func (x *PredictRequest) GetParameters() *structpb.Value

func (*PredictRequest) ProtoMessage

func (*PredictRequest) ProtoMessage()

func (*PredictRequest) ProtoReflect

func (x *PredictRequest) ProtoReflect() protoreflect.Message

func (*PredictRequest) Reset

func (x *PredictRequest) Reset()

func (*PredictRequest) String

func (x *PredictRequest) String() string

type PredictRequestResponseLoggingConfig

type PredictRequestResponseLoggingConfig struct {

	// If logging is enabled or not.
	Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// Percentage of requests to be logged, expressed as a fraction in
	// range(0,1].
	SamplingRate float64 `protobuf:"fixed64,2,opt,name=sampling_rate,json=samplingRate,proto3" json:"sampling_rate,omitempty"`
	// BigQuery table for logging.
	// If only given a project, a new dataset will be created with name
	// `logging_<endpoint-display-name>_<endpoint-id>` where
	// <endpoint-display-name> will be made BigQuery-dataset-name compatible (e.g.
	// most special characters will become underscores). If no table name is
	// given, a new table will be created with name `request_response_logging`
	BigqueryDestination *BigQueryDestination `protobuf:"bytes,3,opt,name=bigquery_destination,json=bigqueryDestination,proto3" json:"bigquery_destination,omitempty"`
	// contains filtered or unexported fields
}

Configuration for logging request-response to a BigQuery table.

func (*PredictRequestResponseLoggingConfig) Descriptor deprecated

func (*PredictRequestResponseLoggingConfig) Descriptor() ([]byte, []int)

Deprecated: Use PredictRequestResponseLoggingConfig.ProtoReflect.Descriptor instead.

func (*PredictRequestResponseLoggingConfig) GetBigqueryDestination

func (x *PredictRequestResponseLoggingConfig) GetBigqueryDestination() *BigQueryDestination

func (*PredictRequestResponseLoggingConfig) GetEnabled

func (x *PredictRequestResponseLoggingConfig) GetEnabled() bool

func (*PredictRequestResponseLoggingConfig) GetSamplingRate

func (x *PredictRequestResponseLoggingConfig) GetSamplingRate() float64

func (*PredictRequestResponseLoggingConfig) ProtoMessage

func (*PredictRequestResponseLoggingConfig) ProtoMessage()

func (*PredictRequestResponseLoggingConfig) ProtoReflect

func (*PredictRequestResponseLoggingConfig) Reset

func (*PredictRequestResponseLoggingConfig) String

type PredictResponse

type PredictResponse struct {

	// The predictions that are the output of the predictions call.
	// The schema of any single prediction may be specified via Endpoint's
	// DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
	// [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
	Predictions []*structpb.Value `protobuf:"bytes,1,rep,name=predictions,proto3" json:"predictions,omitempty"`
	// ID of the Endpoint's DeployedModel that served this prediction.
	DeployedModelId string `protobuf:"bytes,2,opt,name=deployed_model_id,json=deployedModelId,proto3" json:"deployed_model_id,omitempty"`
	// Output only. The resource name of the Model which is deployed as the
	// DeployedModel that this prediction hits.
	Model string `protobuf:"bytes,3,opt,name=model,proto3" json:"model,omitempty"`
	// Output only. The version ID of the Model which is deployed as the
	// DeployedModel that this prediction hits.
	ModelVersionId string `protobuf:"bytes,5,opt,name=model_version_id,json=modelVersionId,proto3" json:"model_version_id,omitempty"`
	// Output only. The [display
	// name][google.cloud.aiplatform.v1.Model.display_name] of the Model which is
	// deployed as the DeployedModel that this prediction hits.
	ModelDisplayName string `protobuf:"bytes,4,opt,name=model_display_name,json=modelDisplayName,proto3" json:"model_display_name,omitempty"`
	// Output only. Request-level metadata returned by the model. The metadata
	// type will be dependent upon the model implementation.
	Metadata *structpb.Value `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].

func (*PredictResponse) Descriptor deprecated

func (*PredictResponse) Descriptor() ([]byte, []int)

Deprecated: Use PredictResponse.ProtoReflect.Descriptor instead.

func (*PredictResponse) GetDeployedModelId

func (x *PredictResponse) GetDeployedModelId() string

func (*PredictResponse) GetMetadata added in v1.48.0

func (x *PredictResponse) GetMetadata() *structpb.Value

func (*PredictResponse) GetModel

func (x *PredictResponse) GetModel() string

func (*PredictResponse) GetModelDisplayName

func (x *PredictResponse) GetModelDisplayName() string

func (*PredictResponse) GetModelVersionId

func (x *PredictResponse) GetModelVersionId() string

func (*PredictResponse) GetPredictions

func (x *PredictResponse) GetPredictions() []*structpb.Value

func (*PredictResponse) ProtoMessage

func (*PredictResponse) ProtoMessage()

func (*PredictResponse) ProtoReflect

func (x *PredictResponse) ProtoReflect() protoreflect.Message

func (*PredictResponse) Reset

func (x *PredictResponse) Reset()

func (*PredictResponse) String

func (x *PredictResponse) String() string

type PredictSchemata

type PredictSchemata struct {

	// Immutable. Points to a YAML file stored on Google Cloud Storage describing
	// the format of a single instance, which are used in
	// [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
	// [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances]
	// and
	// [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
	// The schema is defined as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	// AutoML Models always have this field populated by Vertex AI.
	// Note: The URI given on output will be immutable and probably different,
	// including the URI scheme, than the one given on input. The output URI will
	// point to a location where the user only has a read access.
	InstanceSchemaUri string `protobuf:"bytes,1,opt,name=instance_schema_uri,json=instanceSchemaUri,proto3" json:"instance_schema_uri,omitempty"`
	// Immutable. Points to a YAML file stored on Google Cloud Storage describing
	// the parameters of prediction and explanation via
	// [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters],
	// [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters]
	// and
	// [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1.BatchPredictionJob.model_parameters].
	// The schema is defined as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	// AutoML Models always have this field populated by Vertex AI, if no
	// parameters are supported, then it is set to an empty string.
	// Note: The URI given on output will be immutable and probably different,
	// including the URI scheme, than the one given on input. The output URI will
	// point to a location where the user only has a read access.
	ParametersSchemaUri string `protobuf:"bytes,2,opt,name=parameters_schema_uri,json=parametersSchemaUri,proto3" json:"parameters_schema_uri,omitempty"`
	// Immutable. Points to a YAML file stored on Google Cloud Storage describing
	// the format of a single prediction produced by this Model, which are
	// returned via
	// [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions],
	// [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations],
	// and
	// [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
	// The schema is defined as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	// AutoML Models always have this field populated by Vertex AI.
	// Note: The URI given on output will be immutable and probably different,
	// including the URI scheme, than the one given on input. The output URI will
	// point to a location where the user only has a read access.
	PredictionSchemaUri string `protobuf:"bytes,3,opt,name=prediction_schema_uri,json=predictionSchemaUri,proto3" json:"prediction_schema_uri,omitempty"`
	// contains filtered or unexported fields
}

Contains the schemata used in Model's predictions and explanations via [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict], [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain] and BatchPredictionJob[google.cloud.aiplatform.v1.BatchPredictionJob].

func (*PredictSchemata) Descriptor deprecated

func (*PredictSchemata) Descriptor() ([]byte, []int)

Deprecated: Use PredictSchemata.ProtoReflect.Descriptor instead.

func (*PredictSchemata) GetInstanceSchemaUri

func (x *PredictSchemata) GetInstanceSchemaUri() string

func (*PredictSchemata) GetParametersSchemaUri

func (x *PredictSchemata) GetParametersSchemaUri() string

func (*PredictSchemata) GetPredictionSchemaUri

func (x *PredictSchemata) GetPredictionSchemaUri() string

func (*PredictSchemata) ProtoMessage

func (*PredictSchemata) ProtoMessage()

func (*PredictSchemata) ProtoReflect

func (x *PredictSchemata) ProtoReflect() protoreflect.Message

func (*PredictSchemata) Reset

func (x *PredictSchemata) Reset()

func (*PredictSchemata) String

func (x *PredictSchemata) String() string

type PredictionServiceClient

type PredictionServiceClient interface {
	// Perform an online prediction.
	Predict(ctx context.Context, in *PredictRequest, opts ...grpc.CallOption) (*PredictResponse, error)
	// Perform an online prediction with an arbitrary HTTP payload.
	//
	// The response includes the following HTTP headers:
	//
	// * `X-Vertex-AI-Endpoint-Id`: ID of the
	// [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this
	// prediction.
	//
	// * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's
	// [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this
	// prediction.
	RawPredict(ctx context.Context, in *RawPredictRequest, opts ...grpc.CallOption) (*httpbody.HttpBody, error)
	// Perform a streaming online prediction with an arbitrary HTTP payload.
	StreamRawPredict(ctx context.Context, in *StreamRawPredictRequest, opts ...grpc.CallOption) (PredictionService_StreamRawPredictClient, error)
	// Perform an unary online prediction request to a gRPC model server for
	// Vertex first-party products and frameworks.
	DirectPredict(ctx context.Context, in *DirectPredictRequest, opts ...grpc.CallOption) (*DirectPredictResponse, error)
	// Perform an unary online prediction request to a gRPC model server for
	// custom containers.
	DirectRawPredict(ctx context.Context, in *DirectRawPredictRequest, opts ...grpc.CallOption) (*DirectRawPredictResponse, error)
	// Perform a streaming online prediction request to a gRPC model server for
	// Vertex first-party products and frameworks.
	StreamDirectPredict(ctx context.Context, opts ...grpc.CallOption) (PredictionService_StreamDirectPredictClient, error)
	// Perform a streaming online prediction request to a gRPC model server for
	// custom containers.
	StreamDirectRawPredict(ctx context.Context, opts ...grpc.CallOption) (PredictionService_StreamDirectRawPredictClient, error)
	// Perform a streaming online prediction request for Vertex first-party
	// products and frameworks.
	StreamingPredict(ctx context.Context, opts ...grpc.CallOption) (PredictionService_StreamingPredictClient, error)
	// Perform a server-side streaming online prediction request for Vertex
	// LLM streaming.
	ServerStreamingPredict(ctx context.Context, in *StreamingPredictRequest, opts ...grpc.CallOption) (PredictionService_ServerStreamingPredictClient, error)
	// Perform a streaming online prediction request through gRPC.
	StreamingRawPredict(ctx context.Context, opts ...grpc.CallOption) (PredictionService_StreamingRawPredictClient, error)
	// Perform an online explanation.
	//
	// If
	// [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id]
	// is specified, the corresponding DeployModel must have
	// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
	// populated. If
	// [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id]
	// is not specified, all DeployedModels must have
	// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
	// populated.
	Explain(ctx context.Context, in *ExplainRequest, opts ...grpc.CallOption) (*ExplainResponse, error)
	// Generate content with multimodal inputs.
	GenerateContent(ctx context.Context, in *GenerateContentRequest, opts ...grpc.CallOption) (*GenerateContentResponse, error)
	// Generate content with multimodal inputs with streaming support.
	StreamGenerateContent(ctx context.Context, in *GenerateContentRequest, opts ...grpc.CallOption) (PredictionService_StreamGenerateContentClient, error)
}

PredictionServiceClient is the client API for PredictionService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type PredictionServiceServer

type PredictionServiceServer interface {
	// Perform an online prediction.
	Predict(context.Context, *PredictRequest) (*PredictResponse, error)
	// Perform an online prediction with an arbitrary HTTP payload.
	//
	// The response includes the following HTTP headers:
	//
	// * `X-Vertex-AI-Endpoint-Id`: ID of the
	// [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this
	// prediction.
	//
	// * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's
	// [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this
	// prediction.
	RawPredict(context.Context, *RawPredictRequest) (*httpbody.HttpBody, error)
	// Perform a streaming online prediction with an arbitrary HTTP payload.
	StreamRawPredict(*StreamRawPredictRequest, PredictionService_StreamRawPredictServer) error
	// Perform an unary online prediction request to a gRPC model server for
	// Vertex first-party products and frameworks.
	DirectPredict(context.Context, *DirectPredictRequest) (*DirectPredictResponse, error)
	// Perform an unary online prediction request to a gRPC model server for
	// custom containers.
	DirectRawPredict(context.Context, *DirectRawPredictRequest) (*DirectRawPredictResponse, error)
	// Perform a streaming online prediction request to a gRPC model server for
	// Vertex first-party products and frameworks.
	StreamDirectPredict(PredictionService_StreamDirectPredictServer) error
	// Perform a streaming online prediction request to a gRPC model server for
	// custom containers.
	StreamDirectRawPredict(PredictionService_StreamDirectRawPredictServer) error
	// Perform a streaming online prediction request for Vertex first-party
	// products and frameworks.
	StreamingPredict(PredictionService_StreamingPredictServer) error
	// Perform a server-side streaming online prediction request for Vertex
	// LLM streaming.
	ServerStreamingPredict(*StreamingPredictRequest, PredictionService_ServerStreamingPredictServer) error
	// Perform a streaming online prediction request through gRPC.
	StreamingRawPredict(PredictionService_StreamingRawPredictServer) error
	// Perform an online explanation.
	//
	// If
	// [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id]
	// is specified, the corresponding DeployModel must have
	// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
	// populated. If
	// [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id]
	// is not specified, all DeployedModels must have
	// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
	// populated.
	Explain(context.Context, *ExplainRequest) (*ExplainResponse, error)
	// Generate content with multimodal inputs.
	GenerateContent(context.Context, *GenerateContentRequest) (*GenerateContentResponse, error)
	// Generate content with multimodal inputs with streaming support.
	StreamGenerateContent(*GenerateContentRequest, PredictionService_StreamGenerateContentServer) error
}

PredictionServiceServer is the server API for PredictionService service.

type PredictionService_ServerStreamingPredictClient added in v1.48.0

type PredictionService_ServerStreamingPredictClient interface {
	Recv() (*StreamingPredictResponse, error)
	grpc.ClientStream
}

type PredictionService_ServerStreamingPredictServer added in v1.48.0

type PredictionService_ServerStreamingPredictServer interface {
	Send(*StreamingPredictResponse) error
	grpc.ServerStream
}

type PredictionService_StreamDirectPredictClient added in v1.59.0

type PredictionService_StreamDirectPredictClient interface {
	Send(*StreamDirectPredictRequest) error
	Recv() (*StreamDirectPredictResponse, error)
	grpc.ClientStream
}

type PredictionService_StreamDirectPredictServer added in v1.59.0

type PredictionService_StreamDirectPredictServer interface {
	Send(*StreamDirectPredictResponse) error
	Recv() (*StreamDirectPredictRequest, error)
	grpc.ServerStream
}

type PredictionService_StreamDirectRawPredictClient added in v1.59.0

type PredictionService_StreamDirectRawPredictClient interface {
	Send(*StreamDirectRawPredictRequest) error
	Recv() (*StreamDirectRawPredictResponse, error)
	grpc.ClientStream
}

type PredictionService_StreamDirectRawPredictServer added in v1.59.0

type PredictionService_StreamDirectRawPredictServer interface {
	Send(*StreamDirectRawPredictResponse) error
	Recv() (*StreamDirectRawPredictRequest, error)
	grpc.ServerStream
}

type PredictionService_StreamGenerateContentClient added in v1.57.0

type PredictionService_StreamGenerateContentClient interface {
	Recv() (*GenerateContentResponse, error)
	grpc.ClientStream
}

type PredictionService_StreamGenerateContentServer added in v1.57.0

type PredictionService_StreamGenerateContentServer interface {
	Send(*GenerateContentResponse) error
	grpc.ServerStream
}

type PredictionService_StreamRawPredictClient added in v1.59.0

type PredictionService_StreamRawPredictClient interface {
	Recv() (*httpbody.HttpBody, error)
	grpc.ClientStream
}

type PredictionService_StreamRawPredictServer added in v1.59.0

type PredictionService_StreamRawPredictServer interface {
	Send(*httpbody.HttpBody) error
	grpc.ServerStream
}

type PredictionService_StreamingPredictClient added in v1.55.0

type PredictionService_StreamingPredictClient interface {
	Send(*StreamingPredictRequest) error
	Recv() (*StreamingPredictResponse, error)
	grpc.ClientStream
}

type PredictionService_StreamingPredictServer added in v1.55.0

type PredictionService_StreamingPredictServer interface {
	Send(*StreamingPredictResponse) error
	Recv() (*StreamingPredictRequest, error)
	grpc.ServerStream
}

type PredictionService_StreamingRawPredictClient added in v1.55.0

type PredictionService_StreamingRawPredictClient interface {
	Send(*StreamingRawPredictRequest) error
	Recv() (*StreamingRawPredictResponse, error)
	grpc.ClientStream
}

type PredictionService_StreamingRawPredictServer added in v1.55.0

type PredictionService_StreamingRawPredictServer interface {
	Send(*StreamingRawPredictResponse) error
	Recv() (*StreamingRawPredictRequest, error)
	grpc.ServerStream
}

type Presets added in v1.42.0

type Presets struct {

	// Preset option controlling parameters for speed-precision trade-off when
	// querying for examples. If omitted, defaults to `PRECISE`.
	Query *Presets_Query `protobuf:"varint,1,opt,name=query,proto3,enum=google.cloud.aiplatform.v1.Presets_Query,oneof" json:"query,omitempty"`
	// The modality of the uploaded model, which automatically configures the
	// distance measurement and feature normalization for the underlying example
	// index and queries. If your model does not precisely fit one of these types,
	// it is okay to choose the closest type.
	Modality Presets_Modality `protobuf:"varint,2,opt,name=modality,proto3,enum=google.cloud.aiplatform.v1.Presets_Modality" json:"modality,omitempty"`
	// contains filtered or unexported fields
}

Preset configuration for example-based explanations

func (*Presets) Descriptor deprecated added in v1.42.0

func (*Presets) Descriptor() ([]byte, []int)

Deprecated: Use Presets.ProtoReflect.Descriptor instead.

func (*Presets) GetModality added in v1.42.0

func (x *Presets) GetModality() Presets_Modality

func (*Presets) GetQuery added in v1.42.0

func (x *Presets) GetQuery() Presets_Query

func (*Presets) ProtoMessage added in v1.42.0

func (*Presets) ProtoMessage()

func (*Presets) ProtoReflect added in v1.42.0

func (x *Presets) ProtoReflect() protoreflect.Message

func (*Presets) Reset added in v1.42.0

func (x *Presets) Reset()

func (*Presets) String added in v1.42.0

func (x *Presets) String() string

type Presets_Modality added in v1.42.0

type Presets_Modality int32

Preset option controlling parameters for different modalities

const (
	// Should not be set. Added as a recommended best practice for enums
	Presets_MODALITY_UNSPECIFIED Presets_Modality = 0
	// IMAGE modality
	Presets_IMAGE Presets_Modality = 1
	// TEXT modality
	Presets_TEXT Presets_Modality = 2
	// TABULAR modality
	Presets_TABULAR Presets_Modality = 3
)

func (Presets_Modality) Descriptor added in v1.42.0

func (Presets_Modality) Enum added in v1.42.0

func (Presets_Modality) EnumDescriptor deprecated added in v1.42.0

func (Presets_Modality) EnumDescriptor() ([]byte, []int)

Deprecated: Use Presets_Modality.Descriptor instead.

func (Presets_Modality) Number added in v1.42.0

func (Presets_Modality) String added in v1.42.0

func (x Presets_Modality) String() string

func (Presets_Modality) Type added in v1.42.0

type Presets_Query added in v1.42.0

type Presets_Query int32

Preset option controlling parameters for query speed-precision trade-off

const (
	// More precise neighbors as a trade-off against slower response.
	Presets_PRECISE Presets_Query = 0
	// Faster response as a trade-off against less precise neighbors.
	Presets_FAST Presets_Query = 1
)

func (Presets_Query) Descriptor added in v1.42.0

func (Presets_Query) Enum added in v1.42.0

func (x Presets_Query) Enum() *Presets_Query

func (Presets_Query) EnumDescriptor deprecated added in v1.42.0

func (Presets_Query) EnumDescriptor() ([]byte, []int)

Deprecated: Use Presets_Query.Descriptor instead.

func (Presets_Query) Number added in v1.42.0

func (Presets_Query) String added in v1.42.0

func (x Presets_Query) String() string

func (Presets_Query) Type added in v1.42.0

type PrivateEndpoints

type PrivateEndpoints struct {

	// Output only. Http(s) path to send prediction requests.
	PredictHttpUri string `protobuf:"bytes,1,opt,name=predict_http_uri,json=predictHttpUri,proto3" json:"predict_http_uri,omitempty"`
	// Output only. Http(s) path to send explain requests.
	ExplainHttpUri string `protobuf:"bytes,2,opt,name=explain_http_uri,json=explainHttpUri,proto3" json:"explain_http_uri,omitempty"`
	// Output only. Http(s) path to send health check requests.
	HealthHttpUri string `protobuf:"bytes,3,opt,name=health_http_uri,json=healthHttpUri,proto3" json:"health_http_uri,omitempty"`
	// Output only. The name of the service attachment resource. Populated if
	// private service connect is enabled.
	ServiceAttachment string `protobuf:"bytes,4,opt,name=service_attachment,json=serviceAttachment,proto3" json:"service_attachment,omitempty"`
	// contains filtered or unexported fields
}

PrivateEndpoints proto is used to provide paths for users to send requests privately. To send request via private service access, use predict_http_uri, explain_http_uri or health_http_uri. To send request via private service connect, use service_attachment.

func (*PrivateEndpoints) Descriptor deprecated

func (*PrivateEndpoints) Descriptor() ([]byte, []int)

Deprecated: Use PrivateEndpoints.ProtoReflect.Descriptor instead.

func (*PrivateEndpoints) GetExplainHttpUri

func (x *PrivateEndpoints) GetExplainHttpUri() string

func (*PrivateEndpoints) GetHealthHttpUri

func (x *PrivateEndpoints) GetHealthHttpUri() string

func (*PrivateEndpoints) GetPredictHttpUri

func (x *PrivateEndpoints) GetPredictHttpUri() string

func (*PrivateEndpoints) GetServiceAttachment

func (x *PrivateEndpoints) GetServiceAttachment() string

func (*PrivateEndpoints) ProtoMessage

func (*PrivateEndpoints) ProtoMessage()

func (*PrivateEndpoints) ProtoReflect

func (x *PrivateEndpoints) ProtoReflect() protoreflect.Message

func (*PrivateEndpoints) Reset

func (x *PrivateEndpoints) Reset()

func (*PrivateEndpoints) String

func (x *PrivateEndpoints) String() string

type PrivateServiceConnectConfig added in v1.34.0

type PrivateServiceConnectConfig struct {

	// Required. If true, expose the IndexEndpoint via private service connect.
	EnablePrivateServiceConnect bool `` /* 147-byte string literal not displayed */
	// A list of Projects from which the forwarding rule will target the service
	// attachment.
	ProjectAllowlist []string `protobuf:"bytes,2,rep,name=project_allowlist,json=projectAllowlist,proto3" json:"project_allowlist,omitempty"`
	// contains filtered or unexported fields
}

Represents configuration for private service connect.

func (*PrivateServiceConnectConfig) Descriptor deprecated added in v1.34.0

func (*PrivateServiceConnectConfig) Descriptor() ([]byte, []int)

Deprecated: Use PrivateServiceConnectConfig.ProtoReflect.Descriptor instead.

func (*PrivateServiceConnectConfig) GetEnablePrivateServiceConnect added in v1.34.0

func (x *PrivateServiceConnectConfig) GetEnablePrivateServiceConnect() bool

func (*PrivateServiceConnectConfig) GetProjectAllowlist added in v1.34.0

func (x *PrivateServiceConnectConfig) GetProjectAllowlist() []string

func (*PrivateServiceConnectConfig) ProtoMessage added in v1.34.0

func (*PrivateServiceConnectConfig) ProtoMessage()

func (*PrivateServiceConnectConfig) ProtoReflect added in v1.34.0

func (*PrivateServiceConnectConfig) Reset added in v1.34.0

func (x *PrivateServiceConnectConfig) Reset()

func (*PrivateServiceConnectConfig) String added in v1.34.0

func (x *PrivateServiceConnectConfig) String() string

type Probe added in v1.54.0

type Probe struct {

	// Types that are assignable to ProbeType:
	//
	//	*Probe_Exec
	ProbeType isProbe_ProbeType `protobuf_oneof:"probe_type"`
	// How often (in seconds) to perform the probe. Default to 10 seconds.
	// Minimum value is 1. Must be less than timeout_seconds.
	//
	// Maps to Kubernetes probe argument 'periodSeconds'.
	PeriodSeconds int32 `protobuf:"varint,2,opt,name=period_seconds,json=periodSeconds,proto3" json:"period_seconds,omitempty"`
	// Number of seconds after which the probe times out. Defaults to 1 second.
	// Minimum value is 1. Must be greater or equal to period_seconds.
	//
	// Maps to Kubernetes probe argument 'timeoutSeconds'.
	TimeoutSeconds int32 `protobuf:"varint,3,opt,name=timeout_seconds,json=timeoutSeconds,proto3" json:"timeout_seconds,omitempty"`
	// contains filtered or unexported fields
}

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

func (*Probe) Descriptor deprecated added in v1.54.0

func (*Probe) Descriptor() ([]byte, []int)

Deprecated: Use Probe.ProtoReflect.Descriptor instead.

func (*Probe) GetExec added in v1.54.0

func (x *Probe) GetExec() *Probe_ExecAction

func (*Probe) GetPeriodSeconds added in v1.54.0

func (x *Probe) GetPeriodSeconds() int32

func (*Probe) GetProbeType added in v1.54.0

func (m *Probe) GetProbeType() isProbe_ProbeType

func (*Probe) GetTimeoutSeconds added in v1.54.0

func (x *Probe) GetTimeoutSeconds() int32

func (*Probe) ProtoMessage added in v1.54.0

func (*Probe) ProtoMessage()

func (*Probe) ProtoReflect added in v1.54.0

func (x *Probe) ProtoReflect() protoreflect.Message

func (*Probe) Reset added in v1.54.0

func (x *Probe) Reset()

func (*Probe) String added in v1.54.0

func (x *Probe) String() string

type Probe_Exec added in v1.54.0

type Probe_Exec struct {
	// Exec specifies the action to take.
	Exec *Probe_ExecAction `protobuf:"bytes,1,opt,name=exec,proto3,oneof"`
}

type Probe_ExecAction added in v1.54.0

type Probe_ExecAction struct {

	// Command is the command line to execute inside the container, the working
	// directory for the command is root ('/') in the container's filesystem.
	// The command is simply exec'd, it is not run inside a shell, so
	// traditional shell instructions ('|', etc) won't work. To use a shell, you
	// need to explicitly call out to that shell. Exit status of 0 is treated as
	// live/healthy and non-zero is unhealthy.
	Command []string `protobuf:"bytes,1,rep,name=command,proto3" json:"command,omitempty"`
	// contains filtered or unexported fields
}

ExecAction specifies a command to execute.

func (*Probe_ExecAction) Descriptor deprecated added in v1.54.0

func (*Probe_ExecAction) Descriptor() ([]byte, []int)

Deprecated: Use Probe_ExecAction.ProtoReflect.Descriptor instead.

func (*Probe_ExecAction) GetCommand added in v1.54.0

func (x *Probe_ExecAction) GetCommand() []string

func (*Probe_ExecAction) ProtoMessage added in v1.54.0

func (*Probe_ExecAction) ProtoMessage()

func (*Probe_ExecAction) ProtoReflect added in v1.54.0

func (x *Probe_ExecAction) ProtoReflect() protoreflect.Message

func (*Probe_ExecAction) Reset added in v1.54.0

func (x *Probe_ExecAction) Reset()

func (*Probe_ExecAction) String added in v1.54.0

func (x *Probe_ExecAction) String() string

type PscAutomatedEndpoints added in v1.60.0

type PscAutomatedEndpoints struct {

	// Corresponding project_id in pscAutomationConfigs
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Corresponding network in pscAutomationConfigs.
	Network string `protobuf:"bytes,2,opt,name=network,proto3" json:"network,omitempty"`
	// Ip Address created by the automated forwarding rule.
	MatchAddress string `protobuf:"bytes,3,opt,name=match_address,json=matchAddress,proto3" json:"match_address,omitempty"`
	// contains filtered or unexported fields
}

PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig.

func (*PscAutomatedEndpoints) Descriptor deprecated added in v1.60.0

func (*PscAutomatedEndpoints) Descriptor() ([]byte, []int)

Deprecated: Use PscAutomatedEndpoints.ProtoReflect.Descriptor instead.

func (*PscAutomatedEndpoints) GetMatchAddress added in v1.60.0

func (x *PscAutomatedEndpoints) GetMatchAddress() string

func (*PscAutomatedEndpoints) GetNetwork added in v1.60.0

func (x *PscAutomatedEndpoints) GetNetwork() string

func (*PscAutomatedEndpoints) GetProjectId added in v1.60.0

func (x *PscAutomatedEndpoints) GetProjectId() string

func (*PscAutomatedEndpoints) ProtoMessage added in v1.60.0

func (*PscAutomatedEndpoints) ProtoMessage()

func (*PscAutomatedEndpoints) ProtoReflect added in v1.60.0

func (x *PscAutomatedEndpoints) ProtoReflect() protoreflect.Message

func (*PscAutomatedEndpoints) Reset added in v1.60.0

func (x *PscAutomatedEndpoints) Reset()

func (*PscAutomatedEndpoints) String added in v1.60.0

func (x *PscAutomatedEndpoints) String() string

type PublisherModel added in v1.44.0

type PublisherModel struct {

	// Output only. The resource name of the PublisherModel.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Immutable. The version ID of the PublisherModel.
	// A new version is committed when a new model version is uploaded under an
	// existing model id. It is an auto-incrementing decimal number in string
	// representation.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// Required. Indicates the open source category of the publisher model.
	OpenSourceCategory PublisherModel_OpenSourceCategory `` /* 184-byte string literal not displayed */
	// Optional. Supported call-to-action options.
	SupportedActions *PublisherModel_CallToAction `protobuf:"bytes,19,opt,name=supported_actions,json=supportedActions,proto3" json:"supported_actions,omitempty"`
	// Optional. Additional information about the model's Frameworks.
	Frameworks []string `protobuf:"bytes,23,rep,name=frameworks,proto3" json:"frameworks,omitempty"`
	// Optional. Indicates the launch stage of the model.
	LaunchStage PublisherModel_LaunchStage `` /* 155-byte string literal not displayed */
	// Optional. Indicates the state of the model version.
	VersionState PublisherModel_VersionState `` /* 159-byte string literal not displayed */
	// Optional. Output only. Immutable. Used to indicate this model has a
	// publisher model and provide the template of the publisher model resource
	// name.
	PublisherModelTemplate string `` /* 130-byte string literal not displayed */
	// Optional. The schemata that describes formats of the PublisherModel's
	// predictions and explanations as given and returned via
	// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].
	PredictSchemata *PredictSchemata `protobuf:"bytes,31,opt,name=predict_schemata,json=predictSchemata,proto3" json:"predict_schemata,omitempty"`
	// contains filtered or unexported fields
}

A Model Garden Publisher Model.

func (*PublisherModel) Descriptor deprecated added in v1.44.0

func (*PublisherModel) Descriptor() ([]byte, []int)

Deprecated: Use PublisherModel.ProtoReflect.Descriptor instead.

func (*PublisherModel) GetFrameworks added in v1.44.0

func (x *PublisherModel) GetFrameworks() []string

func (*PublisherModel) GetLaunchStage added in v1.44.0

func (x *PublisherModel) GetLaunchStage() PublisherModel_LaunchStage

func (*PublisherModel) GetName added in v1.44.0

func (x *PublisherModel) GetName() string

func (*PublisherModel) GetOpenSourceCategory added in v1.44.0

func (x *PublisherModel) GetOpenSourceCategory() PublisherModel_OpenSourceCategory

func (*PublisherModel) GetPredictSchemata added in v1.44.0

func (x *PublisherModel) GetPredictSchemata() *PredictSchemata

func (*PublisherModel) GetPublisherModelTemplate added in v1.44.0

func (x *PublisherModel) GetPublisherModelTemplate() string

func (*PublisherModel) GetSupportedActions added in v1.44.0

func (x *PublisherModel) GetSupportedActions() *PublisherModel_CallToAction

func (*PublisherModel) GetVersionId added in v1.44.0

func (x *PublisherModel) GetVersionId() string

func (*PublisherModel) GetVersionState added in v1.57.0

func (x *PublisherModel) GetVersionState() PublisherModel_VersionState

func (*PublisherModel) ProtoMessage added in v1.44.0

func (*PublisherModel) ProtoMessage()

func (*PublisherModel) ProtoReflect added in v1.44.0

func (x *PublisherModel) ProtoReflect() protoreflect.Message

func (*PublisherModel) Reset added in v1.44.0

func (x *PublisherModel) Reset()

func (*PublisherModel) String added in v1.44.0

func (x *PublisherModel) String() string

type PublisherModelView added in v1.44.0

type PublisherModelView int32

View enumeration of PublisherModel.

const (
	// The default / unset value. The API will default to the BASIC view.
	PublisherModelView_PUBLISHER_MODEL_VIEW_UNSPECIFIED PublisherModelView = 0
	// Include basic metadata about the publisher model, but not the full
	// contents.
	PublisherModelView_PUBLISHER_MODEL_VIEW_BASIC PublisherModelView = 1
	// Include everything.
	PublisherModelView_PUBLISHER_MODEL_VIEW_FULL PublisherModelView = 2
	// Include: VersionId, ModelVersionExternalName, and SupportedActions.
	PublisherModelView_PUBLISHER_MODEL_VERSION_VIEW_BASIC PublisherModelView = 3
)

func (PublisherModelView) Descriptor added in v1.44.0

func (PublisherModelView) Enum added in v1.44.0

func (PublisherModelView) EnumDescriptor deprecated added in v1.44.0

func (PublisherModelView) EnumDescriptor() ([]byte, []int)

Deprecated: Use PublisherModelView.Descriptor instead.

func (PublisherModelView) Number added in v1.44.0

func (PublisherModelView) String added in v1.44.0

func (x PublisherModelView) String() string

func (PublisherModelView) Type added in v1.44.0

type PublisherModel_CallToAction added in v1.44.0

type PublisherModel_CallToAction struct {

	// Optional. To view Rest API docs.
	ViewRestApi *PublisherModel_CallToAction_ViewRestApi `protobuf:"bytes,1,opt,name=view_rest_api,json=viewRestApi,proto3" json:"view_rest_api,omitempty"`
	// Optional. Open notebook of the PublisherModel.
	OpenNotebook *PublisherModel_CallToAction_RegionalResourceReferences `protobuf:"bytes,2,opt,name=open_notebook,json=openNotebook,proto3" json:"open_notebook,omitempty"`
	// Optional. Open notebooks of the PublisherModel.
	OpenNotebooks *PublisherModel_CallToAction_OpenNotebooks `protobuf:"bytes,12,opt,name=open_notebooks,json=openNotebooks,proto3,oneof" json:"open_notebooks,omitempty"`
	// Optional. Create application using the PublisherModel.
	CreateApplication *PublisherModel_CallToAction_RegionalResourceReferences `protobuf:"bytes,3,opt,name=create_application,json=createApplication,proto3" json:"create_application,omitempty"`
	// Optional. Open fine-tuning pipeline of the PublisherModel.
	OpenFineTuningPipeline *PublisherModel_CallToAction_RegionalResourceReferences `` /* 131-byte string literal not displayed */
	// Optional. Open fine-tuning pipelines of the PublisherModel.
	OpenFineTuningPipelines *PublisherModel_CallToAction_OpenFineTuningPipelines `` /* 141-byte string literal not displayed */
	// Optional. Open prompt-tuning pipeline of the PublisherModel.
	OpenPromptTuningPipeline *PublisherModel_CallToAction_RegionalResourceReferences `` /* 137-byte string literal not displayed */
	// Optional. Open Genie / Playground.
	OpenGenie *PublisherModel_CallToAction_RegionalResourceReferences `protobuf:"bytes,6,opt,name=open_genie,json=openGenie,proto3" json:"open_genie,omitempty"`
	// Optional. Deploy the PublisherModel to Vertex Endpoint.
	Deploy *PublisherModel_CallToAction_Deploy `protobuf:"bytes,7,opt,name=deploy,proto3" json:"deploy,omitempty"`
	// Optional. Deploy PublisherModel to Google Kubernetes Engine.
	DeployGke *PublisherModel_CallToAction_DeployGke `protobuf:"bytes,14,opt,name=deploy_gke,json=deployGke,proto3" json:"deploy_gke,omitempty"`
	// Optional. Open in Generation AI Studio.
	OpenGenerationAiStudio *PublisherModel_CallToAction_RegionalResourceReferences `` /* 131-byte string literal not displayed */
	// Optional. Request for access.
	RequestAccess *PublisherModel_CallToAction_RegionalResourceReferences `protobuf:"bytes,9,opt,name=request_access,json=requestAccess,proto3" json:"request_access,omitempty"`
	// Optional. Open evaluation pipeline of the PublisherModel.
	OpenEvaluationPipeline *PublisherModel_CallToAction_RegionalResourceReferences `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

Actions could take on this Publisher Model.

func (*PublisherModel_CallToAction) Descriptor deprecated added in v1.44.0

func (*PublisherModel_CallToAction) Descriptor() ([]byte, []int)

Deprecated: Use PublisherModel_CallToAction.ProtoReflect.Descriptor instead.

func (*PublisherModel_CallToAction) GetCreateApplication added in v1.44.0

func (*PublisherModel_CallToAction) GetDeploy added in v1.44.0

func (*PublisherModel_CallToAction) GetDeployGke added in v1.60.0

func (*PublisherModel_CallToAction) GetOpenEvaluationPipeline added in v1.49.0

func (*PublisherModel_CallToAction) GetOpenFineTuningPipeline added in v1.44.0

func (*PublisherModel_CallToAction) GetOpenFineTuningPipelines added in v1.60.0

func (*PublisherModel_CallToAction) GetOpenGenerationAiStudio added in v1.44.0

func (*PublisherModel_CallToAction) GetOpenGenie added in v1.44.0

func (*PublisherModel_CallToAction) GetOpenNotebook added in v1.44.0

func (*PublisherModel_CallToAction) GetOpenNotebooks added in v1.60.0

func (*PublisherModel_CallToAction) GetOpenPromptTuningPipeline added in v1.44.0

func (*PublisherModel_CallToAction) GetRequestAccess added in v1.44.0

func (*PublisherModel_CallToAction) GetViewRestApi added in v1.44.0

func (*PublisherModel_CallToAction) ProtoMessage added in v1.44.0

func (*PublisherModel_CallToAction) ProtoMessage()

func (*PublisherModel_CallToAction) ProtoReflect added in v1.44.0

func (*PublisherModel_CallToAction) Reset added in v1.44.0

func (x *PublisherModel_CallToAction) Reset()

func (*PublisherModel_CallToAction) String added in v1.44.0

func (x *PublisherModel_CallToAction) String() string

type PublisherModel_CallToAction_Deploy added in v1.44.0

type PublisherModel_CallToAction_Deploy struct {

	// The prediction (for example, the machine) resources that the
	// DeployedModel uses.
	//
	// Types that are assignable to PredictionResources:
	//
	//	*PublisherModel_CallToAction_Deploy_DedicatedResources
	//	*PublisherModel_CallToAction_Deploy_AutomaticResources
	//	*PublisherModel_CallToAction_Deploy_SharedResources
	PredictionResources isPublisherModel_CallToAction_Deploy_PredictionResources `protobuf_oneof:"prediction_resources"`
	// Optional. Default model display name.
	ModelDisplayName string `protobuf:"bytes,1,opt,name=model_display_name,json=modelDisplayName,proto3" json:"model_display_name,omitempty"`
	// Optional. Large model reference. When this is set, model_artifact_spec
	// is not needed.
	LargeModelReference *LargeModelReference `protobuf:"bytes,2,opt,name=large_model_reference,json=largeModelReference,proto3" json:"large_model_reference,omitempty"`
	// Optional. The specification of the container that is to be used when
	// deploying this Model in Vertex AI. Not present for Large Models.
	ContainerSpec *ModelContainerSpec `protobuf:"bytes,3,opt,name=container_spec,json=containerSpec,proto3" json:"container_spec,omitempty"`
	// Optional. The path to the directory containing the Model artifact and
	// any of its supporting files.
	ArtifactUri string `protobuf:"bytes,4,opt,name=artifact_uri,json=artifactUri,proto3" json:"artifact_uri,omitempty"`
	// Required. The title of the regional resource reference.
	Title string `protobuf:"bytes,8,opt,name=title,proto3" json:"title,omitempty"`
	// Optional. The signed URI for ephemeral Cloud Storage access to model
	// artifact.
	PublicArtifactUri string `protobuf:"bytes,9,opt,name=public_artifact_uri,json=publicArtifactUri,proto3" json:"public_artifact_uri,omitempty"`
	// contains filtered or unexported fields
}

Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.

func (*PublisherModel_CallToAction_Deploy) Descriptor deprecated added in v1.44.0

func (*PublisherModel_CallToAction_Deploy) Descriptor() ([]byte, []int)

Deprecated: Use PublisherModel_CallToAction_Deploy.ProtoReflect.Descriptor instead.

func (*PublisherModel_CallToAction_Deploy) GetArtifactUri added in v1.44.0

func (x *PublisherModel_CallToAction_Deploy) GetArtifactUri() string

func (*PublisherModel_CallToAction_Deploy) GetAutomaticResources added in v1.44.0

func (x *PublisherModel_CallToAction_Deploy) GetAutomaticResources() *AutomaticResources

func (*PublisherModel_CallToAction_Deploy) GetContainerSpec added in v1.44.0

func (*PublisherModel_CallToAction_Deploy) GetDedicatedResources added in v1.44.0

func (x *PublisherModel_CallToAction_Deploy) GetDedicatedResources() *DedicatedResources

func (*PublisherModel_CallToAction_Deploy) GetLargeModelReference added in v1.44.0

func (x *PublisherModel_CallToAction_Deploy) GetLargeModelReference() *LargeModelReference

func (*PublisherModel_CallToAction_Deploy) GetModelDisplayName added in v1.44.0

func (x *PublisherModel_CallToAction_Deploy) GetModelDisplayName() string

func (*PublisherModel_CallToAction_Deploy) GetPredictionResources added in v1.44.0

func (m *PublisherModel_CallToAction_Deploy) GetPredictionResources() isPublisherModel_CallToAction_Deploy_PredictionResources

func (*PublisherModel_CallToAction_Deploy) GetPublicArtifactUri added in v1.57.0

func (x *PublisherModel_CallToAction_Deploy) GetPublicArtifactUri() string

func (*PublisherModel_CallToAction_Deploy) GetSharedResources added in v1.44.0

func (x *PublisherModel_CallToAction_Deploy) GetSharedResources() string

func (*PublisherModel_CallToAction_Deploy) GetTitle added in v1.44.0

func (*PublisherModel_CallToAction_Deploy) ProtoMessage added in v1.44.0

func (*PublisherModel_CallToAction_Deploy) ProtoMessage()

func (*PublisherModel_CallToAction_Deploy) ProtoReflect added in v1.44.0

func (*PublisherModel_CallToAction_Deploy) Reset added in v1.44.0

func (*PublisherModel_CallToAction_Deploy) String added in v1.44.0

type PublisherModel_CallToAction_DeployGke added in v1.60.0

type PublisherModel_CallToAction_DeployGke struct {

	// Optional. GKE deployment configuration in yaml format.
	GkeYamlConfigs []string `protobuf:"bytes,1,rep,name=gke_yaml_configs,json=gkeYamlConfigs,proto3" json:"gke_yaml_configs,omitempty"`
	// contains filtered or unexported fields
}

Configurations for PublisherModel GKE deployment

func (*PublisherModel_CallToAction_DeployGke) Descriptor deprecated added in v1.60.0

func (*PublisherModel_CallToAction_DeployGke) Descriptor() ([]byte, []int)

Deprecated: Use PublisherModel_CallToAction_DeployGke.ProtoReflect.Descriptor instead.

func (*PublisherModel_CallToAction_DeployGke) GetGkeYamlConfigs added in v1.60.0

func (x *PublisherModel_CallToAction_DeployGke) GetGkeYamlConfigs() []string

func (*PublisherModel_CallToAction_DeployGke) ProtoMessage added in v1.60.0

func (*PublisherModel_CallToAction_DeployGke) ProtoMessage()

func (*PublisherModel_CallToAction_DeployGke) ProtoReflect added in v1.60.0

func (*PublisherModel_CallToAction_DeployGke) Reset added in v1.60.0

func (*PublisherModel_CallToAction_DeployGke) String added in v1.60.0

type PublisherModel_CallToAction_Deploy_AutomaticResources added in v1.44.0

type PublisherModel_CallToAction_Deploy_AutomaticResources struct {
	// A description of resources that to large degree are decided by Vertex
	// AI, and require only a modest additional configuration.
	AutomaticResources *AutomaticResources `protobuf:"bytes,6,opt,name=automatic_resources,json=automaticResources,proto3,oneof"`
}

type PublisherModel_CallToAction_Deploy_DedicatedResources added in v1.44.0

type PublisherModel_CallToAction_Deploy_DedicatedResources struct {
	// A description of resources that are dedicated to the DeployedModel,
	// and that need a higher degree of manual configuration.
	DedicatedResources *DedicatedResources `protobuf:"bytes,5,opt,name=dedicated_resources,json=dedicatedResources,proto3,oneof"`
}

type PublisherModel_CallToAction_Deploy_SharedResources added in v1.44.0

type PublisherModel_CallToAction_Deploy_SharedResources struct {
	// The resource name of the shared DeploymentResourcePool to deploy on.
	// Format:
	// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
	SharedResources string `protobuf:"bytes,7,opt,name=shared_resources,json=sharedResources,proto3,oneof"`
}

type PublisherModel_CallToAction_OpenFineTuningPipelines added in v1.60.0

type PublisherModel_CallToAction_OpenFineTuningPipelines struct {

	// Required. Regional resource references to fine tuning pipelines.
	FineTuningPipelines []*PublisherModel_CallToAction_RegionalResourceReferences `protobuf:"bytes,1,rep,name=fine_tuning_pipelines,json=fineTuningPipelines,proto3" json:"fine_tuning_pipelines,omitempty"`
	// contains filtered or unexported fields
}

Open fine tuning pipelines.

func (*PublisherModel_CallToAction_OpenFineTuningPipelines) Descriptor deprecated added in v1.60.0

Deprecated: Use PublisherModel_CallToAction_OpenFineTuningPipelines.ProtoReflect.Descriptor instead.

func (*PublisherModel_CallToAction_OpenFineTuningPipelines) GetFineTuningPipelines added in v1.60.0

func (*PublisherModel_CallToAction_OpenFineTuningPipelines) ProtoMessage added in v1.60.0

func (*PublisherModel_CallToAction_OpenFineTuningPipelines) ProtoReflect added in v1.60.0

func (*PublisherModel_CallToAction_OpenFineTuningPipelines) Reset added in v1.60.0

func (*PublisherModel_CallToAction_OpenFineTuningPipelines) String added in v1.60.0

type PublisherModel_CallToAction_OpenNotebooks added in v1.60.0

type PublisherModel_CallToAction_OpenNotebooks struct {

	// Required. Regional resource references to notebooks.
	Notebooks []*PublisherModel_CallToAction_RegionalResourceReferences `protobuf:"bytes,1,rep,name=notebooks,proto3" json:"notebooks,omitempty"`
	// contains filtered or unexported fields
}

Open notebooks.

func (*PublisherModel_CallToAction_OpenNotebooks) Descriptor deprecated added in v1.60.0

func (*PublisherModel_CallToAction_OpenNotebooks) Descriptor() ([]byte, []int)

Deprecated: Use PublisherModel_CallToAction_OpenNotebooks.ProtoReflect.Descriptor instead.

func (*PublisherModel_CallToAction_OpenNotebooks) GetNotebooks added in v1.60.0

func (*PublisherModel_CallToAction_OpenNotebooks) ProtoMessage added in v1.60.0

func (*PublisherModel_CallToAction_OpenNotebooks) ProtoReflect added in v1.60.0

func (*PublisherModel_CallToAction_OpenNotebooks) Reset added in v1.60.0

func (*PublisherModel_CallToAction_OpenNotebooks) String added in v1.60.0

type PublisherModel_CallToAction_RegionalResourceReferences added in v1.44.0

type PublisherModel_CallToAction_RegionalResourceReferences struct {

	// Required.
	References map[string]*PublisherModel_ResourceReference `` /* 161-byte string literal not displayed */
	// Required.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// Optional. Title of the resource.
	ResourceTitle *string `protobuf:"bytes,3,opt,name=resource_title,json=resourceTitle,proto3,oneof" json:"resource_title,omitempty"`
	// Optional. Use case (CUJ) of the resource.
	ResourceUseCase *string `protobuf:"bytes,4,opt,name=resource_use_case,json=resourceUseCase,proto3,oneof" json:"resource_use_case,omitempty"`
	// Optional. Description of the resource.
	ResourceDescription *string `protobuf:"bytes,5,opt,name=resource_description,json=resourceDescription,proto3,oneof" json:"resource_description,omitempty"`
	// contains filtered or unexported fields
}

The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc..

func (*PublisherModel_CallToAction_RegionalResourceReferences) Descriptor deprecated added in v1.44.0

Deprecated: Use PublisherModel_CallToAction_RegionalResourceReferences.ProtoReflect.Descriptor instead.

func (*PublisherModel_CallToAction_RegionalResourceReferences) GetReferences added in v1.44.0

func (*PublisherModel_CallToAction_RegionalResourceReferences) GetResourceDescription added in v1.60.0

func (*PublisherModel_CallToAction_RegionalResourceReferences) GetResourceTitle added in v1.60.0

func (*PublisherModel_CallToAction_RegionalResourceReferences) GetResourceUseCase added in v1.60.0

func (*PublisherModel_CallToAction_RegionalResourceReferences) GetTitle added in v1.44.0

func (*PublisherModel_CallToAction_RegionalResourceReferences) ProtoMessage added in v1.44.0

func (*PublisherModel_CallToAction_RegionalResourceReferences) ProtoReflect added in v1.44.0

func (*PublisherModel_CallToAction_RegionalResourceReferences) Reset added in v1.44.0

func (*PublisherModel_CallToAction_RegionalResourceReferences) String added in v1.44.0

type PublisherModel_CallToAction_ViewRestApi added in v1.44.0

type PublisherModel_CallToAction_ViewRestApi struct {

	// Required.
	Documentations []*PublisherModel_Documentation `protobuf:"bytes,1,rep,name=documentations,proto3" json:"documentations,omitempty"`
	// Required. The title of the view rest API.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// contains filtered or unexported fields
}

Rest API docs.

func (*PublisherModel_CallToAction_ViewRestApi) Descriptor deprecated added in v1.44.0

func (*PublisherModel_CallToAction_ViewRestApi) Descriptor() ([]byte, []int)

Deprecated: Use PublisherModel_CallToAction_ViewRestApi.ProtoReflect.Descriptor instead.

func (*PublisherModel_CallToAction_ViewRestApi) GetDocumentations added in v1.44.0

func (*PublisherModel_CallToAction_ViewRestApi) GetTitle added in v1.44.0

func (*PublisherModel_CallToAction_ViewRestApi) ProtoMessage added in v1.44.0

func (*PublisherModel_CallToAction_ViewRestApi) ProtoReflect added in v1.44.0

func (*PublisherModel_CallToAction_ViewRestApi) Reset added in v1.44.0

func (*PublisherModel_CallToAction_ViewRestApi) String added in v1.44.0

type PublisherModel_Documentation added in v1.44.0

type PublisherModel_Documentation struct {

	// Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA,
	// NODE.JS, etc..
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	// Required. Content of this piece of document (in Markdown format).
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

A named piece of documentation.

func (*PublisherModel_Documentation) Descriptor deprecated added in v1.44.0

func (*PublisherModel_Documentation) Descriptor() ([]byte, []int)

Deprecated: Use PublisherModel_Documentation.ProtoReflect.Descriptor instead.

func (*PublisherModel_Documentation) GetContent added in v1.44.0

func (x *PublisherModel_Documentation) GetContent() string

func (*PublisherModel_Documentation) GetTitle added in v1.44.0

func (x *PublisherModel_Documentation) GetTitle() string

func (*PublisherModel_Documentation) ProtoMessage added in v1.44.0

func (*PublisherModel_Documentation) ProtoMessage()

func (*PublisherModel_Documentation) ProtoReflect added in v1.44.0

func (*PublisherModel_Documentation) Reset added in v1.44.0

func (x *PublisherModel_Documentation) Reset()

func (*PublisherModel_Documentation) String added in v1.44.0

type PublisherModel_LaunchStage added in v1.44.0

type PublisherModel_LaunchStage int32

An enum representing the launch stage of a PublisherModel.

const (
	// The model launch stage is unspecified.
	PublisherModel_LAUNCH_STAGE_UNSPECIFIED PublisherModel_LaunchStage = 0
	// Used to indicate the PublisherModel is at Experimental launch stage,
	// available to a small set of customers.
	PublisherModel_EXPERIMENTAL PublisherModel_LaunchStage = 1
	// Used to indicate the PublisherModel is at Private Preview launch stage,
	// only available to a small set of customers, although a larger set of
	// customers than an Experimental launch. Previews are the first launch
	// stage used to get feedback from customers.
	PublisherModel_PRIVATE_PREVIEW PublisherModel_LaunchStage = 2
	// Used to indicate the PublisherModel is at Public Preview launch stage,
	// available to all customers, although not supported for production
	// workloads.
	PublisherModel_PUBLIC_PREVIEW PublisherModel_LaunchStage = 3
	// Used to indicate the PublisherModel is at GA launch stage, available to
	// all customers and ready for production workload.
	PublisherModel_GA PublisherModel_LaunchStage = 4
)

func (PublisherModel_LaunchStage) Descriptor added in v1.44.0

func (PublisherModel_LaunchStage) Enum added in v1.44.0

func (PublisherModel_LaunchStage) EnumDescriptor deprecated added in v1.44.0

func (PublisherModel_LaunchStage) EnumDescriptor() ([]byte, []int)

Deprecated: Use PublisherModel_LaunchStage.Descriptor instead.

func (PublisherModel_LaunchStage) Number added in v1.44.0

func (PublisherModel_LaunchStage) String added in v1.44.0

func (PublisherModel_LaunchStage) Type added in v1.44.0

type PublisherModel_OpenSourceCategory added in v1.44.0

type PublisherModel_OpenSourceCategory int32

An enum representing the open source category of a PublisherModel.

const (
	// The open source category is unspecified, which should not be used.
	PublisherModel_OPEN_SOURCE_CATEGORY_UNSPECIFIED PublisherModel_OpenSourceCategory = 0
	// Used to indicate the PublisherModel is not open sourced.
	PublisherModel_PROPRIETARY PublisherModel_OpenSourceCategory = 1
	// Used to indicate the PublisherModel is a Google-owned open source model
	// w/ Google checkpoint.
	PublisherModel_GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT PublisherModel_OpenSourceCategory = 2
	// Used to indicate the PublisherModel is a 3p-owned open source model w/
	// Google checkpoint.
	PublisherModel_THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT PublisherModel_OpenSourceCategory = 3
	// Used to indicate the PublisherModel is a Google-owned pure open source
	// model.
	PublisherModel_GOOGLE_OWNED_OSS PublisherModel_OpenSourceCategory = 4
	// Used to indicate the PublisherModel is a 3p-owned pure open source model.
	PublisherModel_THIRD_PARTY_OWNED_OSS PublisherModel_OpenSourceCategory = 5
)

func (PublisherModel_OpenSourceCategory) Descriptor added in v1.44.0

func (PublisherModel_OpenSourceCategory) Enum added in v1.44.0

func (PublisherModel_OpenSourceCategory) EnumDescriptor deprecated added in v1.44.0

func (PublisherModel_OpenSourceCategory) EnumDescriptor() ([]byte, []int)

Deprecated: Use PublisherModel_OpenSourceCategory.Descriptor instead.

func (PublisherModel_OpenSourceCategory) Number added in v1.44.0

func (PublisherModel_OpenSourceCategory) String added in v1.44.0

func (PublisherModel_OpenSourceCategory) Type added in v1.44.0

type PublisherModel_ResourceReference added in v1.44.0

type PublisherModel_ResourceReference struct {

	// Types that are assignable to Reference:
	//
	//	*PublisherModel_ResourceReference_Uri
	//	*PublisherModel_ResourceReference_ResourceName
	//	*PublisherModel_ResourceReference_UseCase
	//	*PublisherModel_ResourceReference_Description
	Reference isPublisherModel_ResourceReference_Reference `protobuf_oneof:"reference"`
	// contains filtered or unexported fields
}

Reference to a resource.

func (*PublisherModel_ResourceReference) Descriptor deprecated added in v1.44.0

func (*PublisherModel_ResourceReference) Descriptor() ([]byte, []int)

Deprecated: Use PublisherModel_ResourceReference.ProtoReflect.Descriptor instead.

func (*PublisherModel_ResourceReference) GetDescription deprecated added in v1.57.0

func (x *PublisherModel_ResourceReference) GetDescription() string

Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/publisher_model.proto.

func (*PublisherModel_ResourceReference) GetReference added in v1.44.0

func (m *PublisherModel_ResourceReference) GetReference() isPublisherModel_ResourceReference_Reference

func (*PublisherModel_ResourceReference) GetResourceName added in v1.44.0

func (x *PublisherModel_ResourceReference) GetResourceName() string

func (*PublisherModel_ResourceReference) GetUri added in v1.44.0

func (*PublisherModel_ResourceReference) GetUseCase deprecated added in v1.57.0

func (x *PublisherModel_ResourceReference) GetUseCase() string

Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/publisher_model.proto.

func (*PublisherModel_ResourceReference) ProtoMessage added in v1.44.0

func (*PublisherModel_ResourceReference) ProtoMessage()

func (*PublisherModel_ResourceReference) ProtoReflect added in v1.44.0

func (*PublisherModel_ResourceReference) Reset added in v1.44.0

func (*PublisherModel_ResourceReference) String added in v1.44.0

type PublisherModel_ResourceReference_Description added in v1.57.0

type PublisherModel_ResourceReference_Description struct {
	// Description of the resource.
	//
	// Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/publisher_model.proto.
	Description string `protobuf:"bytes,4,opt,name=description,proto3,oneof"`
}

type PublisherModel_ResourceReference_ResourceName added in v1.44.0

type PublisherModel_ResourceReference_ResourceName struct {
	// The resource name of the Google Cloud resource.
	ResourceName string `protobuf:"bytes,2,opt,name=resource_name,json=resourceName,proto3,oneof"`
}

type PublisherModel_ResourceReference_Uri added in v1.44.0

type PublisherModel_ResourceReference_Uri struct {
	// The URI of the resource.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3,oneof"`
}

type PublisherModel_ResourceReference_UseCase added in v1.57.0

type PublisherModel_ResourceReference_UseCase struct {
	// Use case (CUJ) of the resource.
	//
	// Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/publisher_model.proto.
	UseCase string `protobuf:"bytes,3,opt,name=use_case,json=useCase,proto3,oneof"`
}

type PublisherModel_VersionState added in v1.57.0

type PublisherModel_VersionState int32

An enum representing the state of the PublicModelVersion.

const (
	// The version state is unspecified.
	PublisherModel_VERSION_STATE_UNSPECIFIED PublisherModel_VersionState = 0
	// Used to indicate the version is stable.
	PublisherModel_VERSION_STATE_STABLE PublisherModel_VersionState = 1
	// Used to indicate the version is unstable.
	PublisherModel_VERSION_STATE_UNSTABLE PublisherModel_VersionState = 2
)

func (PublisherModel_VersionState) Descriptor added in v1.57.0

func (PublisherModel_VersionState) Enum added in v1.57.0

func (PublisherModel_VersionState) EnumDescriptor deprecated added in v1.57.0

func (PublisherModel_VersionState) EnumDescriptor() ([]byte, []int)

Deprecated: Use PublisherModel_VersionState.Descriptor instead.

func (PublisherModel_VersionState) Number added in v1.57.0

func (PublisherModel_VersionState) String added in v1.57.0

func (PublisherModel_VersionState) Type added in v1.57.0

type PurgeArtifactsMetadata

type PurgeArtifactsMetadata struct {

	// Operation metadata for purging Artifacts.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts].

func (*PurgeArtifactsMetadata) Descriptor deprecated

func (*PurgeArtifactsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use PurgeArtifactsMetadata.ProtoReflect.Descriptor instead.

func (*PurgeArtifactsMetadata) GetGenericMetadata

func (x *PurgeArtifactsMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*PurgeArtifactsMetadata) ProtoMessage

func (*PurgeArtifactsMetadata) ProtoMessage()

func (*PurgeArtifactsMetadata) ProtoReflect

func (x *PurgeArtifactsMetadata) ProtoReflect() protoreflect.Message

func (*PurgeArtifactsMetadata) Reset

func (x *PurgeArtifactsMetadata) Reset()

func (*PurgeArtifactsMetadata) String

func (x *PurgeArtifactsMetadata) String() string

type PurgeArtifactsRequest

type PurgeArtifactsRequest struct {

	// Required. The metadata store to purge Artifacts from.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. A required filter matching the Artifacts to be purged.
	// E.g., `update_time <= 2020-11-19T11:30:00-04:00`.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Flag to indicate to actually perform the purge.
	// If `force` is set to false, the method will return a sample of
	// Artifact names that would be deleted.
	Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts].

func (*PurgeArtifactsRequest) Descriptor deprecated

func (*PurgeArtifactsRequest) Descriptor() ([]byte, []int)

Deprecated: Use PurgeArtifactsRequest.ProtoReflect.Descriptor instead.

func (*PurgeArtifactsRequest) GetFilter

func (x *PurgeArtifactsRequest) GetFilter() string

func (*PurgeArtifactsRequest) GetForce

func (x *PurgeArtifactsRequest) GetForce() bool

func (*PurgeArtifactsRequest) GetParent

func (x *PurgeArtifactsRequest) GetParent() string

func (*PurgeArtifactsRequest) ProtoMessage

func (*PurgeArtifactsRequest) ProtoMessage()

func (*PurgeArtifactsRequest) ProtoReflect

func (x *PurgeArtifactsRequest) ProtoReflect() protoreflect.Message

func (*PurgeArtifactsRequest) Reset

func (x *PurgeArtifactsRequest) Reset()

func (*PurgeArtifactsRequest) String

func (x *PurgeArtifactsRequest) String() string

type PurgeArtifactsResponse

type PurgeArtifactsResponse struct {

	// The number of Artifacts that this request deleted (or, if `force` is false,
	// the number of Artifacts that will be deleted). This can be an estimate.
	PurgeCount int64 `protobuf:"varint,1,opt,name=purge_count,json=purgeCount,proto3" json:"purge_count,omitempty"`
	// A sample of the Artifact names that will be deleted.
	// Only populated if `force` is set to false. The maximum number of samples is
	// 100 (it is possible to return fewer).
	PurgeSample []string `protobuf:"bytes,2,rep,name=purge_sample,json=purgeSample,proto3" json:"purge_sample,omitempty"`
	// contains filtered or unexported fields
}

Response message for [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts].

func (*PurgeArtifactsResponse) Descriptor deprecated

func (*PurgeArtifactsResponse) Descriptor() ([]byte, []int)

Deprecated: Use PurgeArtifactsResponse.ProtoReflect.Descriptor instead.

func (*PurgeArtifactsResponse) GetPurgeCount

func (x *PurgeArtifactsResponse) GetPurgeCount() int64

func (*PurgeArtifactsResponse) GetPurgeSample

func (x *PurgeArtifactsResponse) GetPurgeSample() []string

func (*PurgeArtifactsResponse) ProtoMessage

func (*PurgeArtifactsResponse) ProtoMessage()

func (*PurgeArtifactsResponse) ProtoReflect

func (x *PurgeArtifactsResponse) ProtoReflect() protoreflect.Message

func (*PurgeArtifactsResponse) Reset

func (x *PurgeArtifactsResponse) Reset()

func (*PurgeArtifactsResponse) String

func (x *PurgeArtifactsResponse) String() string

type PurgeContextsMetadata

type PurgeContextsMetadata struct {

	// Operation metadata for purging Contexts.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts].

func (*PurgeContextsMetadata) Descriptor deprecated

func (*PurgeContextsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use PurgeContextsMetadata.ProtoReflect.Descriptor instead.

func (*PurgeContextsMetadata) GetGenericMetadata

func (x *PurgeContextsMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*PurgeContextsMetadata) ProtoMessage

func (*PurgeContextsMetadata) ProtoMessage()

func (*PurgeContextsMetadata) ProtoReflect

func (x *PurgeContextsMetadata) ProtoReflect() protoreflect.Message

func (*PurgeContextsMetadata) Reset

func (x *PurgeContextsMetadata) Reset()

func (*PurgeContextsMetadata) String

func (x *PurgeContextsMetadata) String() string

type PurgeContextsRequest

type PurgeContextsRequest struct {

	// Required. The metadata store to purge Contexts from.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. A required filter matching the Contexts to be purged.
	// E.g., `update_time <= 2020-11-19T11:30:00-04:00`.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Flag to indicate to actually perform the purge.
	// If `force` is set to false, the method will return a sample of
	// Context names that would be deleted.
	Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts].

func (*PurgeContextsRequest) Descriptor deprecated

func (*PurgeContextsRequest) Descriptor() ([]byte, []int)

Deprecated: Use PurgeContextsRequest.ProtoReflect.Descriptor instead.

func (*PurgeContextsRequest) GetFilter

func (x *PurgeContextsRequest) GetFilter() string

func (*PurgeContextsRequest) GetForce

func (x *PurgeContextsRequest) GetForce() bool

func (*PurgeContextsRequest) GetParent

func (x *PurgeContextsRequest) GetParent() string

func (*PurgeContextsRequest) ProtoMessage

func (*PurgeContextsRequest) ProtoMessage()

func (*PurgeContextsRequest) ProtoReflect

func (x *PurgeContextsRequest) ProtoReflect() protoreflect.Message

func (*PurgeContextsRequest) Reset

func (x *PurgeContextsRequest) Reset()

func (*PurgeContextsRequest) String

func (x *PurgeContextsRequest) String() string

type PurgeContextsResponse

type PurgeContextsResponse struct {

	// The number of Contexts that this request deleted (or, if `force` is false,
	// the number of Contexts that will be deleted). This can be an estimate.
	PurgeCount int64 `protobuf:"varint,1,opt,name=purge_count,json=purgeCount,proto3" json:"purge_count,omitempty"`
	// A sample of the Context names that will be deleted.
	// Only populated if `force` is set to false. The maximum number of samples is
	// 100 (it is possible to return fewer).
	PurgeSample []string `protobuf:"bytes,2,rep,name=purge_sample,json=purgeSample,proto3" json:"purge_sample,omitempty"`
	// contains filtered or unexported fields
}

Response message for [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts].

func (*PurgeContextsResponse) Descriptor deprecated

func (*PurgeContextsResponse) Descriptor() ([]byte, []int)

Deprecated: Use PurgeContextsResponse.ProtoReflect.Descriptor instead.

func (*PurgeContextsResponse) GetPurgeCount

func (x *PurgeContextsResponse) GetPurgeCount() int64

func (*PurgeContextsResponse) GetPurgeSample

func (x *PurgeContextsResponse) GetPurgeSample() []string

func (*PurgeContextsResponse) ProtoMessage

func (*PurgeContextsResponse) ProtoMessage()

func (*PurgeContextsResponse) ProtoReflect

func (x *PurgeContextsResponse) ProtoReflect() protoreflect.Message

func (*PurgeContextsResponse) Reset

func (x *PurgeContextsResponse) Reset()

func (*PurgeContextsResponse) String

func (x *PurgeContextsResponse) String() string

type PurgeExecutionsMetadata

type PurgeExecutionsMetadata struct {

	// Operation metadata for purging Executions.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions].

func (*PurgeExecutionsMetadata) Descriptor deprecated

func (*PurgeExecutionsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use PurgeExecutionsMetadata.ProtoReflect.Descriptor instead.

func (*PurgeExecutionsMetadata) GetGenericMetadata

func (x *PurgeExecutionsMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*PurgeExecutionsMetadata) ProtoMessage

func (*PurgeExecutionsMetadata) ProtoMessage()

func (*PurgeExecutionsMetadata) ProtoReflect

func (x *PurgeExecutionsMetadata) ProtoReflect() protoreflect.Message

func (*PurgeExecutionsMetadata) Reset

func (x *PurgeExecutionsMetadata) Reset()

func (*PurgeExecutionsMetadata) String

func (x *PurgeExecutionsMetadata) String() string

type PurgeExecutionsRequest

type PurgeExecutionsRequest struct {

	// Required. The metadata store to purge Executions from.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. A required filter matching the Executions to be purged.
	// E.g., `update_time <= 2020-11-19T11:30:00-04:00`.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Flag to indicate to actually perform the purge.
	// If `force` is set to false, the method will return a sample of
	// Execution names that would be deleted.
	Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions].

func (*PurgeExecutionsRequest) Descriptor deprecated

func (*PurgeExecutionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use PurgeExecutionsRequest.ProtoReflect.Descriptor instead.

func (*PurgeExecutionsRequest) GetFilter

func (x *PurgeExecutionsRequest) GetFilter() string

func (*PurgeExecutionsRequest) GetForce

func (x *PurgeExecutionsRequest) GetForce() bool

func (*PurgeExecutionsRequest) GetParent

func (x *PurgeExecutionsRequest) GetParent() string

func (*PurgeExecutionsRequest) ProtoMessage

func (*PurgeExecutionsRequest) ProtoMessage()

func (*PurgeExecutionsRequest) ProtoReflect

func (x *PurgeExecutionsRequest) ProtoReflect() protoreflect.Message

func (*PurgeExecutionsRequest) Reset

func (x *PurgeExecutionsRequest) Reset()

func (*PurgeExecutionsRequest) String

func (x *PurgeExecutionsRequest) String() string

type PurgeExecutionsResponse

type PurgeExecutionsResponse struct {

	// The number of Executions that this request deleted (or, if `force` is
	// false, the number of Executions that will be deleted). This can be an
	// estimate.
	PurgeCount int64 `protobuf:"varint,1,opt,name=purge_count,json=purgeCount,proto3" json:"purge_count,omitempty"`
	// A sample of the Execution names that will be deleted.
	// Only populated if `force` is set to false. The maximum number of samples is
	// 100 (it is possible to return fewer).
	PurgeSample []string `protobuf:"bytes,2,rep,name=purge_sample,json=purgeSample,proto3" json:"purge_sample,omitempty"`
	// contains filtered or unexported fields
}

Response message for [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions].

func (*PurgeExecutionsResponse) Descriptor deprecated

func (*PurgeExecutionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use PurgeExecutionsResponse.ProtoReflect.Descriptor instead.

func (*PurgeExecutionsResponse) GetPurgeCount

func (x *PurgeExecutionsResponse) GetPurgeCount() int64

func (*PurgeExecutionsResponse) GetPurgeSample

func (x *PurgeExecutionsResponse) GetPurgeSample() []string

func (*PurgeExecutionsResponse) ProtoMessage

func (*PurgeExecutionsResponse) ProtoMessage()

func (*PurgeExecutionsResponse) ProtoReflect

func (x *PurgeExecutionsResponse) ProtoReflect() protoreflect.Message

func (*PurgeExecutionsResponse) Reset

func (x *PurgeExecutionsResponse) Reset()

func (*PurgeExecutionsResponse) String

func (x *PurgeExecutionsResponse) String() string

type PythonPackageSpec

type PythonPackageSpec struct {

	// Required. The URI of a container image in Artifact Registry that will run
	// the provided Python package. Vertex AI provides a wide range of executor
	// images with pre-installed packages to meet users' various use cases. See
	// the list of [pre-built containers for
	// training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
	// You must use an image from this list.
	ExecutorImageUri string `protobuf:"bytes,1,opt,name=executor_image_uri,json=executorImageUri,proto3" json:"executor_image_uri,omitempty"`
	// Required. The Google Cloud Storage location of the Python package files
	// which are the training program and its dependent packages. The maximum
	// number of package URIs is 100.
	PackageUris []string `protobuf:"bytes,2,rep,name=package_uris,json=packageUris,proto3" json:"package_uris,omitempty"`
	// Required. The Python module name to run after installing the packages.
	PythonModule string `protobuf:"bytes,3,opt,name=python_module,json=pythonModule,proto3" json:"python_module,omitempty"`
	// Command line arguments to be passed to the Python task.
	Args []string `protobuf:"bytes,4,rep,name=args,proto3" json:"args,omitempty"`
	// Environment variables to be passed to the python module.
	// Maximum limit is 100.
	Env []*EnvVar `protobuf:"bytes,5,rep,name=env,proto3" json:"env,omitempty"`
	// contains filtered or unexported fields
}

The spec of a Python packaged code.

func (*PythonPackageSpec) Descriptor deprecated

func (*PythonPackageSpec) Descriptor() ([]byte, []int)

Deprecated: Use PythonPackageSpec.ProtoReflect.Descriptor instead.

func (*PythonPackageSpec) GetArgs

func (x *PythonPackageSpec) GetArgs() []string

func (*PythonPackageSpec) GetEnv

func (x *PythonPackageSpec) GetEnv() []*EnvVar

func (*PythonPackageSpec) GetExecutorImageUri

func (x *PythonPackageSpec) GetExecutorImageUri() string

func (*PythonPackageSpec) GetPackageUris

func (x *PythonPackageSpec) GetPackageUris() []string

func (*PythonPackageSpec) GetPythonModule

func (x *PythonPackageSpec) GetPythonModule() string

func (*PythonPackageSpec) ProtoMessage

func (*PythonPackageSpec) ProtoMessage()

func (*PythonPackageSpec) ProtoReflect

func (x *PythonPackageSpec) ProtoReflect() protoreflect.Message

func (*PythonPackageSpec) Reset

func (x *PythonPackageSpec) Reset()

func (*PythonPackageSpec) String

func (x *PythonPackageSpec) String() string

type QueryArtifactLineageSubgraphRequest

type QueryArtifactLineageSubgraphRequest struct {

	// Required. The resource name of the Artifact whose Lineage needs to be
	// retrieved as a LineageSubgraph. Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
	//
	// The request may error with FAILED_PRECONDITION if the number of Artifacts,
	// the number of Executions, or the number of Events that would be returned
	// for the Context exceeds 1000.
	Artifact string `protobuf:"bytes,1,opt,name=artifact,proto3" json:"artifact,omitempty"`
	// Specifies the size of the lineage graph in terms of number of hops from the
	// specified artifact.
	// Negative Value: INVALID_ARGUMENT error is returned
	// 0: Only input artifact is returned.
	// No value: Transitive closure is performed to return the complete graph.
	MaxHops int32 `protobuf:"varint,2,opt,name=max_hops,json=maxHops,proto3" json:"max_hops,omitempty"`
	// Filter specifying the boolean condition for the Artifacts to satisfy in
	// order to be part of the Lineage Subgraph.
	// The syntax to define filter query is based on https://google.aip.dev/160.
	// The supported set of filters include the following:
	//
	//   - **Attribute filtering**:
	//     For example: `display_name = "test"`
	//     Supported fields include: `name`, `display_name`, `uri`, `state`,
	//     `schema_title`, `create_time`, and `update_time`.
	//     Time fields, such as `create_time` and `update_time`, require values
	//     specified in RFC-3339 format.
	//     For example: `create_time = "2020-11-19T11:30:00-04:00"`
	//   - **Metadata field**:
	//     To filter on metadata fields use traversal operation as follows:
	//     `metadata.<field_name>.<type_value>`.
	//     For example: `metadata.field_1.number_value = 10.0`
	//     In case the field name contains special characters (such as colon), one
	//     can embed it inside double quote.
	//     For example: `metadata."field:1".number_value = 10.0`
	//
	// Each of the above supported filter types can be combined together using
	// logical operators (`AND` & `OR`). Maximum nested expression depth allowed
	// is 5.
	//
	// For example: `display_name = "test" AND metadata.field1.bool_value = true`.
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.QueryArtifactLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryArtifactLineageSubgraph].

func (*QueryArtifactLineageSubgraphRequest) Descriptor deprecated

func (*QueryArtifactLineageSubgraphRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryArtifactLineageSubgraphRequest.ProtoReflect.Descriptor instead.

func (*QueryArtifactLineageSubgraphRequest) GetArtifact

func (*QueryArtifactLineageSubgraphRequest) GetFilter

func (*QueryArtifactLineageSubgraphRequest) GetMaxHops

func (*QueryArtifactLineageSubgraphRequest) ProtoMessage

func (*QueryArtifactLineageSubgraphRequest) ProtoMessage()

func (*QueryArtifactLineageSubgraphRequest) ProtoReflect

func (*QueryArtifactLineageSubgraphRequest) Reset

func (*QueryArtifactLineageSubgraphRequest) String

type QueryContextLineageSubgraphRequest

type QueryContextLineageSubgraphRequest struct {

	// Required. The resource name of the Context whose Artifacts and Executions
	// should be retrieved as a LineageSubgraph.
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
	//
	// The request may error with FAILED_PRECONDITION if the number of Artifacts,
	// the number of Executions, or the number of Events that would be returned
	// for the Context exceeds 1000.
	Context string `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.QueryContextLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryContextLineageSubgraph].

func (*QueryContextLineageSubgraphRequest) Descriptor deprecated

func (*QueryContextLineageSubgraphRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryContextLineageSubgraphRequest.ProtoReflect.Descriptor instead.

func (*QueryContextLineageSubgraphRequest) GetContext

func (*QueryContextLineageSubgraphRequest) ProtoMessage

func (*QueryContextLineageSubgraphRequest) ProtoMessage()

func (*QueryContextLineageSubgraphRequest) ProtoReflect

func (*QueryContextLineageSubgraphRequest) Reset

func (*QueryContextLineageSubgraphRequest) String

type QueryDeployedModelsRequest added in v1.57.0

type QueryDeployedModelsRequest struct {

	// Required. The name of the target DeploymentResourcePool to query.
	// Format:
	// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
	DeploymentResourcePool string `` /* 129-byte string literal not displayed */
	// The maximum number of DeployedModels to return. The service may return
	// fewer than this value.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `QueryDeployedModels` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// `QueryDeployedModels` must match the call that provided the page
	// token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for QueryDeployedModels method.

func (*QueryDeployedModelsRequest) Descriptor deprecated added in v1.57.0

func (*QueryDeployedModelsRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryDeployedModelsRequest.ProtoReflect.Descriptor instead.

func (*QueryDeployedModelsRequest) GetDeploymentResourcePool added in v1.57.0

func (x *QueryDeployedModelsRequest) GetDeploymentResourcePool() string

func (*QueryDeployedModelsRequest) GetPageSize added in v1.57.0

func (x *QueryDeployedModelsRequest) GetPageSize() int32

func (*QueryDeployedModelsRequest) GetPageToken added in v1.57.0

func (x *QueryDeployedModelsRequest) GetPageToken() string

func (*QueryDeployedModelsRequest) ProtoMessage added in v1.57.0

func (*QueryDeployedModelsRequest) ProtoMessage()

func (*QueryDeployedModelsRequest) ProtoReflect added in v1.57.0

func (*QueryDeployedModelsRequest) Reset added in v1.57.0

func (x *QueryDeployedModelsRequest) Reset()

func (*QueryDeployedModelsRequest) String added in v1.57.0

func (x *QueryDeployedModelsRequest) String() string

type QueryDeployedModelsResponse added in v1.57.0

type QueryDeployedModelsResponse struct {

	// DEPRECATED Use deployed_model_refs instead.
	//
	// Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/deployment_resource_pool_service.proto.
	DeployedModels []*DeployedModel `protobuf:"bytes,1,rep,name=deployed_models,json=deployedModels,proto3" json:"deployed_models,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// References to the DeployedModels that share the specified
	// deploymentResourcePool.
	DeployedModelRefs []*DeployedModelRef `protobuf:"bytes,3,rep,name=deployed_model_refs,json=deployedModelRefs,proto3" json:"deployed_model_refs,omitempty"`
	// The total number of DeployedModels on this DeploymentResourcePool.
	TotalDeployedModelCount int32 `` /* 135-byte string literal not displayed */
	// The total number of Endpoints that have DeployedModels on this
	// DeploymentResourcePool.
	TotalEndpointCount int32 `protobuf:"varint,5,opt,name=total_endpoint_count,json=totalEndpointCount,proto3" json:"total_endpoint_count,omitempty"`
	// contains filtered or unexported fields
}

Response message for QueryDeployedModels method.

func (*QueryDeployedModelsResponse) Descriptor deprecated added in v1.57.0

func (*QueryDeployedModelsResponse) Descriptor() ([]byte, []int)

Deprecated: Use QueryDeployedModelsResponse.ProtoReflect.Descriptor instead.

func (*QueryDeployedModelsResponse) GetDeployedModelRefs added in v1.57.0

func (x *QueryDeployedModelsResponse) GetDeployedModelRefs() []*DeployedModelRef

func (*QueryDeployedModelsResponse) GetDeployedModels deprecated added in v1.57.0

func (x *QueryDeployedModelsResponse) GetDeployedModels() []*DeployedModel

Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/deployment_resource_pool_service.proto.

func (*QueryDeployedModelsResponse) GetNextPageToken added in v1.57.0

func (x *QueryDeployedModelsResponse) GetNextPageToken() string

func (*QueryDeployedModelsResponse) GetTotalDeployedModelCount added in v1.57.0

func (x *QueryDeployedModelsResponse) GetTotalDeployedModelCount() int32

func (*QueryDeployedModelsResponse) GetTotalEndpointCount added in v1.57.0

func (x *QueryDeployedModelsResponse) GetTotalEndpointCount() int32

func (*QueryDeployedModelsResponse) ProtoMessage added in v1.57.0

func (*QueryDeployedModelsResponse) ProtoMessage()

func (*QueryDeployedModelsResponse) ProtoReflect added in v1.57.0

func (*QueryDeployedModelsResponse) Reset added in v1.57.0

func (x *QueryDeployedModelsResponse) Reset()

func (*QueryDeployedModelsResponse) String added in v1.57.0

func (x *QueryDeployedModelsResponse) String() string

type QueryExecutionInputsAndOutputsRequest

type QueryExecutionInputsAndOutputsRequest struct {

	// Required. The resource name of the Execution whose input and output
	// Artifacts should be retrieved as a LineageSubgraph. Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
	Execution string `protobuf:"bytes,1,opt,name=execution,proto3" json:"execution,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.QueryExecutionInputsAndOutputs][google.cloud.aiplatform.v1.MetadataService.QueryExecutionInputsAndOutputs].

func (*QueryExecutionInputsAndOutputsRequest) Descriptor deprecated

func (*QueryExecutionInputsAndOutputsRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryExecutionInputsAndOutputsRequest.ProtoReflect.Descriptor instead.

func (*QueryExecutionInputsAndOutputsRequest) GetExecution

func (*QueryExecutionInputsAndOutputsRequest) ProtoMessage

func (*QueryExecutionInputsAndOutputsRequest) ProtoMessage()

func (*QueryExecutionInputsAndOutputsRequest) ProtoReflect

func (*QueryExecutionInputsAndOutputsRequest) Reset

func (*QueryExecutionInputsAndOutputsRequest) String

type RawPredictRequest

type RawPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// The prediction input. Supports HTTP headers and arbitrary data payload.
	//
	// A [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] may have an
	// upper limit on the number of instances it supports per request. When this
	// limit it is exceeded for an AutoML model, the
	// [RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict]
	// method returns an error. When this limit is exceeded for a custom-trained
	// model, the behavior varies depending on the model.
	//
	// You can specify the schema for each instance in the
	// [predict_schemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
	// field when you create a [Model][google.cloud.aiplatform.v1.Model]. This
	// schema applies when you deploy the `Model` as a `DeployedModel` to an
	// [Endpoint][google.cloud.aiplatform.v1.Endpoint] and use the `RawPredict`
	// method.
	HttpBody *httpbody.HttpBody `protobuf:"bytes,2,opt,name=http_body,json=httpBody,proto3" json:"http_body,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict].

func (*RawPredictRequest) Descriptor deprecated

func (*RawPredictRequest) Descriptor() ([]byte, []int)

Deprecated: Use RawPredictRequest.ProtoReflect.Descriptor instead.

func (*RawPredictRequest) GetEndpoint

func (x *RawPredictRequest) GetEndpoint() string

func (*RawPredictRequest) GetHttpBody

func (x *RawPredictRequest) GetHttpBody() *httpbody.HttpBody

func (*RawPredictRequest) ProtoMessage

func (*RawPredictRequest) ProtoMessage()

func (*RawPredictRequest) ProtoReflect

func (x *RawPredictRequest) ProtoReflect() protoreflect.Message

func (*RawPredictRequest) Reset

func (x *RawPredictRequest) Reset()

func (*RawPredictRequest) String

func (x *RawPredictRequest) String() string

type RaySpec added in v1.67.0

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

Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes.

func (*RaySpec) Descriptor deprecated added in v1.67.0

func (*RaySpec) Descriptor() ([]byte, []int)

Deprecated: Use RaySpec.ProtoReflect.Descriptor instead.

func (*RaySpec) ProtoMessage added in v1.67.0

func (*RaySpec) ProtoMessage()

func (*RaySpec) ProtoReflect added in v1.67.0

func (x *RaySpec) ProtoReflect() protoreflect.Message

func (*RaySpec) Reset added in v1.67.0

func (x *RaySpec) Reset()

func (*RaySpec) String added in v1.67.0

func (x *RaySpec) String() string

type ReadFeatureValuesRequest

type ReadFeatureValuesRequest struct {

	// Required. The resource name of the EntityType for the entity being read.
	// Value format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
	// For example, for a machine learning model predicting user clicks on a
	// website, an EntityType ID could be `user`.
	EntityType string `protobuf:"bytes,1,opt,name=entity_type,json=entityType,proto3" json:"entity_type,omitempty"`
	// Required. ID for a specific entity. For example,
	// for a machine learning model predicting user clicks on a website, an entity
	// ID could be `user_123`.
	EntityId string `protobuf:"bytes,2,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
	// Required. Selector choosing Features of the target EntityType.
	FeatureSelector *FeatureSelector `protobuf:"bytes,3,opt,name=feature_selector,json=featureSelector,proto3" json:"feature_selector,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues].

func (*ReadFeatureValuesRequest) Descriptor deprecated

func (*ReadFeatureValuesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadFeatureValuesRequest.ProtoReflect.Descriptor instead.

func (*ReadFeatureValuesRequest) GetEntityId

func (x *ReadFeatureValuesRequest) GetEntityId() string

func (*ReadFeatureValuesRequest) GetEntityType

func (x *ReadFeatureValuesRequest) GetEntityType() string

func (*ReadFeatureValuesRequest) GetFeatureSelector

func (x *ReadFeatureValuesRequest) GetFeatureSelector() *FeatureSelector

func (*ReadFeatureValuesRequest) ProtoMessage

func (*ReadFeatureValuesRequest) ProtoMessage()

func (*ReadFeatureValuesRequest) ProtoReflect

func (x *ReadFeatureValuesRequest) ProtoReflect() protoreflect.Message

func (*ReadFeatureValuesRequest) Reset

func (x *ReadFeatureValuesRequest) Reset()

func (*ReadFeatureValuesRequest) String

func (x *ReadFeatureValuesRequest) String() string

type ReadFeatureValuesResponse

type ReadFeatureValuesResponse struct {

	// Response header.
	Header *ReadFeatureValuesResponse_Header `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Entity view with Feature values. This may be the entity in the
	// Featurestore if values for all Features were requested, or a projection
	// of the entity in the Featurestore if values for only some Features were
	// requested.
	EntityView *ReadFeatureValuesResponse_EntityView `protobuf:"bytes,2,opt,name=entity_view,json=entityView,proto3" json:"entity_view,omitempty"`
	// contains filtered or unexported fields
}

Response message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues].

func (*ReadFeatureValuesResponse) Descriptor deprecated

func (*ReadFeatureValuesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadFeatureValuesResponse.ProtoReflect.Descriptor instead.

func (*ReadFeatureValuesResponse) GetEntityView

func (*ReadFeatureValuesResponse) GetHeader

func (*ReadFeatureValuesResponse) ProtoMessage

func (*ReadFeatureValuesResponse) ProtoMessage()

func (*ReadFeatureValuesResponse) ProtoReflect

func (*ReadFeatureValuesResponse) Reset

func (x *ReadFeatureValuesResponse) Reset()

func (*ReadFeatureValuesResponse) String

func (x *ReadFeatureValuesResponse) String() string

type ReadFeatureValuesResponse_EntityView

type ReadFeatureValuesResponse_EntityView struct {

	// ID of the requested entity.
	EntityId string `protobuf:"bytes,1,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
	// Each piece of data holds the k
	// requested values for one requested Feature. If no values
	// for the requested Feature exist, the corresponding cell will be empty.
	// This has the same size and is in the same order as the features from the
	// header
	// [ReadFeatureValuesResponse.header][google.cloud.aiplatform.v1.ReadFeatureValuesResponse.header].
	Data []*ReadFeatureValuesResponse_EntityView_Data `protobuf:"bytes,2,rep,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Entity view with Feature values.

func (*ReadFeatureValuesResponse_EntityView) Descriptor deprecated

func (*ReadFeatureValuesResponse_EntityView) Descriptor() ([]byte, []int)

Deprecated: Use ReadFeatureValuesResponse_EntityView.ProtoReflect.Descriptor instead.

func (*ReadFeatureValuesResponse_EntityView) GetData

func (*ReadFeatureValuesResponse_EntityView) GetEntityId

func (*ReadFeatureValuesResponse_EntityView) ProtoMessage

func (*ReadFeatureValuesResponse_EntityView) ProtoMessage()

func (*ReadFeatureValuesResponse_EntityView) ProtoReflect

func (*ReadFeatureValuesResponse_EntityView) Reset

func (*ReadFeatureValuesResponse_EntityView) String

type ReadFeatureValuesResponse_EntityView_Data

type ReadFeatureValuesResponse_EntityView_Data struct {

	// Types that are assignable to Data:
	//
	//	*ReadFeatureValuesResponse_EntityView_Data_Value
	//	*ReadFeatureValuesResponse_EntityView_Data_Values
	Data isReadFeatureValuesResponse_EntityView_Data_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

Container to hold value(s), successive in time, for one Feature from the request.

func (*ReadFeatureValuesResponse_EntityView_Data) Descriptor deprecated

func (*ReadFeatureValuesResponse_EntityView_Data) Descriptor() ([]byte, []int)

Deprecated: Use ReadFeatureValuesResponse_EntityView_Data.ProtoReflect.Descriptor instead.

func (*ReadFeatureValuesResponse_EntityView_Data) GetData

func (m *ReadFeatureValuesResponse_EntityView_Data) GetData() isReadFeatureValuesResponse_EntityView_Data_Data

func (*ReadFeatureValuesResponse_EntityView_Data) GetValue

func (*ReadFeatureValuesResponse_EntityView_Data) GetValues

func (*ReadFeatureValuesResponse_EntityView_Data) ProtoMessage

func (*ReadFeatureValuesResponse_EntityView_Data) ProtoReflect

func (*ReadFeatureValuesResponse_EntityView_Data) Reset

func (*ReadFeatureValuesResponse_EntityView_Data) String

type ReadFeatureValuesResponse_EntityView_Data_Value

type ReadFeatureValuesResponse_EntityView_Data_Value struct {
	// Feature value if a single value is requested.
	Value *FeatureValue `protobuf:"bytes,1,opt,name=value,proto3,oneof"`
}

type ReadFeatureValuesResponse_EntityView_Data_Values

type ReadFeatureValuesResponse_EntityView_Data_Values struct {
	// Feature values list if values, successive in time, are requested.
	// If the requested number of values is greater than the number of
	// existing Feature values, nonexistent values are omitted instead of
	// being returned as empty.
	Values *FeatureValueList `protobuf:"bytes,2,opt,name=values,proto3,oneof"`
}

type ReadFeatureValuesResponse_FeatureDescriptor

type ReadFeatureValuesResponse_FeatureDescriptor struct {

	// Feature ID.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Metadata for requested Features.

func (*ReadFeatureValuesResponse_FeatureDescriptor) Descriptor deprecated

Deprecated: Use ReadFeatureValuesResponse_FeatureDescriptor.ProtoReflect.Descriptor instead.

func (*ReadFeatureValuesResponse_FeatureDescriptor) GetId

func (*ReadFeatureValuesResponse_FeatureDescriptor) ProtoMessage

func (*ReadFeatureValuesResponse_FeatureDescriptor) ProtoReflect

func (*ReadFeatureValuesResponse_FeatureDescriptor) Reset

func (*ReadFeatureValuesResponse_FeatureDescriptor) String

type ReadFeatureValuesResponse_Header

type ReadFeatureValuesResponse_Header struct {

	// The resource name of the EntityType from the
	// [ReadFeatureValuesRequest][google.cloud.aiplatform.v1.ReadFeatureValuesRequest].
	// Value format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
	EntityType string `protobuf:"bytes,1,opt,name=entity_type,json=entityType,proto3" json:"entity_type,omitempty"`
	// List of Feature metadata corresponding to each piece of
	// [ReadFeatureValuesResponse.EntityView.data][google.cloud.aiplatform.v1.ReadFeatureValuesResponse.EntityView.data].
	FeatureDescriptors []*ReadFeatureValuesResponse_FeatureDescriptor `protobuf:"bytes,2,rep,name=feature_descriptors,json=featureDescriptors,proto3" json:"feature_descriptors,omitempty"`
	// contains filtered or unexported fields
}

Response header with metadata for the requested [ReadFeatureValuesRequest.entity_type][google.cloud.aiplatform.v1.ReadFeatureValuesRequest.entity_type] and Features.

func (*ReadFeatureValuesResponse_Header) Descriptor deprecated

func (*ReadFeatureValuesResponse_Header) Descriptor() ([]byte, []int)

Deprecated: Use ReadFeatureValuesResponse_Header.ProtoReflect.Descriptor instead.

func (*ReadFeatureValuesResponse_Header) GetEntityType

func (x *ReadFeatureValuesResponse_Header) GetEntityType() string

func (*ReadFeatureValuesResponse_Header) GetFeatureDescriptors

func (*ReadFeatureValuesResponse_Header) ProtoMessage

func (*ReadFeatureValuesResponse_Header) ProtoMessage()

func (*ReadFeatureValuesResponse_Header) ProtoReflect

func (*ReadFeatureValuesResponse_Header) Reset

func (*ReadFeatureValuesResponse_Header) String

type ReadIndexDatapointsRequest added in v1.43.0

type ReadIndexDatapointsRequest struct {

	// Required. The name of the index endpoint.
	// Format:
	// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
	IndexEndpoint string `protobuf:"bytes,1,opt,name=index_endpoint,json=indexEndpoint,proto3" json:"index_endpoint,omitempty"`
	// The ID of the DeployedIndex that will serve the request.
	DeployedIndexId string `protobuf:"bytes,2,opt,name=deployed_index_id,json=deployedIndexId,proto3" json:"deployed_index_id,omitempty"`
	// IDs of the datapoints to be searched for.
	Ids []string `protobuf:"bytes,3,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

The request message for [MatchService.ReadIndexDatapoints][google.cloud.aiplatform.v1.MatchService.ReadIndexDatapoints].

func (*ReadIndexDatapointsRequest) Descriptor deprecated added in v1.43.0

func (*ReadIndexDatapointsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadIndexDatapointsRequest.ProtoReflect.Descriptor instead.

func (*ReadIndexDatapointsRequest) GetDeployedIndexId added in v1.43.0

func (x *ReadIndexDatapointsRequest) GetDeployedIndexId() string

func (*ReadIndexDatapointsRequest) GetIds added in v1.43.0

func (x *ReadIndexDatapointsRequest) GetIds() []string

func (*ReadIndexDatapointsRequest) GetIndexEndpoint added in v1.43.0

func (x *ReadIndexDatapointsRequest) GetIndexEndpoint() string

func (*ReadIndexDatapointsRequest) ProtoMessage added in v1.43.0

func (*ReadIndexDatapointsRequest) ProtoMessage()

func (*ReadIndexDatapointsRequest) ProtoReflect added in v1.43.0

func (*ReadIndexDatapointsRequest) Reset added in v1.43.0

func (x *ReadIndexDatapointsRequest) Reset()

func (*ReadIndexDatapointsRequest) String added in v1.43.0

func (x *ReadIndexDatapointsRequest) String() string

type ReadIndexDatapointsResponse added in v1.43.0

type ReadIndexDatapointsResponse struct {

	// The result list of datapoints.
	Datapoints []*IndexDatapoint `protobuf:"bytes,1,rep,name=datapoints,proto3" json:"datapoints,omitempty"`
	// contains filtered or unexported fields
}

The response message for [MatchService.ReadIndexDatapoints][google.cloud.aiplatform.v1.MatchService.ReadIndexDatapoints].

func (*ReadIndexDatapointsResponse) Descriptor deprecated added in v1.43.0

func (*ReadIndexDatapointsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadIndexDatapointsResponse.ProtoReflect.Descriptor instead.

func (*ReadIndexDatapointsResponse) GetDatapoints added in v1.43.0

func (x *ReadIndexDatapointsResponse) GetDatapoints() []*IndexDatapoint

func (*ReadIndexDatapointsResponse) ProtoMessage added in v1.43.0

func (*ReadIndexDatapointsResponse) ProtoMessage()

func (*ReadIndexDatapointsResponse) ProtoReflect added in v1.43.0

func (*ReadIndexDatapointsResponse) Reset added in v1.43.0

func (x *ReadIndexDatapointsResponse) Reset()

func (*ReadIndexDatapointsResponse) String added in v1.43.0

func (x *ReadIndexDatapointsResponse) String() string

type ReadTensorboardBlobDataRequest

type ReadTensorboardBlobDataRequest struct {

	// Required. The resource name of the TensorboardTimeSeries to list Blobs.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
	TimeSeries string `protobuf:"bytes,1,opt,name=time_series,json=timeSeries,proto3" json:"time_series,omitempty"`
	// IDs of the blobs to read.
	BlobIds []string `protobuf:"bytes,2,rep,name=blob_ids,json=blobIds,proto3" json:"blob_ids,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData].

func (*ReadTensorboardBlobDataRequest) Descriptor deprecated

func (*ReadTensorboardBlobDataRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadTensorboardBlobDataRequest.ProtoReflect.Descriptor instead.

func (*ReadTensorboardBlobDataRequest) GetBlobIds

func (x *ReadTensorboardBlobDataRequest) GetBlobIds() []string

func (*ReadTensorboardBlobDataRequest) GetTimeSeries

func (x *ReadTensorboardBlobDataRequest) GetTimeSeries() string

func (*ReadTensorboardBlobDataRequest) ProtoMessage

func (*ReadTensorboardBlobDataRequest) ProtoMessage()

func (*ReadTensorboardBlobDataRequest) ProtoReflect

func (*ReadTensorboardBlobDataRequest) Reset

func (x *ReadTensorboardBlobDataRequest) Reset()

func (*ReadTensorboardBlobDataRequest) String

type ReadTensorboardBlobDataResponse

type ReadTensorboardBlobDataResponse struct {

	// Blob messages containing blob bytes.
	Blobs []*TensorboardBlob `protobuf:"bytes,1,rep,name=blobs,proto3" json:"blobs,omitempty"`
	// contains filtered or unexported fields
}

Response message for [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData].

func (*ReadTensorboardBlobDataResponse) Descriptor deprecated

func (*ReadTensorboardBlobDataResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadTensorboardBlobDataResponse.ProtoReflect.Descriptor instead.

func (*ReadTensorboardBlobDataResponse) GetBlobs

func (*ReadTensorboardBlobDataResponse) ProtoMessage

func (*ReadTensorboardBlobDataResponse) ProtoMessage()

func (*ReadTensorboardBlobDataResponse) ProtoReflect

func (*ReadTensorboardBlobDataResponse) Reset

func (*ReadTensorboardBlobDataResponse) String

type ReadTensorboardSizeRequest added in v1.49.0

type ReadTensorboardSizeRequest struct {

	// Required. The name of the Tensorboard resource.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
	Tensorboard string `protobuf:"bytes,1,opt,name=tensorboard,proto3" json:"tensorboard,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.ReadTensorboardSize][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardSize].

func (*ReadTensorboardSizeRequest) Descriptor deprecated added in v1.49.0

func (*ReadTensorboardSizeRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadTensorboardSizeRequest.ProtoReflect.Descriptor instead.

func (*ReadTensorboardSizeRequest) GetTensorboard added in v1.49.0

func (x *ReadTensorboardSizeRequest) GetTensorboard() string

func (*ReadTensorboardSizeRequest) ProtoMessage added in v1.49.0

func (*ReadTensorboardSizeRequest) ProtoMessage()

func (*ReadTensorboardSizeRequest) ProtoReflect added in v1.49.0

func (*ReadTensorboardSizeRequest) Reset added in v1.49.0

func (x *ReadTensorboardSizeRequest) Reset()

func (*ReadTensorboardSizeRequest) String added in v1.49.0

func (x *ReadTensorboardSizeRequest) String() string

type ReadTensorboardSizeResponse added in v1.49.0

type ReadTensorboardSizeResponse struct {

	// Payload storage size for the TensorBoard
	StorageSizeByte int64 `protobuf:"varint,1,opt,name=storage_size_byte,json=storageSizeByte,proto3" json:"storage_size_byte,omitempty"`
	// contains filtered or unexported fields
}

Response message for [TensorboardService.ReadTensorboardSize][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardSize].

func (*ReadTensorboardSizeResponse) Descriptor deprecated added in v1.49.0

func (*ReadTensorboardSizeResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadTensorboardSizeResponse.ProtoReflect.Descriptor instead.

func (*ReadTensorboardSizeResponse) GetStorageSizeByte added in v1.49.0

func (x *ReadTensorboardSizeResponse) GetStorageSizeByte() int64

func (*ReadTensorboardSizeResponse) ProtoMessage added in v1.49.0

func (*ReadTensorboardSizeResponse) ProtoMessage()

func (*ReadTensorboardSizeResponse) ProtoReflect added in v1.49.0

func (*ReadTensorboardSizeResponse) Reset added in v1.49.0

func (x *ReadTensorboardSizeResponse) Reset()

func (*ReadTensorboardSizeResponse) String added in v1.49.0

func (x *ReadTensorboardSizeResponse) String() string

type ReadTensorboardTimeSeriesDataRequest

type ReadTensorboardTimeSeriesDataRequest struct {

	// Required. The resource name of the TensorboardTimeSeries to read data from.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
	TensorboardTimeSeries string `` /* 126-byte string literal not displayed */
	// The maximum number of TensorboardTimeSeries' data to return.
	//
	// This value should be a positive integer.
	// This value can be set to -1 to return all data.
	MaxDataPoints int32 `protobuf:"varint,2,opt,name=max_data_points,json=maxDataPoints,proto3" json:"max_data_points,omitempty"`
	// Reads the TensorboardTimeSeries' data that match the filter expression.
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData].

func (*ReadTensorboardTimeSeriesDataRequest) Descriptor deprecated

func (*ReadTensorboardTimeSeriesDataRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadTensorboardTimeSeriesDataRequest.ProtoReflect.Descriptor instead.

func (*ReadTensorboardTimeSeriesDataRequest) GetFilter

func (*ReadTensorboardTimeSeriesDataRequest) GetMaxDataPoints

func (x *ReadTensorboardTimeSeriesDataRequest) GetMaxDataPoints() int32

func (*ReadTensorboardTimeSeriesDataRequest) GetTensorboardTimeSeries

func (x *ReadTensorboardTimeSeriesDataRequest) GetTensorboardTimeSeries() string

func (*ReadTensorboardTimeSeriesDataRequest) ProtoMessage

func (*ReadTensorboardTimeSeriesDataRequest) ProtoMessage()

func (*ReadTensorboardTimeSeriesDataRequest) ProtoReflect

func (*ReadTensorboardTimeSeriesDataRequest) Reset

func (*ReadTensorboardTimeSeriesDataRequest) String

type ReadTensorboardTimeSeriesDataResponse

type ReadTensorboardTimeSeriesDataResponse struct {

	// The returned time series data.
	TimeSeriesData *TimeSeriesData `protobuf:"bytes,1,opt,name=time_series_data,json=timeSeriesData,proto3" json:"time_series_data,omitempty"`
	// contains filtered or unexported fields
}

Response message for [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData].

func (*ReadTensorboardTimeSeriesDataResponse) Descriptor deprecated

func (*ReadTensorboardTimeSeriesDataResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadTensorboardTimeSeriesDataResponse.ProtoReflect.Descriptor instead.

func (*ReadTensorboardTimeSeriesDataResponse) GetTimeSeriesData

func (x *ReadTensorboardTimeSeriesDataResponse) GetTimeSeriesData() *TimeSeriesData

func (*ReadTensorboardTimeSeriesDataResponse) ProtoMessage

func (*ReadTensorboardTimeSeriesDataResponse) ProtoMessage()

func (*ReadTensorboardTimeSeriesDataResponse) ProtoReflect

func (*ReadTensorboardTimeSeriesDataResponse) Reset

func (*ReadTensorboardTimeSeriesDataResponse) String

type ReadTensorboardUsageRequest added in v1.30.0

type ReadTensorboardUsageRequest struct {

	// Required. The name of the Tensorboard resource.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
	Tensorboard string `protobuf:"bytes,1,opt,name=tensorboard,proto3" json:"tensorboard,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.ReadTensorboardUsage][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage].

func (*ReadTensorboardUsageRequest) Descriptor deprecated added in v1.30.0

func (*ReadTensorboardUsageRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadTensorboardUsageRequest.ProtoReflect.Descriptor instead.

func (*ReadTensorboardUsageRequest) GetTensorboard added in v1.30.0

func (x *ReadTensorboardUsageRequest) GetTensorboard() string

func (*ReadTensorboardUsageRequest) ProtoMessage added in v1.30.0

func (*ReadTensorboardUsageRequest) ProtoMessage()

func (*ReadTensorboardUsageRequest) ProtoReflect added in v1.30.0

func (*ReadTensorboardUsageRequest) Reset added in v1.30.0

func (x *ReadTensorboardUsageRequest) Reset()

func (*ReadTensorboardUsageRequest) String added in v1.30.0

func (x *ReadTensorboardUsageRequest) String() string

type ReadTensorboardUsageResponse added in v1.30.0

type ReadTensorboardUsageResponse struct {

	// Maps year-month (YYYYMM) string to per month usage data.
	MonthlyUsageData map[string]*ReadTensorboardUsageResponse_PerMonthUsageData `` /* 199-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message for [TensorboardService.ReadTensorboardUsage][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage].

func (*ReadTensorboardUsageResponse) Descriptor deprecated added in v1.30.0

func (*ReadTensorboardUsageResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadTensorboardUsageResponse.ProtoReflect.Descriptor instead.

func (*ReadTensorboardUsageResponse) GetMonthlyUsageData added in v1.30.0

func (*ReadTensorboardUsageResponse) ProtoMessage added in v1.30.0

func (*ReadTensorboardUsageResponse) ProtoMessage()

func (*ReadTensorboardUsageResponse) ProtoReflect added in v1.30.0

func (*ReadTensorboardUsageResponse) Reset added in v1.30.0

func (x *ReadTensorboardUsageResponse) Reset()

func (*ReadTensorboardUsageResponse) String added in v1.30.0

type ReadTensorboardUsageResponse_PerMonthUsageData added in v1.30.0

type ReadTensorboardUsageResponse_PerMonthUsageData struct {

	// Usage data for each user in the given month.
	UserUsageData []*ReadTensorboardUsageResponse_PerUserUsageData `protobuf:"bytes,1,rep,name=user_usage_data,json=userUsageData,proto3" json:"user_usage_data,omitempty"`
	// contains filtered or unexported fields
}

Per month usage data

func (*ReadTensorboardUsageResponse_PerMonthUsageData) Descriptor deprecated added in v1.30.0

Deprecated: Use ReadTensorboardUsageResponse_PerMonthUsageData.ProtoReflect.Descriptor instead.

func (*ReadTensorboardUsageResponse_PerMonthUsageData) GetUserUsageData added in v1.30.0

func (*ReadTensorboardUsageResponse_PerMonthUsageData) ProtoMessage added in v1.30.0

func (*ReadTensorboardUsageResponse_PerMonthUsageData) ProtoReflect added in v1.30.0

func (*ReadTensorboardUsageResponse_PerMonthUsageData) Reset added in v1.30.0

func (*ReadTensorboardUsageResponse_PerMonthUsageData) String added in v1.30.0

type ReadTensorboardUsageResponse_PerUserUsageData added in v1.30.0

type ReadTensorboardUsageResponse_PerUserUsageData struct {

	// User's username
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	// Number of times the user has read data within the Tensorboard.
	ViewCount int64 `protobuf:"varint,2,opt,name=view_count,json=viewCount,proto3" json:"view_count,omitempty"`
	// contains filtered or unexported fields
}

Per user usage data.

func (*ReadTensorboardUsageResponse_PerUserUsageData) Descriptor deprecated added in v1.30.0

Deprecated: Use ReadTensorboardUsageResponse_PerUserUsageData.ProtoReflect.Descriptor instead.

func (*ReadTensorboardUsageResponse_PerUserUsageData) GetUsername added in v1.30.0

func (*ReadTensorboardUsageResponse_PerUserUsageData) GetViewCount added in v1.30.0

func (*ReadTensorboardUsageResponse_PerUserUsageData) ProtoMessage added in v1.30.0

func (*ReadTensorboardUsageResponse_PerUserUsageData) ProtoReflect added in v1.30.0

func (*ReadTensorboardUsageResponse_PerUserUsageData) Reset added in v1.30.0

func (*ReadTensorboardUsageResponse_PerUserUsageData) String added in v1.30.0

type RebootPersistentResourceOperationMetadata added in v1.67.0

type RebootPersistentResourceOperationMetadata struct {

	// Operation metadata for PersistentResource.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// Progress Message for Reboot LRO
	ProgressMessage string `protobuf:"bytes,2,opt,name=progress_message,json=progressMessage,proto3" json:"progress_message,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform reboot PersistentResource.

func (*RebootPersistentResourceOperationMetadata) Descriptor deprecated added in v1.67.0

func (*RebootPersistentResourceOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use RebootPersistentResourceOperationMetadata.ProtoReflect.Descriptor instead.

func (*RebootPersistentResourceOperationMetadata) GetGenericMetadata added in v1.67.0

func (*RebootPersistentResourceOperationMetadata) GetProgressMessage added in v1.67.0

func (x *RebootPersistentResourceOperationMetadata) GetProgressMessage() string

func (*RebootPersistentResourceOperationMetadata) ProtoMessage added in v1.67.0

func (*RebootPersistentResourceOperationMetadata) ProtoReflect added in v1.67.0

func (*RebootPersistentResourceOperationMetadata) Reset added in v1.67.0

func (*RebootPersistentResourceOperationMetadata) String added in v1.67.0

type RebootPersistentResourceRequest added in v1.67.0

type RebootPersistentResourceRequest struct {

	// Required. The name of the PersistentResource resource.
	// Format:
	// `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PersistentResourceService.RebootPersistentResource][google.cloud.aiplatform.v1.PersistentResourceService.RebootPersistentResource].

func (*RebootPersistentResourceRequest) Descriptor deprecated added in v1.67.0

func (*RebootPersistentResourceRequest) Descriptor() ([]byte, []int)

Deprecated: Use RebootPersistentResourceRequest.ProtoReflect.Descriptor instead.

func (*RebootPersistentResourceRequest) GetName added in v1.67.0

func (*RebootPersistentResourceRequest) ProtoMessage added in v1.67.0

func (*RebootPersistentResourceRequest) ProtoMessage()

func (*RebootPersistentResourceRequest) ProtoReflect added in v1.67.0

func (*RebootPersistentResourceRequest) Reset added in v1.67.0

func (*RebootPersistentResourceRequest) String added in v1.67.0

type RemoveContextChildrenRequest

type RemoveContextChildrenRequest struct {

	// Required. The resource name of the parent Context.
	//
	// Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
	Context string `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// The resource names of the child Contexts.
	ChildContexts []string `protobuf:"bytes,2,rep,name=child_contexts,json=childContexts,proto3" json:"child_contexts,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.DeleteContextChildrenRequest][].

func (*RemoveContextChildrenRequest) Descriptor deprecated

func (*RemoveContextChildrenRequest) Descriptor() ([]byte, []int)

Deprecated: Use RemoveContextChildrenRequest.ProtoReflect.Descriptor instead.

func (*RemoveContextChildrenRequest) GetChildContexts

func (x *RemoveContextChildrenRequest) GetChildContexts() []string

func (*RemoveContextChildrenRequest) GetContext

func (x *RemoveContextChildrenRequest) GetContext() string

func (*RemoveContextChildrenRequest) ProtoMessage

func (*RemoveContextChildrenRequest) ProtoMessage()

func (*RemoveContextChildrenRequest) ProtoReflect

func (*RemoveContextChildrenRequest) Reset

func (x *RemoveContextChildrenRequest) Reset()

func (*RemoveContextChildrenRequest) String

type RemoveContextChildrenResponse

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

Response message for [MetadataService.RemoveContextChildren][google.cloud.aiplatform.v1.MetadataService.RemoveContextChildren].

func (*RemoveContextChildrenResponse) Descriptor deprecated

func (*RemoveContextChildrenResponse) Descriptor() ([]byte, []int)

Deprecated: Use RemoveContextChildrenResponse.ProtoReflect.Descriptor instead.

func (*RemoveContextChildrenResponse) ProtoMessage

func (*RemoveContextChildrenResponse) ProtoMessage()

func (*RemoveContextChildrenResponse) ProtoReflect

func (*RemoveContextChildrenResponse) Reset

func (x *RemoveContextChildrenResponse) Reset()

func (*RemoveContextChildrenResponse) String

type RemoveDatapointsRequest

type RemoveDatapointsRequest struct {

	// Required. The name of the Index resource to be updated.
	// Format:
	// `projects/{project}/locations/{location}/indexes/{index}`
	Index string `protobuf:"bytes,1,opt,name=index,proto3" json:"index,omitempty"`
	// A list of datapoint ids to be deleted.
	DatapointIds []string `protobuf:"bytes,2,rep,name=datapoint_ids,json=datapointIds,proto3" json:"datapoint_ids,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1.IndexService.RemoveDatapoints]

func (*RemoveDatapointsRequest) Descriptor deprecated

func (*RemoveDatapointsRequest) Descriptor() ([]byte, []int)

Deprecated: Use RemoveDatapointsRequest.ProtoReflect.Descriptor instead.

func (*RemoveDatapointsRequest) GetDatapointIds

func (x *RemoveDatapointsRequest) GetDatapointIds() []string

func (*RemoveDatapointsRequest) GetIndex

func (x *RemoveDatapointsRequest) GetIndex() string

func (*RemoveDatapointsRequest) ProtoMessage

func (*RemoveDatapointsRequest) ProtoMessage()

func (*RemoveDatapointsRequest) ProtoReflect

func (x *RemoveDatapointsRequest) ProtoReflect() protoreflect.Message

func (*RemoveDatapointsRequest) Reset

func (x *RemoveDatapointsRequest) Reset()

func (*RemoveDatapointsRequest) String

func (x *RemoveDatapointsRequest) String() string

type RemoveDatapointsResponse

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

Response message for [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1.IndexService.RemoveDatapoints]

func (*RemoveDatapointsResponse) Descriptor deprecated

func (*RemoveDatapointsResponse) Descriptor() ([]byte, []int)

Deprecated: Use RemoveDatapointsResponse.ProtoReflect.Descriptor instead.

func (*RemoveDatapointsResponse) ProtoMessage

func (*RemoveDatapointsResponse) ProtoMessage()

func (*RemoveDatapointsResponse) ProtoReflect

func (x *RemoveDatapointsResponse) ProtoReflect() protoreflect.Message

func (*RemoveDatapointsResponse) Reset

func (x *RemoveDatapointsResponse) Reset()

func (*RemoveDatapointsResponse) String

func (x *RemoveDatapointsResponse) String() string

type ResourcePool added in v1.67.0

type ResourcePool struct {

	// Immutable. The unique ID in a PersistentResource for referring to this
	// resource pool. User can specify it if necessary. Otherwise, it's generated
	// automatically.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Required. Immutable. The specification of a single machine.
	MachineSpec *MachineSpec `protobuf:"bytes,2,opt,name=machine_spec,json=machineSpec,proto3" json:"machine_spec,omitempty"`
	// Optional. The total number of machines to use for this resource pool.
	ReplicaCount *int64 `protobuf:"varint,3,opt,name=replica_count,json=replicaCount,proto3,oneof" json:"replica_count,omitempty"`
	// Optional. Disk spec for the machine in this node pool.
	DiskSpec *DiskSpec `protobuf:"bytes,4,opt,name=disk_spec,json=diskSpec,proto3" json:"disk_spec,omitempty"`
	// Output only. The number of machines currently in use by training jobs for
	// this resource pool. Will replace idle_replica_count.
	UsedReplicaCount int64 `protobuf:"varint,6,opt,name=used_replica_count,json=usedReplicaCount,proto3" json:"used_replica_count,omitempty"`
	// Optional. Optional spec to configure GKE autoscaling
	AutoscalingSpec *ResourcePool_AutoscalingSpec `protobuf:"bytes,7,opt,name=autoscaling_spec,json=autoscalingSpec,proto3" json:"autoscaling_spec,omitempty"`
	// contains filtered or unexported fields
}

Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.

func (*ResourcePool) Descriptor deprecated added in v1.67.0

func (*ResourcePool) Descriptor() ([]byte, []int)

Deprecated: Use ResourcePool.ProtoReflect.Descriptor instead.

func (*ResourcePool) GetAutoscalingSpec added in v1.67.0

func (x *ResourcePool) GetAutoscalingSpec() *ResourcePool_AutoscalingSpec

func (*ResourcePool) GetDiskSpec added in v1.67.0

func (x *ResourcePool) GetDiskSpec() *DiskSpec

func (*ResourcePool) GetId added in v1.67.0

func (x *ResourcePool) GetId() string

func (*ResourcePool) GetMachineSpec added in v1.67.0

func (x *ResourcePool) GetMachineSpec() *MachineSpec

func (*ResourcePool) GetReplicaCount added in v1.67.0

func (x *ResourcePool) GetReplicaCount() int64

func (*ResourcePool) GetUsedReplicaCount added in v1.67.0

func (x *ResourcePool) GetUsedReplicaCount() int64

func (*ResourcePool) ProtoMessage added in v1.67.0

func (*ResourcePool) ProtoMessage()

func (*ResourcePool) ProtoReflect added in v1.67.0

func (x *ResourcePool) ProtoReflect() protoreflect.Message

func (*ResourcePool) Reset added in v1.67.0

func (x *ResourcePool) Reset()

func (*ResourcePool) String added in v1.67.0

func (x *ResourcePool) String() string

type ResourcePool_AutoscalingSpec added in v1.67.0

type ResourcePool_AutoscalingSpec struct {

	// Optional. min replicas in the node pool,
	// must be ≤ replica_count and < max_replica_count or will throw error
	MinReplicaCount *int64 `protobuf:"varint,1,opt,name=min_replica_count,json=minReplicaCount,proto3,oneof" json:"min_replica_count,omitempty"`
	// Optional. max replicas in the node pool,
	// must be ≥ replica_count and > min_replica_count or will throw error
	MaxReplicaCount *int64 `protobuf:"varint,2,opt,name=max_replica_count,json=maxReplicaCount,proto3,oneof" json:"max_replica_count,omitempty"`
	// contains filtered or unexported fields
}

The min/max number of replicas allowed if enabling autoscaling

func (*ResourcePool_AutoscalingSpec) Descriptor deprecated added in v1.67.0

func (*ResourcePool_AutoscalingSpec) Descriptor() ([]byte, []int)

Deprecated: Use ResourcePool_AutoscalingSpec.ProtoReflect.Descriptor instead.

func (*ResourcePool_AutoscalingSpec) GetMaxReplicaCount added in v1.67.0

func (x *ResourcePool_AutoscalingSpec) GetMaxReplicaCount() int64

func (*ResourcePool_AutoscalingSpec) GetMinReplicaCount added in v1.67.0

func (x *ResourcePool_AutoscalingSpec) GetMinReplicaCount() int64

func (*ResourcePool_AutoscalingSpec) ProtoMessage added in v1.67.0

func (*ResourcePool_AutoscalingSpec) ProtoMessage()

func (*ResourcePool_AutoscalingSpec) ProtoReflect added in v1.67.0

func (*ResourcePool_AutoscalingSpec) Reset added in v1.67.0

func (x *ResourcePool_AutoscalingSpec) Reset()

func (*ResourcePool_AutoscalingSpec) String added in v1.67.0

type ResourceRuntime added in v1.67.0

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

Persistent Cluster runtime information as output

func (*ResourceRuntime) Descriptor deprecated added in v1.67.0

func (*ResourceRuntime) Descriptor() ([]byte, []int)

Deprecated: Use ResourceRuntime.ProtoReflect.Descriptor instead.

func (*ResourceRuntime) ProtoMessage added in v1.67.0

func (*ResourceRuntime) ProtoMessage()

func (*ResourceRuntime) ProtoReflect added in v1.67.0

func (x *ResourceRuntime) ProtoReflect() protoreflect.Message

func (*ResourceRuntime) Reset added in v1.67.0

func (x *ResourceRuntime) Reset()

func (*ResourceRuntime) String added in v1.67.0

func (x *ResourceRuntime) String() string

type ResourceRuntimeSpec added in v1.67.0

type ResourceRuntimeSpec struct {

	// Optional. Configure the use of workload identity on the PersistentResource
	ServiceAccountSpec *ServiceAccountSpec `protobuf:"bytes,2,opt,name=service_account_spec,json=serviceAccountSpec,proto3" json:"service_account_spec,omitempty"`
	// Optional. Ray cluster configuration.
	// Required when creating a dedicated RayCluster on the PersistentResource.
	RaySpec *RaySpec `protobuf:"bytes,1,opt,name=ray_spec,json=raySpec,proto3" json:"ray_spec,omitempty"`
	// contains filtered or unexported fields
}

Configuration for the runtime on a PersistentResource instance, including but not limited to:

* Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster.

func (*ResourceRuntimeSpec) Descriptor deprecated added in v1.67.0

func (*ResourceRuntimeSpec) Descriptor() ([]byte, []int)

Deprecated: Use ResourceRuntimeSpec.ProtoReflect.Descriptor instead.

func (*ResourceRuntimeSpec) GetRaySpec added in v1.67.0

func (x *ResourceRuntimeSpec) GetRaySpec() *RaySpec

func (*ResourceRuntimeSpec) GetServiceAccountSpec added in v1.67.0

func (x *ResourceRuntimeSpec) GetServiceAccountSpec() *ServiceAccountSpec

func (*ResourceRuntimeSpec) ProtoMessage added in v1.67.0

func (*ResourceRuntimeSpec) ProtoMessage()

func (*ResourceRuntimeSpec) ProtoReflect added in v1.67.0

func (x *ResourceRuntimeSpec) ProtoReflect() protoreflect.Message

func (*ResourceRuntimeSpec) Reset added in v1.67.0

func (x *ResourceRuntimeSpec) Reset()

func (*ResourceRuntimeSpec) String added in v1.67.0

func (x *ResourceRuntimeSpec) String() string

type ResourcesConsumed

type ResourcesConsumed struct {

	// Output only. The number of replica hours used. Note that many replicas may
	// run in parallel, and additionally any given work may be queued for some
	// time. Therefore this value is not strictly related to wall time.
	ReplicaHours float64 `protobuf:"fixed64,1,opt,name=replica_hours,json=replicaHours,proto3" json:"replica_hours,omitempty"`
	// contains filtered or unexported fields
}

Statistics information about resource consumption.

func (*ResourcesConsumed) Descriptor deprecated

func (*ResourcesConsumed) Descriptor() ([]byte, []int)

Deprecated: Use ResourcesConsumed.ProtoReflect.Descriptor instead.

func (*ResourcesConsumed) GetReplicaHours

func (x *ResourcesConsumed) GetReplicaHours() float64

func (*ResourcesConsumed) ProtoMessage

func (*ResourcesConsumed) ProtoMessage()

func (*ResourcesConsumed) ProtoReflect

func (x *ResourcesConsumed) ProtoReflect() protoreflect.Message

func (*ResourcesConsumed) Reset

func (x *ResourcesConsumed) Reset()

func (*ResourcesConsumed) String

func (x *ResourcesConsumed) String() string

type RestoreDatasetVersionOperationMetadata added in v1.49.0

type RestoreDatasetVersionOperationMetadata struct {

	// The common part of the operation metadata.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [DatasetService.RestoreDatasetVersion][google.cloud.aiplatform.v1.DatasetService.RestoreDatasetVersion].

func (*RestoreDatasetVersionOperationMetadata) Descriptor deprecated added in v1.49.0

func (*RestoreDatasetVersionOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use RestoreDatasetVersionOperationMetadata.ProtoReflect.Descriptor instead.

func (*RestoreDatasetVersionOperationMetadata) GetGenericMetadata added in v1.49.0

func (*RestoreDatasetVersionOperationMetadata) ProtoMessage added in v1.49.0

func (*RestoreDatasetVersionOperationMetadata) ProtoReflect added in v1.49.0

func (*RestoreDatasetVersionOperationMetadata) Reset added in v1.49.0

func (*RestoreDatasetVersionOperationMetadata) String added in v1.49.0

type RestoreDatasetVersionRequest added in v1.51.0

type RestoreDatasetVersionRequest struct {

	// Required. The name of the DatasetVersion resource.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.RestoreDatasetVersion][google.cloud.aiplatform.v1.DatasetService.RestoreDatasetVersion].

func (*RestoreDatasetVersionRequest) Descriptor deprecated added in v1.51.0

func (*RestoreDatasetVersionRequest) Descriptor() ([]byte, []int)

Deprecated: Use RestoreDatasetVersionRequest.ProtoReflect.Descriptor instead.

func (*RestoreDatasetVersionRequest) GetName added in v1.51.0

func (x *RestoreDatasetVersionRequest) GetName() string

func (*RestoreDatasetVersionRequest) ProtoMessage added in v1.51.0

func (*RestoreDatasetVersionRequest) ProtoMessage()

func (*RestoreDatasetVersionRequest) ProtoReflect added in v1.51.0

func (*RestoreDatasetVersionRequest) Reset added in v1.51.0

func (x *RestoreDatasetVersionRequest) Reset()

func (*RestoreDatasetVersionRequest) String added in v1.51.0

type ResumeModelDeploymentMonitoringJobRequest

type ResumeModelDeploymentMonitoringJobRequest struct {

	// Required. The resource name of the ModelDeploymentMonitoringJob to resume.
	// Format:
	// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.ResumeModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.ResumeModelDeploymentMonitoringJob].

func (*ResumeModelDeploymentMonitoringJobRequest) Descriptor deprecated

func (*ResumeModelDeploymentMonitoringJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use ResumeModelDeploymentMonitoringJobRequest.ProtoReflect.Descriptor instead.

func (*ResumeModelDeploymentMonitoringJobRequest) GetName

func (*ResumeModelDeploymentMonitoringJobRequest) ProtoMessage

func (*ResumeModelDeploymentMonitoringJobRequest) ProtoReflect

func (*ResumeModelDeploymentMonitoringJobRequest) Reset

func (*ResumeModelDeploymentMonitoringJobRequest) String

type ResumeScheduleRequest added in v1.47.0

type ResumeScheduleRequest struct {

	// Required. The name of the Schedule resource to be resumed.
	// Format:
	// `projects/{project}/locations/{location}/schedules/{schedule}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Whether to backfill missed runs when the schedule is resumed from
	// PAUSED state. If set to true, all missed runs will be scheduled. New runs
	// will be scheduled after the backfill is complete. This will also update
	// [Schedule.catch_up][google.cloud.aiplatform.v1.Schedule.catch_up] field.
	// Default to false.
	CatchUp bool `protobuf:"varint,2,opt,name=catch_up,json=catchUp,proto3" json:"catch_up,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ScheduleService.ResumeSchedule][google.cloud.aiplatform.v1.ScheduleService.ResumeSchedule].

func (*ResumeScheduleRequest) Descriptor deprecated added in v1.47.0

func (*ResumeScheduleRequest) Descriptor() ([]byte, []int)

Deprecated: Use ResumeScheduleRequest.ProtoReflect.Descriptor instead.

func (*ResumeScheduleRequest) GetCatchUp added in v1.47.0

func (x *ResumeScheduleRequest) GetCatchUp() bool

func (*ResumeScheduleRequest) GetName added in v1.47.0

func (x *ResumeScheduleRequest) GetName() string

func (*ResumeScheduleRequest) ProtoMessage added in v1.47.0

func (*ResumeScheduleRequest) ProtoMessage()

func (*ResumeScheduleRequest) ProtoReflect added in v1.47.0

func (x *ResumeScheduleRequest) ProtoReflect() protoreflect.Message

func (*ResumeScheduleRequest) Reset added in v1.47.0

func (x *ResumeScheduleRequest) Reset()

func (*ResumeScheduleRequest) String added in v1.47.0

func (x *ResumeScheduleRequest) String() string

type Retrieval added in v1.63.0

type Retrieval struct {

	// Types that are assignable to Source:
	//
	//	*Retrieval_VertexAiSearch
	Source isRetrieval_Source `protobuf_oneof:"source"`
	// Optional. Disable using the result from this tool in detecting grounding
	// attribution. This does not affect how the result is given to the model for
	// generation.
	DisableAttribution bool `protobuf:"varint,3,opt,name=disable_attribution,json=disableAttribution,proto3" json:"disable_attribution,omitempty"`
	// contains filtered or unexported fields
}

Defines a retrieval tool that model can call to access external knowledge.

func (*Retrieval) Descriptor deprecated added in v1.63.0

func (*Retrieval) Descriptor() ([]byte, []int)

Deprecated: Use Retrieval.ProtoReflect.Descriptor instead.

func (*Retrieval) GetDisableAttribution added in v1.63.0

func (x *Retrieval) GetDisableAttribution() bool

func (*Retrieval) GetSource added in v1.63.0

func (m *Retrieval) GetSource() isRetrieval_Source

func (*Retrieval) GetVertexAiSearch added in v1.63.0

func (x *Retrieval) GetVertexAiSearch() *VertexAISearch

func (*Retrieval) ProtoMessage added in v1.63.0

func (*Retrieval) ProtoMessage()

func (*Retrieval) ProtoReflect added in v1.63.0

func (x *Retrieval) ProtoReflect() protoreflect.Message

func (*Retrieval) Reset added in v1.63.0

func (x *Retrieval) Reset()

func (*Retrieval) String added in v1.63.0

func (x *Retrieval) String() string

type Retrieval_VertexAiSearch added in v1.63.0

type Retrieval_VertexAiSearch struct {
	// Set to use data source powered by Vertex AI Search.
	VertexAiSearch *VertexAISearch `protobuf:"bytes,2,opt,name=vertex_ai_search,json=vertexAiSearch,proto3,oneof"`
}

type SafetyRating added in v1.57.0

type SafetyRating struct {

	// Output only. Harm category.
	Category HarmCategory `protobuf:"varint,1,opt,name=category,proto3,enum=google.cloud.aiplatform.v1.HarmCategory" json:"category,omitempty"`
	// Output only. Harm probability levels in the content.
	Probability SafetyRating_HarmProbability `` /* 137-byte string literal not displayed */
	// Output only. Harm probability score.
	ProbabilityScore float32 `protobuf:"fixed32,5,opt,name=probability_score,json=probabilityScore,proto3" json:"probability_score,omitempty"`
	// Output only. Harm severity levels in the content.
	Severity SafetyRating_HarmSeverity `` /* 128-byte string literal not displayed */
	// Output only. Harm severity score.
	SeverityScore float32 `protobuf:"fixed32,7,opt,name=severity_score,json=severityScore,proto3" json:"severity_score,omitempty"`
	// Output only. Indicates whether the content was filtered out because of this
	// rating.
	Blocked bool `protobuf:"varint,3,opt,name=blocked,proto3" json:"blocked,omitempty"`
	// contains filtered or unexported fields
}

Safety rating corresponding to the generated content.

func (*SafetyRating) Descriptor deprecated added in v1.57.0

func (*SafetyRating) Descriptor() ([]byte, []int)

Deprecated: Use SafetyRating.ProtoReflect.Descriptor instead.

func (*SafetyRating) GetBlocked added in v1.57.0

func (x *SafetyRating) GetBlocked() bool

func (*SafetyRating) GetCategory added in v1.57.0

func (x *SafetyRating) GetCategory() HarmCategory

func (*SafetyRating) GetProbability added in v1.57.0

func (x *SafetyRating) GetProbability() SafetyRating_HarmProbability

func (*SafetyRating) GetProbabilityScore added in v1.63.0

func (x *SafetyRating) GetProbabilityScore() float32

func (*SafetyRating) GetSeverity added in v1.63.0

func (x *SafetyRating) GetSeverity() SafetyRating_HarmSeverity

func (*SafetyRating) GetSeverityScore added in v1.63.0

func (x *SafetyRating) GetSeverityScore() float32

func (*SafetyRating) ProtoMessage added in v1.57.0

func (*SafetyRating) ProtoMessage()

func (*SafetyRating) ProtoReflect added in v1.57.0

func (x *SafetyRating) ProtoReflect() protoreflect.Message

func (*SafetyRating) Reset added in v1.57.0

func (x *SafetyRating) Reset()

func (*SafetyRating) String added in v1.57.0

func (x *SafetyRating) String() string

type SafetyRating_HarmProbability added in v1.57.0

type SafetyRating_HarmProbability int32

Harm probability levels in the content.

const (
	// Harm probability unspecified.
	SafetyRating_HARM_PROBABILITY_UNSPECIFIED SafetyRating_HarmProbability = 0
	// Negligible level of harm.
	SafetyRating_NEGLIGIBLE SafetyRating_HarmProbability = 1
	// Low level of harm.
	SafetyRating_LOW SafetyRating_HarmProbability = 2
	// Medium level of harm.
	SafetyRating_MEDIUM SafetyRating_HarmProbability = 3
	// High level of harm.
	SafetyRating_HIGH SafetyRating_HarmProbability = 4
)

func (SafetyRating_HarmProbability) Descriptor added in v1.57.0

func (SafetyRating_HarmProbability) Enum added in v1.57.0

func (SafetyRating_HarmProbability) EnumDescriptor deprecated added in v1.57.0

func (SafetyRating_HarmProbability) EnumDescriptor() ([]byte, []int)

Deprecated: Use SafetyRating_HarmProbability.Descriptor instead.

func (SafetyRating_HarmProbability) Number added in v1.57.0

func (SafetyRating_HarmProbability) String added in v1.57.0

func (SafetyRating_HarmProbability) Type added in v1.57.0

type SafetyRating_HarmSeverity added in v1.63.0

type SafetyRating_HarmSeverity int32

Harm severity levels.

const (
	// Harm severity unspecified.
	SafetyRating_HARM_SEVERITY_UNSPECIFIED SafetyRating_HarmSeverity = 0
	// Negligible level of harm severity.
	SafetyRating_HARM_SEVERITY_NEGLIGIBLE SafetyRating_HarmSeverity = 1
	// Low level of harm severity.
	SafetyRating_HARM_SEVERITY_LOW SafetyRating_HarmSeverity = 2
	// Medium level of harm severity.
	SafetyRating_HARM_SEVERITY_MEDIUM SafetyRating_HarmSeverity = 3
	// High level of harm severity.
	SafetyRating_HARM_SEVERITY_HIGH SafetyRating_HarmSeverity = 4
)

func (SafetyRating_HarmSeverity) Descriptor added in v1.63.0

func (SafetyRating_HarmSeverity) Enum added in v1.63.0

func (SafetyRating_HarmSeverity) EnumDescriptor deprecated added in v1.63.0

func (SafetyRating_HarmSeverity) EnumDescriptor() ([]byte, []int)

Deprecated: Use SafetyRating_HarmSeverity.Descriptor instead.

func (SafetyRating_HarmSeverity) Number added in v1.63.0

func (SafetyRating_HarmSeverity) String added in v1.63.0

func (x SafetyRating_HarmSeverity) String() string

func (SafetyRating_HarmSeverity) Type added in v1.63.0

type SafetySetting added in v1.57.0

type SafetySetting struct {

	// Required. Harm category.
	Category HarmCategory `protobuf:"varint,1,opt,name=category,proto3,enum=google.cloud.aiplatform.v1.HarmCategory" json:"category,omitempty"`
	// Required. The harm block threshold.
	Threshold SafetySetting_HarmBlockThreshold `` /* 137-byte string literal not displayed */
	// Optional. Specify if the threshold is used for probability or severity
	// score. If not specified, the threshold is used for probability score.
	Method SafetySetting_HarmBlockMethod `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

Safety settings.

func (*SafetySetting) Descriptor deprecated added in v1.57.0

func (*SafetySetting) Descriptor() ([]byte, []int)

Deprecated: Use SafetySetting.ProtoReflect.Descriptor instead.

func (*SafetySetting) GetCategory added in v1.57.0

func (x *SafetySetting) GetCategory() HarmCategory

func (*SafetySetting) GetMethod added in v1.67.0

func (*SafetySetting) GetThreshold added in v1.57.0

func (*SafetySetting) ProtoMessage added in v1.57.0

func (*SafetySetting) ProtoMessage()

func (*SafetySetting) ProtoReflect added in v1.57.0

func (x *SafetySetting) ProtoReflect() protoreflect.Message

func (*SafetySetting) Reset added in v1.57.0

func (x *SafetySetting) Reset()

func (*SafetySetting) String added in v1.57.0

func (x *SafetySetting) String() string

type SafetySetting_HarmBlockMethod added in v1.67.0

type SafetySetting_HarmBlockMethod int32

Probability vs severity.

const (
	// The harm block method is unspecified.
	SafetySetting_HARM_BLOCK_METHOD_UNSPECIFIED SafetySetting_HarmBlockMethod = 0
	// The harm block method uses both probability and severity scores.
	SafetySetting_SEVERITY SafetySetting_HarmBlockMethod = 1
	// The harm block method uses the probability score.
	SafetySetting_PROBABILITY SafetySetting_HarmBlockMethod = 2
)

func (SafetySetting_HarmBlockMethod) Descriptor added in v1.67.0

func (SafetySetting_HarmBlockMethod) Enum added in v1.67.0

func (SafetySetting_HarmBlockMethod) EnumDescriptor deprecated added in v1.67.0

func (SafetySetting_HarmBlockMethod) EnumDescriptor() ([]byte, []int)

Deprecated: Use SafetySetting_HarmBlockMethod.Descriptor instead.

func (SafetySetting_HarmBlockMethod) Number added in v1.67.0

func (SafetySetting_HarmBlockMethod) String added in v1.67.0

func (SafetySetting_HarmBlockMethod) Type added in v1.67.0

type SafetySetting_HarmBlockThreshold added in v1.57.0

type SafetySetting_HarmBlockThreshold int32

Probability based thresholds levels for blocking.

const (
	// Unspecified harm block threshold.
	SafetySetting_HARM_BLOCK_THRESHOLD_UNSPECIFIED SafetySetting_HarmBlockThreshold = 0
	// Block low threshold and above (i.e. block more).
	SafetySetting_BLOCK_LOW_AND_ABOVE SafetySetting_HarmBlockThreshold = 1
	// Block medium threshold and above.
	SafetySetting_BLOCK_MEDIUM_AND_ABOVE SafetySetting_HarmBlockThreshold = 2
	// Block only high threshold (i.e. block less).
	SafetySetting_BLOCK_ONLY_HIGH SafetySetting_HarmBlockThreshold = 3
	// Block none.
	SafetySetting_BLOCK_NONE SafetySetting_HarmBlockThreshold = 4
)

func (SafetySetting_HarmBlockThreshold) Descriptor added in v1.57.0

func (SafetySetting_HarmBlockThreshold) Enum added in v1.57.0

func (SafetySetting_HarmBlockThreshold) EnumDescriptor deprecated added in v1.57.0

func (SafetySetting_HarmBlockThreshold) EnumDescriptor() ([]byte, []int)

Deprecated: Use SafetySetting_HarmBlockThreshold.Descriptor instead.

func (SafetySetting_HarmBlockThreshold) Number added in v1.57.0

func (SafetySetting_HarmBlockThreshold) String added in v1.57.0

func (SafetySetting_HarmBlockThreshold) Type added in v1.57.0

type SampleConfig

type SampleConfig struct {

	// Decides sample size for the initial batch. initial_batch_sample_percentage
	// is used by default.
	//
	// Types that are assignable to InitialBatchSampleSize:
	//
	//	*SampleConfig_InitialBatchSamplePercentage
	InitialBatchSampleSize isSampleConfig_InitialBatchSampleSize `protobuf_oneof:"initial_batch_sample_size"`
	// Decides sample size for the following batches.
	// following_batch_sample_percentage is used by default.
	//
	// Types that are assignable to FollowingBatchSampleSize:
	//
	//	*SampleConfig_FollowingBatchSamplePercentage
	FollowingBatchSampleSize isSampleConfig_FollowingBatchSampleSize `protobuf_oneof:"following_batch_sample_size"`
	// Field to choose sampling strategy. Sampling strategy will decide which data
	// should be selected for human labeling in every batch.
	SampleStrategy SampleConfig_SampleStrategy `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

Active learning data sampling config. For every active learning labeling iteration, it will select a batch of data based on the sampling strategy.

func (*SampleConfig) Descriptor deprecated

func (*SampleConfig) Descriptor() ([]byte, []int)

Deprecated: Use SampleConfig.ProtoReflect.Descriptor instead.

func (*SampleConfig) GetFollowingBatchSamplePercentage

func (x *SampleConfig) GetFollowingBatchSamplePercentage() int32

func (*SampleConfig) GetFollowingBatchSampleSize

func (m *SampleConfig) GetFollowingBatchSampleSize() isSampleConfig_FollowingBatchSampleSize

func (*SampleConfig) GetInitialBatchSamplePercentage

func (x *SampleConfig) GetInitialBatchSamplePercentage() int32

func (*SampleConfig) GetInitialBatchSampleSize

func (m *SampleConfig) GetInitialBatchSampleSize() isSampleConfig_InitialBatchSampleSize

func (*SampleConfig) GetSampleStrategy

func (x *SampleConfig) GetSampleStrategy() SampleConfig_SampleStrategy

func (*SampleConfig) ProtoMessage

func (*SampleConfig) ProtoMessage()

func (*SampleConfig) ProtoReflect

func (x *SampleConfig) ProtoReflect() protoreflect.Message

func (*SampleConfig) Reset

func (x *SampleConfig) Reset()

func (*SampleConfig) String

func (x *SampleConfig) String() string

type SampleConfig_FollowingBatchSamplePercentage

type SampleConfig_FollowingBatchSamplePercentage struct {
	// The percentage of data needed to be labeled in each following batch
	// (except the first batch).
	FollowingBatchSamplePercentage int32 `protobuf:"varint,3,opt,name=following_batch_sample_percentage,json=followingBatchSamplePercentage,proto3,oneof"`
}

type SampleConfig_InitialBatchSamplePercentage

type SampleConfig_InitialBatchSamplePercentage struct {
	// The percentage of data needed to be labeled in the first batch.
	InitialBatchSamplePercentage int32 `protobuf:"varint,1,opt,name=initial_batch_sample_percentage,json=initialBatchSamplePercentage,proto3,oneof"`
}

type SampleConfig_SampleStrategy

type SampleConfig_SampleStrategy int32

Sample strategy decides which subset of DataItems should be selected for human labeling in every batch.

const (
	// Default will be treated as UNCERTAINTY.
	SampleConfig_SAMPLE_STRATEGY_UNSPECIFIED SampleConfig_SampleStrategy = 0
	// Sample the most uncertain data to label.
	SampleConfig_UNCERTAINTY SampleConfig_SampleStrategy = 1
)

func (SampleConfig_SampleStrategy) Descriptor

func (SampleConfig_SampleStrategy) Enum

func (SampleConfig_SampleStrategy) EnumDescriptor deprecated

func (SampleConfig_SampleStrategy) EnumDescriptor() ([]byte, []int)

Deprecated: Use SampleConfig_SampleStrategy.Descriptor instead.

func (SampleConfig_SampleStrategy) Number

func (SampleConfig_SampleStrategy) String

func (SampleConfig_SampleStrategy) Type

type SampledShapleyAttribution

type SampledShapleyAttribution struct {

	// Required. The number of feature permutations to consider when approximating
	// the Shapley values.
	//
	// Valid range of its value is [1, 50], inclusively.
	PathCount int32 `protobuf:"varint,1,opt,name=path_count,json=pathCount,proto3" json:"path_count,omitempty"`
	// contains filtered or unexported fields
}

An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.

func (*SampledShapleyAttribution) Descriptor deprecated

func (*SampledShapleyAttribution) Descriptor() ([]byte, []int)

Deprecated: Use SampledShapleyAttribution.ProtoReflect.Descriptor instead.

func (*SampledShapleyAttribution) GetPathCount

func (x *SampledShapleyAttribution) GetPathCount() int32

func (*SampledShapleyAttribution) ProtoMessage

func (*SampledShapleyAttribution) ProtoMessage()

func (*SampledShapleyAttribution) ProtoReflect

func (*SampledShapleyAttribution) Reset

func (x *SampledShapleyAttribution) Reset()

func (*SampledShapleyAttribution) String

func (x *SampledShapleyAttribution) String() string

type SamplingStrategy

type SamplingStrategy struct {

	// Random sample config. Will support more sampling strategies later.
	RandomSampleConfig *SamplingStrategy_RandomSampleConfig `protobuf:"bytes,1,opt,name=random_sample_config,json=randomSampleConfig,proto3" json:"random_sample_config,omitempty"`
	// contains filtered or unexported fields
}

Sampling Strategy for logging, can be for both training and prediction dataset.

func (*SamplingStrategy) Descriptor deprecated

func (*SamplingStrategy) Descriptor() ([]byte, []int)

Deprecated: Use SamplingStrategy.ProtoReflect.Descriptor instead.

func (*SamplingStrategy) GetRandomSampleConfig

func (x *SamplingStrategy) GetRandomSampleConfig() *SamplingStrategy_RandomSampleConfig

func (*SamplingStrategy) ProtoMessage

func (*SamplingStrategy) ProtoMessage()

func (*SamplingStrategy) ProtoReflect

func (x *SamplingStrategy) ProtoReflect() protoreflect.Message

func (*SamplingStrategy) Reset

func (x *SamplingStrategy) Reset()

func (*SamplingStrategy) String

func (x *SamplingStrategy) String() string

type SamplingStrategy_RandomSampleConfig

type SamplingStrategy_RandomSampleConfig struct {

	// Sample rate (0, 1]
	SampleRate float64 `protobuf:"fixed64,1,opt,name=sample_rate,json=sampleRate,proto3" json:"sample_rate,omitempty"`
	// contains filtered or unexported fields
}

Requests are randomly selected.

func (*SamplingStrategy_RandomSampleConfig) Descriptor deprecated

func (*SamplingStrategy_RandomSampleConfig) Descriptor() ([]byte, []int)

Deprecated: Use SamplingStrategy_RandomSampleConfig.ProtoReflect.Descriptor instead.

func (*SamplingStrategy_RandomSampleConfig) GetSampleRate

func (x *SamplingStrategy_RandomSampleConfig) GetSampleRate() float64

func (*SamplingStrategy_RandomSampleConfig) ProtoMessage

func (*SamplingStrategy_RandomSampleConfig) ProtoMessage()

func (*SamplingStrategy_RandomSampleConfig) ProtoReflect

func (*SamplingStrategy_RandomSampleConfig) Reset

func (*SamplingStrategy_RandomSampleConfig) String

type SavedQuery

type SavedQuery struct {

	// Output only. Resource name of the SavedQuery.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The user-defined name of the SavedQuery.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Some additional information about the SavedQuery.
	Metadata *structpb.Value `protobuf:"bytes,12,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Output only. Timestamp when this SavedQuery was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when SavedQuery was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Filters on the Annotations in the dataset.
	AnnotationFilter string `protobuf:"bytes,5,opt,name=annotation_filter,json=annotationFilter,proto3" json:"annotation_filter,omitempty"`
	// Required. Problem type of the SavedQuery.
	// Allowed values:
	//
	// * IMAGE_CLASSIFICATION_SINGLE_LABEL
	// * IMAGE_CLASSIFICATION_MULTI_LABEL
	// * IMAGE_BOUNDING_POLY
	// * IMAGE_BOUNDING_BOX
	// * TEXT_CLASSIFICATION_SINGLE_LABEL
	// * TEXT_CLASSIFICATION_MULTI_LABEL
	// * TEXT_EXTRACTION
	// * TEXT_SENTIMENT
	// * VIDEO_CLASSIFICATION
	// * VIDEO_OBJECT_TRACKING
	ProblemType string `protobuf:"bytes,6,opt,name=problem_type,json=problemType,proto3" json:"problem_type,omitempty"`
	// Output only. Number of AnnotationSpecs in the context of the SavedQuery.
	AnnotationSpecCount int32 `protobuf:"varint,10,opt,name=annotation_spec_count,json=annotationSpecCount,proto3" json:"annotation_spec_count,omitempty"`
	// Used to perform a consistent read-modify-write update. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
	// Output only. If the Annotations belonging to the SavedQuery can be used for
	// AutoML training.
	SupportAutomlTraining bool `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.

func (*SavedQuery) Descriptor deprecated

func (*SavedQuery) Descriptor() ([]byte, []int)

Deprecated: Use SavedQuery.ProtoReflect.Descriptor instead.

func (*SavedQuery) GetAnnotationFilter

func (x *SavedQuery) GetAnnotationFilter() string

func (*SavedQuery) GetAnnotationSpecCount

func (x *SavedQuery) GetAnnotationSpecCount() int32

func (*SavedQuery) GetCreateTime

func (x *SavedQuery) GetCreateTime() *timestamppb.Timestamp

func (*SavedQuery) GetDisplayName

func (x *SavedQuery) GetDisplayName() string

func (*SavedQuery) GetEtag

func (x *SavedQuery) GetEtag() string

func (*SavedQuery) GetMetadata

func (x *SavedQuery) GetMetadata() *structpb.Value

func (*SavedQuery) GetName

func (x *SavedQuery) GetName() string

func (*SavedQuery) GetProblemType

func (x *SavedQuery) GetProblemType() string

func (*SavedQuery) GetSupportAutomlTraining

func (x *SavedQuery) GetSupportAutomlTraining() bool

func (*SavedQuery) GetUpdateTime

func (x *SavedQuery) GetUpdateTime() *timestamppb.Timestamp

func (*SavedQuery) ProtoMessage

func (*SavedQuery) ProtoMessage()

func (*SavedQuery) ProtoReflect

func (x *SavedQuery) ProtoReflect() protoreflect.Message

func (*SavedQuery) Reset

func (x *SavedQuery) Reset()

func (*SavedQuery) String

func (x *SavedQuery) String() string

type Scalar

type Scalar struct {

	// Value of the point at this step / timestamp.
	Value float64 `protobuf:"fixed64,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

One point viewable on a scalar metric plot.

func (*Scalar) Descriptor deprecated

func (*Scalar) Descriptor() ([]byte, []int)

Deprecated: Use Scalar.ProtoReflect.Descriptor instead.

func (*Scalar) GetValue

func (x *Scalar) GetValue() float64

func (*Scalar) ProtoMessage

func (*Scalar) ProtoMessage()

func (*Scalar) ProtoReflect

func (x *Scalar) ProtoReflect() protoreflect.Message

func (*Scalar) Reset

func (x *Scalar) Reset()

func (*Scalar) String

func (x *Scalar) String() string

type Schedule added in v1.47.0

type Schedule struct {

	// Required.
	// The time specification to launch scheduled runs.
	//
	// Types that are assignable to TimeSpecification:
	//
	//	*Schedule_Cron
	TimeSpecification isSchedule_TimeSpecification `protobuf_oneof:"time_specification"`
	// Required.
	// The API request template to launch the scheduled runs.
	// User-specified ID is not supported in the request template.
	//
	// Types that are assignable to Request:
	//
	//	*Schedule_CreatePipelineJobRequest
	Request isSchedule_Request `protobuf_oneof:"request"`
	// Immutable. The resource name of the Schedule.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. User provided name of the Schedule.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Optional. Timestamp after which the first run can be scheduled.
	// Default to Schedule create time if not specified.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Optional. Timestamp after which no new runs can be scheduled.
	// If specified, The schedule will be completed when either
	// end_time is reached or when scheduled_run_count >= max_run_count.
	// If not specified, new runs will keep getting scheduled until this Schedule
	// is paused or deleted. Already scheduled runs will be allowed to complete.
	// Unset if not specified.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Optional. Maximum run count of the schedule.
	// If specified, The schedule will be completed when either
	// started_run_count >= max_run_count or when end_time is reached.
	// If not specified, new runs will keep getting scheduled until this Schedule
	// is paused or deleted. Already scheduled runs will be allowed to complete.
	// Unset if not specified.
	MaxRunCount int64 `protobuf:"varint,16,opt,name=max_run_count,json=maxRunCount,proto3" json:"max_run_count,omitempty"`
	// Output only. The number of runs started by this schedule.
	StartedRunCount int64 `protobuf:"varint,17,opt,name=started_run_count,json=startedRunCount,proto3" json:"started_run_count,omitempty"`
	// Output only. The state of this Schedule.
	State Schedule_State `protobuf:"varint,5,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.Schedule_State" json:"state,omitempty"`
	// Output only. Timestamp when this Schedule was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Schedule was updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,19,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Timestamp when this Schedule should schedule the next run.
	// Having a next_run_time in the past means the runs are being started
	// behind schedule.
	NextRunTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=next_run_time,json=nextRunTime,proto3" json:"next_run_time,omitempty"`
	// Output only. Timestamp when this Schedule was last paused.
	// Unset if never paused.
	LastPauseTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=last_pause_time,json=lastPauseTime,proto3" json:"last_pause_time,omitempty"`
	// Output only. Timestamp when this Schedule was last resumed.
	// Unset if never resumed from pause.
	LastResumeTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=last_resume_time,json=lastResumeTime,proto3" json:"last_resume_time,omitempty"`
	// Required. Maximum number of runs that can be started concurrently for this
	// Schedule. This is the limit for starting the scheduled requests and not the
	// execution of the operations/jobs created by the requests (if applicable).
	MaxConcurrentRunCount int64 `` /* 130-byte string literal not displayed */
	// Optional. Whether new scheduled runs can be queued when max_concurrent_runs
	// limit is reached. If set to true, new runs will be queued instead of
	// skipped. Default to false.
	AllowQueueing bool `protobuf:"varint,12,opt,name=allow_queueing,json=allowQueueing,proto3" json:"allow_queueing,omitempty"`
	// Output only. Whether to backfill missed runs when the schedule is resumed
	// from PAUSED state. If set to true, all missed runs will be scheduled. New
	// runs will be scheduled after the backfill is complete. Default to false.
	CatchUp bool `protobuf:"varint,13,opt,name=catch_up,json=catchUp,proto3" json:"catch_up,omitempty"`
	// Output only. Response of the last scheduled run.
	// This is the response for starting the scheduled requests and not the
	// execution of the operations/jobs created by the requests (if applicable).
	// Unset if no run has been scheduled yet.
	LastScheduledRunResponse *Schedule_RunResponse `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.

func (*Schedule) Descriptor deprecated added in v1.47.0

func (*Schedule) Descriptor() ([]byte, []int)

Deprecated: Use Schedule.ProtoReflect.Descriptor instead.

func (*Schedule) GetAllowQueueing added in v1.47.0

func (x *Schedule) GetAllowQueueing() bool

func (*Schedule) GetCatchUp added in v1.47.0

func (x *Schedule) GetCatchUp() bool

func (*Schedule) GetCreatePipelineJobRequest added in v1.47.0

func (x *Schedule) GetCreatePipelineJobRequest() *CreatePipelineJobRequest

func (*Schedule) GetCreateTime added in v1.47.0

func (x *Schedule) GetCreateTime() *timestamppb.Timestamp

func (*Schedule) GetCron added in v1.47.0

func (x *Schedule) GetCron() string

func (*Schedule) GetDisplayName added in v1.47.0

func (x *Schedule) GetDisplayName() string

func (*Schedule) GetEndTime added in v1.47.0

func (x *Schedule) GetEndTime() *timestamppb.Timestamp

func (*Schedule) GetLastPauseTime added in v1.47.0

func (x *Schedule) GetLastPauseTime() *timestamppb.Timestamp

func (*Schedule) GetLastResumeTime added in v1.47.0

func (x *Schedule) GetLastResumeTime() *timestamppb.Timestamp

func (*Schedule) GetLastScheduledRunResponse added in v1.47.0

func (x *Schedule) GetLastScheduledRunResponse() *Schedule_RunResponse

func (*Schedule) GetMaxConcurrentRunCount added in v1.47.0

func (x *Schedule) GetMaxConcurrentRunCount() int64

func (*Schedule) GetMaxRunCount added in v1.47.0

func (x *Schedule) GetMaxRunCount() int64

func (*Schedule) GetName added in v1.47.0

func (x *Schedule) GetName() string

func (*Schedule) GetNextRunTime added in v1.47.0

func (x *Schedule) GetNextRunTime() *timestamppb.Timestamp

func (*Schedule) GetRequest added in v1.47.0

func (m *Schedule) GetRequest() isSchedule_Request

func (*Schedule) GetStartTime added in v1.47.0

func (x *Schedule) GetStartTime() *timestamppb.Timestamp

func (*Schedule) GetStartedRunCount added in v1.47.0

func (x *Schedule) GetStartedRunCount() int64

func (*Schedule) GetState added in v1.47.0

func (x *Schedule) GetState() Schedule_State

func (*Schedule) GetTimeSpecification added in v1.47.0

func (m *Schedule) GetTimeSpecification() isSchedule_TimeSpecification

func (*Schedule) GetUpdateTime added in v1.47.0

func (x *Schedule) GetUpdateTime() *timestamppb.Timestamp

func (*Schedule) ProtoMessage added in v1.47.0

func (*Schedule) ProtoMessage()

func (*Schedule) ProtoReflect added in v1.47.0

func (x *Schedule) ProtoReflect() protoreflect.Message

func (*Schedule) Reset added in v1.47.0

func (x *Schedule) Reset()

func (*Schedule) String added in v1.47.0

func (x *Schedule) String() string

type ScheduleServiceClient added in v1.47.0

type ScheduleServiceClient interface {
	// Creates a Schedule.
	CreateSchedule(ctx context.Context, in *CreateScheduleRequest, opts ...grpc.CallOption) (*Schedule, error)
	// Deletes a Schedule.
	DeleteSchedule(ctx context.Context, in *DeleteScheduleRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a Schedule.
	GetSchedule(ctx context.Context, in *GetScheduleRequest, opts ...grpc.CallOption) (*Schedule, error)
	// Lists Schedules in a Location.
	ListSchedules(ctx context.Context, in *ListSchedulesRequest, opts ...grpc.CallOption) (*ListSchedulesResponse, error)
	// Pauses a Schedule. Will mark
	// [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'PAUSED'. If
	// the schedule is paused, no new runs will be created. Already created runs
	// will NOT be paused or canceled.
	PauseSchedule(ctx context.Context, in *PauseScheduleRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Resumes a paused Schedule to start scheduling new runs. Will mark
	// [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'ACTIVE'.
	// Only paused Schedule can be resumed.
	//
	// When the Schedule is resumed, new runs will be scheduled starting from the
	// next execution time after the current time based on the time_specification
	// in the Schedule. If [Schedule.catchUp][] is set up true, all
	// missed runs will be scheduled for backfill first.
	ResumeSchedule(ctx context.Context, in *ResumeScheduleRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Updates an active or paused Schedule.
	//
	// When the Schedule is updated, new runs will be scheduled starting from the
	// updated next execution time after the update time based on the
	// time_specification in the updated Schedule. All unstarted runs before the
	// update time will be skipped while already created runs will NOT be paused
	// or canceled.
	UpdateSchedule(ctx context.Context, in *UpdateScheduleRequest, opts ...grpc.CallOption) (*Schedule, error)
}

ScheduleServiceClient is the client API for ScheduleService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewScheduleServiceClient added in v1.47.0

func NewScheduleServiceClient(cc grpc.ClientConnInterface) ScheduleServiceClient

type ScheduleServiceServer added in v1.47.0

type ScheduleServiceServer interface {
	// Creates a Schedule.
	CreateSchedule(context.Context, *CreateScheduleRequest) (*Schedule, error)
	// Deletes a Schedule.
	DeleteSchedule(context.Context, *DeleteScheduleRequest) (*longrunningpb.Operation, error)
	// Gets a Schedule.
	GetSchedule(context.Context, *GetScheduleRequest) (*Schedule, error)
	// Lists Schedules in a Location.
	ListSchedules(context.Context, *ListSchedulesRequest) (*ListSchedulesResponse, error)
	// Pauses a Schedule. Will mark
	// [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'PAUSED'. If
	// the schedule is paused, no new runs will be created. Already created runs
	// will NOT be paused or canceled.
	PauseSchedule(context.Context, *PauseScheduleRequest) (*emptypb.Empty, error)
	// Resumes a paused Schedule to start scheduling new runs. Will mark
	// [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'ACTIVE'.
	// Only paused Schedule can be resumed.
	//
	// When the Schedule is resumed, new runs will be scheduled starting from the
	// next execution time after the current time based on the time_specification
	// in the Schedule. If [Schedule.catchUp][] is set up true, all
	// missed runs will be scheduled for backfill first.
	ResumeSchedule(context.Context, *ResumeScheduleRequest) (*emptypb.Empty, error)
	// Updates an active or paused Schedule.
	//
	// When the Schedule is updated, new runs will be scheduled starting from the
	// updated next execution time after the update time based on the
	// time_specification in the updated Schedule. All unstarted runs before the
	// update time will be skipped while already created runs will NOT be paused
	// or canceled.
	UpdateSchedule(context.Context, *UpdateScheduleRequest) (*Schedule, error)
}

ScheduleServiceServer is the server API for ScheduleService service.

type Schedule_CreatePipelineJobRequest added in v1.47.0

type Schedule_CreatePipelineJobRequest struct {
	// Request for
	// [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob].
	// CreatePipelineJobRequest.parent field is required (format:
	// projects/{project}/locations/{location}).
	CreatePipelineJobRequest *CreatePipelineJobRequest `protobuf:"bytes,14,opt,name=create_pipeline_job_request,json=createPipelineJobRequest,proto3,oneof"`
}

type Schedule_Cron added in v1.47.0

type Schedule_Cron struct {
	// Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled
	// runs. To explicitly set a timezone to the cron tab, apply a prefix in the
	// cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}".
	// The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone
	// database. For example, "CRON_TZ=America/New_York 1 * * * *", or
	// "TZ=America/New_York 1 * * * *".
	Cron string `protobuf:"bytes,10,opt,name=cron,proto3,oneof"`
}

type Schedule_RunResponse added in v1.47.0

type Schedule_RunResponse struct {

	// The scheduled run time based on the user-specified schedule.
	ScheduledRunTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=scheduled_run_time,json=scheduledRunTime,proto3" json:"scheduled_run_time,omitempty"`
	// The response of the scheduled run.
	RunResponse string `protobuf:"bytes,2,opt,name=run_response,json=runResponse,proto3" json:"run_response,omitempty"`
	// contains filtered or unexported fields
}

Status of a scheduled run.

func (*Schedule_RunResponse) Descriptor deprecated added in v1.47.0

func (*Schedule_RunResponse) Descriptor() ([]byte, []int)

Deprecated: Use Schedule_RunResponse.ProtoReflect.Descriptor instead.

func (*Schedule_RunResponse) GetRunResponse added in v1.47.0

func (x *Schedule_RunResponse) GetRunResponse() string

func (*Schedule_RunResponse) GetScheduledRunTime added in v1.47.0

func (x *Schedule_RunResponse) GetScheduledRunTime() *timestamppb.Timestamp

func (*Schedule_RunResponse) ProtoMessage added in v1.47.0

func (*Schedule_RunResponse) ProtoMessage()

func (*Schedule_RunResponse) ProtoReflect added in v1.47.0

func (x *Schedule_RunResponse) ProtoReflect() protoreflect.Message

func (*Schedule_RunResponse) Reset added in v1.47.0

func (x *Schedule_RunResponse) Reset()

func (*Schedule_RunResponse) String added in v1.47.0

func (x *Schedule_RunResponse) String() string

type Schedule_State added in v1.47.0

type Schedule_State int32

Possible state of the schedule.

const (
	// Unspecified.
	Schedule_STATE_UNSPECIFIED Schedule_State = 0
	// The Schedule is active. Runs are being scheduled on the user-specified
	// timespec.
	Schedule_ACTIVE Schedule_State = 1
	// The schedule is paused. No new runs will be created until the schedule
	// is resumed. Already started runs will be allowed to complete.
	Schedule_PAUSED Schedule_State = 2
	// The Schedule is completed. No new runs will be scheduled. Already started
	// runs will be allowed to complete. Schedules in completed state cannot be
	// paused or resumed.
	Schedule_COMPLETED Schedule_State = 3
)

func (Schedule_State) Descriptor added in v1.47.0

func (Schedule_State) Enum added in v1.47.0

func (x Schedule_State) Enum() *Schedule_State

func (Schedule_State) EnumDescriptor deprecated added in v1.47.0

func (Schedule_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Schedule_State.Descriptor instead.

func (Schedule_State) Number added in v1.47.0

func (Schedule_State) String added in v1.47.0

func (x Schedule_State) String() string

func (Schedule_State) Type added in v1.47.0

type Scheduling

type Scheduling struct {

	// The maximum job running time. The default is 7 days.
	Timeout *durationpb.Duration `protobuf:"bytes,1,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// Restarts the entire CustomJob if a worker gets restarted.
	// This feature can be used by distributed training jobs that are not
	// resilient to workers leaving and joining a job.
	RestartJobOnWorkerRestart bool `` /* 143-byte string literal not displayed */
	// Optional. Indicates if the job should retry for internal errors after the
	// job starts running. If true, overrides
	// `Scheduling.restart_job_on_worker_restart` to false.
	DisableRetries bool `protobuf:"varint,5,opt,name=disable_retries,json=disableRetries,proto3" json:"disable_retries,omitempty"`
	// contains filtered or unexported fields
}

All parameters related to queuing and scheduling of custom jobs.

func (*Scheduling) Descriptor deprecated

func (*Scheduling) Descriptor() ([]byte, []int)

Deprecated: Use Scheduling.ProtoReflect.Descriptor instead.

func (*Scheduling) GetDisableRetries added in v1.49.0

func (x *Scheduling) GetDisableRetries() bool

func (*Scheduling) GetRestartJobOnWorkerRestart

func (x *Scheduling) GetRestartJobOnWorkerRestart() bool

func (*Scheduling) GetTimeout

func (x *Scheduling) GetTimeout() *durationpb.Duration

func (*Scheduling) ProtoMessage

func (*Scheduling) ProtoMessage()

func (*Scheduling) ProtoReflect

func (x *Scheduling) ProtoReflect() protoreflect.Message

func (*Scheduling) Reset

func (x *Scheduling) Reset()

func (*Scheduling) String

func (x *Scheduling) String() string

type Schema added in v1.57.0

type Schema struct {

	// Optional. The type of the data.
	Type Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.aiplatform.v1.Type" json:"type,omitempty"`
	// Optional. The format of the data.
	// Supported formats:
	//
	//	for NUMBER type: "float", "double"
	//	for INTEGER type: "int32", "int64"
	//	for STRING type: "email", "byte", etc
	Format string `protobuf:"bytes,7,opt,name=format,proto3" json:"format,omitempty"`
	// Optional. The title of the Schema.
	Title string `protobuf:"bytes,24,opt,name=title,proto3" json:"title,omitempty"`
	// Optional. The description of the data.
	Description string `protobuf:"bytes,8,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. Indicates if the value may be null.
	Nullable bool `protobuf:"varint,6,opt,name=nullable,proto3" json:"nullable,omitempty"`
	// Optional. Default value of the data.
	Default *structpb.Value `protobuf:"bytes,23,opt,name=default,proto3" json:"default,omitempty"`
	// Optional. SCHEMA FIELDS FOR TYPE ARRAY
	// Schema of the elements of Type.ARRAY.
	Items *Schema `protobuf:"bytes,2,opt,name=items,proto3" json:"items,omitempty"`
	// Optional. Minimum number of the elements for Type.ARRAY.
	MinItems int64 `protobuf:"varint,21,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"`
	// Optional. Maximum number of the elements for Type.ARRAY.
	MaxItems int64 `protobuf:"varint,22,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"`
	// Optional. Possible values of the element of Type.STRING with enum format.
	// For example we can define an Enum Direction as :
	// {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
	Enum []string `protobuf:"bytes,9,rep,name=enum,proto3" json:"enum,omitempty"`
	// Optional. SCHEMA FIELDS FOR TYPE OBJECT
	// Properties of Type.OBJECT.
	Properties map[string]*Schema `` /* 161-byte string literal not displayed */
	// Optional. Required properties of Type.OBJECT.
	Required []string `protobuf:"bytes,5,rep,name=required,proto3" json:"required,omitempty"`
	// Optional. Minimum number of the properties for Type.OBJECT.
	MinProperties int64 `protobuf:"varint,14,opt,name=min_properties,json=minProperties,proto3" json:"min_properties,omitempty"`
	// Optional. Maximum number of the properties for Type.OBJECT.
	MaxProperties int64 `protobuf:"varint,15,opt,name=max_properties,json=maxProperties,proto3" json:"max_properties,omitempty"`
	// Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER
	// Minimum value of the Type.INTEGER and Type.NUMBER
	Minimum float64 `protobuf:"fixed64,16,opt,name=minimum,proto3" json:"minimum,omitempty"`
	// Optional. Maximum value of the Type.INTEGER and Type.NUMBER
	Maximum float64 `protobuf:"fixed64,17,opt,name=maximum,proto3" json:"maximum,omitempty"`
	// Optional. SCHEMA FIELDS FOR TYPE STRING
	// Minimum length of the Type.STRING
	MinLength int64 `protobuf:"varint,18,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`
	// Optional. Maximum length of the Type.STRING
	MaxLength int64 `protobuf:"varint,19,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
	// Optional. Pattern of the Type.STRING to restrict a string to a regular
	// expression.
	Pattern string `protobuf:"bytes,20,opt,name=pattern,proto3" json:"pattern,omitempty"`
	// Optional. Example of the object. Will only populated when the object is the
	// root.
	Example *structpb.Value `protobuf:"bytes,4,opt,name=example,proto3" json:"example,omitempty"`
	// contains filtered or unexported fields
}

Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed.

func (*Schema) Descriptor deprecated added in v1.57.0

func (*Schema) Descriptor() ([]byte, []int)

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetDefault added in v1.67.0

func (x *Schema) GetDefault() *structpb.Value

func (*Schema) GetDescription added in v1.57.0

func (x *Schema) GetDescription() string

func (*Schema) GetEnum added in v1.57.0

func (x *Schema) GetEnum() []string

func (*Schema) GetExample added in v1.57.0

func (x *Schema) GetExample() *structpb.Value

func (*Schema) GetFormat added in v1.57.0

func (x *Schema) GetFormat() string

func (*Schema) GetItems added in v1.57.0

func (x *Schema) GetItems() *Schema

func (*Schema) GetMaxItems added in v1.67.0

func (x *Schema) GetMaxItems() int64

func (*Schema) GetMaxLength added in v1.67.0

func (x *Schema) GetMaxLength() int64

func (*Schema) GetMaxProperties added in v1.67.0

func (x *Schema) GetMaxProperties() int64

func (*Schema) GetMaximum added in v1.67.0

func (x *Schema) GetMaximum() float64

func (*Schema) GetMinItems added in v1.67.0

func (x *Schema) GetMinItems() int64

func (*Schema) GetMinLength added in v1.67.0

func (x *Schema) GetMinLength() int64

func (*Schema) GetMinProperties added in v1.67.0

func (x *Schema) GetMinProperties() int64

func (*Schema) GetMinimum added in v1.67.0

func (x *Schema) GetMinimum() float64

func (*Schema) GetNullable added in v1.57.0

func (x *Schema) GetNullable() bool

func (*Schema) GetPattern added in v1.67.0

func (x *Schema) GetPattern() string

func (*Schema) GetProperties added in v1.57.0

func (x *Schema) GetProperties() map[string]*Schema

func (*Schema) GetRequired added in v1.57.0

func (x *Schema) GetRequired() []string

func (*Schema) GetTitle added in v1.67.0

func (x *Schema) GetTitle() string

func (*Schema) GetType added in v1.57.0

func (x *Schema) GetType() Type

func (*Schema) ProtoMessage added in v1.57.0

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect added in v1.57.0

func (x *Schema) ProtoReflect() protoreflect.Message

func (*Schema) Reset added in v1.57.0

func (x *Schema) Reset()

func (*Schema) String added in v1.57.0

func (x *Schema) String() string

type SearchDataItemsRequest added in v1.29.0

type SearchDataItemsRequest struct {

	// Types that are assignable to Order:
	//
	//	*SearchDataItemsRequest_OrderByDataItem
	//	*SearchDataItemsRequest_OrderByAnnotation_
	Order isSearchDataItemsRequest_Order `protobuf_oneof:"order"`
	// Required. The resource name of the Dataset from which to search DataItems.
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`
	Dataset string `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// The resource name of a SavedQuery(annotation set in UI).
	// Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
	// All of the search will be done in the context of this SavedQuery.
	//
	// Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/dataset_service.proto.
	SavedQuery string `protobuf:"bytes,2,opt,name=saved_query,json=savedQuery,proto3" json:"saved_query,omitempty"`
	// The resource name of a DataLabelingJob.
	// Format:
	// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
	// If this field is set, all of the search will be done in the context of
	// this DataLabelingJob.
	DataLabelingJob string `protobuf:"bytes,3,opt,name=data_labeling_job,json=dataLabelingJob,proto3" json:"data_labeling_job,omitempty"`
	// An expression for filtering the DataItem that will be returned.
	//
	//   - `data_item_id` - for = or !=.
	//   - `labeled` - for = or !=.
	//   - `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that
	//     have at least one annotation with annotation_spec_id =
	//     `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob.
	//
	// For example:
	//
	// * `data_item=1`
	// * `has_annotation(5)`
	DataItemFilter string `protobuf:"bytes,4,opt,name=data_item_filter,json=dataItemFilter,proto3" json:"data_item_filter,omitempty"`
	// An expression for filtering the Annotations that will be returned per
	// DataItem.
	//   - `annotation_spec_id` - for = or !=.
	//
	// Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/dataset_service.proto.
	AnnotationsFilter string `protobuf:"bytes,5,opt,name=annotations_filter,json=annotationsFilter,proto3" json:"annotations_filter,omitempty"`
	// An expression that specifies what Annotations will be returned per
	// DataItem. Annotations satisfied either of the conditions will be returned.
	//   - `annotation_spec_id` - for = or !=.
	//
	// Must specify `saved_query_id=` - saved query id that annotations should
	// belong to.
	AnnotationFilters []string `protobuf:"bytes,11,rep,name=annotation_filters,json=annotationFilters,proto3" json:"annotation_filters,omitempty"`
	// Mask specifying which fields of
	// [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
	FieldMask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"`
	// If set, only up to this many of Annotations will be returned per
	// DataItemView. The maximum value is 1000. If not set, the maximum value will
	// be used.
	AnnotationsLimit int32 `protobuf:"varint,7,opt,name=annotations_limit,json=annotationsLimit,proto3" json:"annotations_limit,omitempty"`
	// Requested page size. Server may return fewer results than requested.
	// Default and maximum page size is 100.
	PageSize int32 `protobuf:"varint,8,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	//
	// Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/dataset_service.proto.
	OrderBy string `protobuf:"bytes,9,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// A token identifying a page of results for the server to return
	// Typically obtained via
	// [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token]
	// of the previous
	// [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems]
	// call.
	PageToken string `protobuf:"bytes,10,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems].

func (*SearchDataItemsRequest) Descriptor deprecated added in v1.29.0

func (*SearchDataItemsRequest) Descriptor() ([]byte, []int)

Deprecated: Use SearchDataItemsRequest.ProtoReflect.Descriptor instead.

func (*SearchDataItemsRequest) GetAnnotationFilters added in v1.29.0

func (x *SearchDataItemsRequest) GetAnnotationFilters() []string

func (*SearchDataItemsRequest) GetAnnotationsFilter deprecated added in v1.29.0

func (x *SearchDataItemsRequest) GetAnnotationsFilter() string

Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/dataset_service.proto.

func (*SearchDataItemsRequest) GetAnnotationsLimit added in v1.29.0

func (x *SearchDataItemsRequest) GetAnnotationsLimit() int32

func (*SearchDataItemsRequest) GetDataItemFilter added in v1.29.0

func (x *SearchDataItemsRequest) GetDataItemFilter() string

func (*SearchDataItemsRequest) GetDataLabelingJob added in v1.29.0

func (x *SearchDataItemsRequest) GetDataLabelingJob() string

func (*SearchDataItemsRequest) GetDataset added in v1.29.0

func (x *SearchDataItemsRequest) GetDataset() string

func (*SearchDataItemsRequest) GetFieldMask added in v1.29.0

func (x *SearchDataItemsRequest) GetFieldMask() *fieldmaskpb.FieldMask

func (*SearchDataItemsRequest) GetOrder added in v1.29.0

func (m *SearchDataItemsRequest) GetOrder() isSearchDataItemsRequest_Order

func (*SearchDataItemsRequest) GetOrderBy deprecated added in v1.29.0

func (x *SearchDataItemsRequest) GetOrderBy() string

Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/dataset_service.proto.

func (*SearchDataItemsRequest) GetOrderByAnnotation added in v1.29.0

func (*SearchDataItemsRequest) GetOrderByDataItem added in v1.29.0

func (x *SearchDataItemsRequest) GetOrderByDataItem() string

func (*SearchDataItemsRequest) GetPageSize added in v1.29.0

func (x *SearchDataItemsRequest) GetPageSize() int32

func (*SearchDataItemsRequest) GetPageToken added in v1.29.0

func (x *SearchDataItemsRequest) GetPageToken() string

func (*SearchDataItemsRequest) GetSavedQuery deprecated added in v1.29.0

func (x *SearchDataItemsRequest) GetSavedQuery() string

Deprecated: Marked as deprecated in google/cloud/aiplatform/v1/dataset_service.proto.

func (*SearchDataItemsRequest) ProtoMessage added in v1.29.0

func (*SearchDataItemsRequest) ProtoMessage()

func (*SearchDataItemsRequest) ProtoReflect added in v1.29.0

func (x *SearchDataItemsRequest) ProtoReflect() protoreflect.Message

func (*SearchDataItemsRequest) Reset added in v1.29.0

func (x *SearchDataItemsRequest) Reset()

func (*SearchDataItemsRequest) String added in v1.29.0

func (x *SearchDataItemsRequest) String() string

type SearchDataItemsRequest_OrderByAnnotation added in v1.29.0

type SearchDataItemsRequest_OrderByAnnotation struct {

	// Required. Saved query of the Annotation. Only Annotations belong to this
	// saved query will be considered for ordering.
	SavedQuery string `protobuf:"bytes,1,opt,name=saved_query,json=savedQuery,proto3" json:"saved_query,omitempty"`
	// A comma-separated list of annotation fields to order by, sorted in
	// ascending order. Use "desc" after a field name for descending. Must also
	// specify saved_query.
	OrderBy string `protobuf:"bytes,2,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Expression that allows ranking results based on annotation's property.

func (*SearchDataItemsRequest_OrderByAnnotation) Descriptor deprecated added in v1.29.0

func (*SearchDataItemsRequest_OrderByAnnotation) Descriptor() ([]byte, []int)

Deprecated: Use SearchDataItemsRequest_OrderByAnnotation.ProtoReflect.Descriptor instead.

func (*SearchDataItemsRequest_OrderByAnnotation) GetOrderBy added in v1.29.0

func (*SearchDataItemsRequest_OrderByAnnotation) GetSavedQuery added in v1.29.0

func (*SearchDataItemsRequest_OrderByAnnotation) ProtoMessage added in v1.29.0

func (*SearchDataItemsRequest_OrderByAnnotation) ProtoReflect added in v1.29.0

func (*SearchDataItemsRequest_OrderByAnnotation) Reset added in v1.29.0

func (*SearchDataItemsRequest_OrderByAnnotation) String added in v1.29.0

type SearchDataItemsRequest_OrderByAnnotation_ added in v1.29.0

type SearchDataItemsRequest_OrderByAnnotation_ struct {
	// Expression that allows ranking results based on annotation's property.
	OrderByAnnotation *SearchDataItemsRequest_OrderByAnnotation `protobuf:"bytes,13,opt,name=order_by_annotation,json=orderByAnnotation,proto3,oneof"`
}

type SearchDataItemsRequest_OrderByDataItem added in v1.29.0

type SearchDataItemsRequest_OrderByDataItem struct {
	// A comma-separated list of data item fields to order by, sorted in
	// ascending order. Use "desc" after a field name for descending.
	OrderByDataItem string `protobuf:"bytes,12,opt,name=order_by_data_item,json=orderByDataItem,proto3,oneof"`
}

type SearchDataItemsResponse added in v1.29.0

type SearchDataItemsResponse struct {

	// The DataItemViews read.
	DataItemViews []*DataItemView `protobuf:"bytes,1,rep,name=data_item_views,json=dataItemViews,proto3" json:"data_item_views,omitempty"`
	// A token to retrieve next page of results.
	// Pass to
	// [SearchDataItemsRequest.page_token][google.cloud.aiplatform.v1.SearchDataItemsRequest.page_token]
	// to obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems].

func (*SearchDataItemsResponse) Descriptor deprecated added in v1.29.0

func (*SearchDataItemsResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchDataItemsResponse.ProtoReflect.Descriptor instead.

func (*SearchDataItemsResponse) GetDataItemViews added in v1.29.0

func (x *SearchDataItemsResponse) GetDataItemViews() []*DataItemView

func (*SearchDataItemsResponse) GetNextPageToken added in v1.29.0

func (x *SearchDataItemsResponse) GetNextPageToken() string

func (*SearchDataItemsResponse) ProtoMessage added in v1.29.0

func (*SearchDataItemsResponse) ProtoMessage()

func (*SearchDataItemsResponse) ProtoReflect added in v1.29.0

func (x *SearchDataItemsResponse) ProtoReflect() protoreflect.Message

func (*SearchDataItemsResponse) Reset added in v1.29.0

func (x *SearchDataItemsResponse) Reset()

func (*SearchDataItemsResponse) String added in v1.29.0

func (x *SearchDataItemsResponse) String() string

type SearchFeaturesRequest

type SearchFeaturesRequest struct {

	// Required. The resource name of the Location to search Features.
	// Format:
	// `projects/{project}/locations/{location}`
	Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
	// Query string that is a conjunction of field-restricted queries and/or
	// field-restricted filters.  Field-restricted queries and filters can be
	// combined using `AND` to form a conjunction.
	//
	// A field query is in the form FIELD:QUERY. This implicitly checks if QUERY
	// exists as a substring within Feature's FIELD. The QUERY
	// and the FIELD are converted to a sequence of words (i.e. tokens) for
	// comparison. This is done by:
	//
	//   - Removing leading/trailing whitespace and tokenizing the search value.
	//     Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore
	//     `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated
	//     as a wildcard that matches characters within a token.
	//   - Ignoring case.
	//   - Prepending an asterisk to the first and appending an asterisk to the
	//     last token in QUERY.
	//
	// A QUERY must be either a singular token or a phrase. A phrase is one or
	// multiple words enclosed in double quotation marks ("). With phrases, the
	// order of the words is important. Words in the phrase must be matching in
	// order and consecutively.
	//
	// Supported FIELDs for field-restricted queries:
	//
	// * `feature_id`
	// * `description`
	// * `entity_type_id`
	//
	// Examples:
	//
	// * `feature_id: foo` --> Matches a Feature with ID containing the substring
	// `foo` (eg. `foo`, `foofeature`, `barfoo`).
	// * `feature_id: foo*feature` --> Matches a Feature with ID containing the
	// substring `foo*feature` (eg. `foobarfeature`).
	// * `feature_id: foo AND description: bar` --> Matches a Feature with ID
	// containing the substring `foo` and description containing the substring
	// `bar`.
	//
	// Besides field queries, the following exact-match filters are
	// supported. The exact-match filters do not support wildcards. Unlike
	// field-restricted queries, exact-match filters are case-sensitive.
	//
	// * `feature_id`: Supports = comparisons.
	// * `description`: Supports = comparisons. Multi-token filters should be
	// enclosed in quotes.
	// * `entity_type_id`: Supports = comparisons.
	// * `value_type`: Supports = and != comparisons.
	// * `labels`: Supports key-value equality as well as key presence.
	// * `featurestore_id`: Supports = comparisons.
	//
	// Examples:
	//
	// * `description = "foo bar"` --> Any Feature with description exactly equal
	// to `foo bar`
	//   - `value_type = DOUBLE` --> Features whose type is DOUBLE.
	//   - `labels.active = yes AND labels.env = prod` --> Features having both
	//     (active: yes) and (env: prod) labels.
	//   - `labels.env: *` --> Any Feature which has a label with `env` as the
	//     key.
	Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
	// The maximum number of Features to return. The service may return fewer
	// than this value. If unspecified, at most 100 Features will be returned.
	// The maximum value is 100; any value greater than 100 will be coerced to
	// 100.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures],
	// except `page_size`, must match the call that provided the page token.
	PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures].

func (*SearchFeaturesRequest) Descriptor deprecated

func (*SearchFeaturesRequest) Descriptor() ([]byte, []int)

Deprecated: Use SearchFeaturesRequest.ProtoReflect.Descriptor instead.

func (*SearchFeaturesRequest) GetLocation

func (x *SearchFeaturesRequest) GetLocation() string

func (*SearchFeaturesRequest) GetPageSize

func (x *SearchFeaturesRequest) GetPageSize() int32

func (*SearchFeaturesRequest) GetPageToken

func (x *SearchFeaturesRequest) GetPageToken() string

func (*SearchFeaturesRequest) GetQuery

func (x *SearchFeaturesRequest) GetQuery() string

func (*SearchFeaturesRequest) ProtoMessage

func (*SearchFeaturesRequest) ProtoMessage()

func (*SearchFeaturesRequest) ProtoReflect

func (x *SearchFeaturesRequest) ProtoReflect() protoreflect.Message

func (*SearchFeaturesRequest) Reset

func (x *SearchFeaturesRequest) Reset()

func (*SearchFeaturesRequest) String

func (x *SearchFeaturesRequest) String() string

type SearchFeaturesResponse

type SearchFeaturesResponse struct {

	// The Features matching the request.
	//
	// Fields returned:
	//
	//   - `name`
	//   - `description`
	//   - `labels`
	//   - `create_time`
	//   - `update_time`
	Features []*Feature `protobuf:"bytes,1,rep,name=features,proto3" json:"features,omitempty"`
	// A token, which can be sent as
	// [SearchFeaturesRequest.page_token][google.cloud.aiplatform.v1.SearchFeaturesRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures].

func (*SearchFeaturesResponse) Descriptor deprecated

func (*SearchFeaturesResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchFeaturesResponse.ProtoReflect.Descriptor instead.

func (*SearchFeaturesResponse) GetFeatures

func (x *SearchFeaturesResponse) GetFeatures() []*Feature

func (*SearchFeaturesResponse) GetNextPageToken

func (x *SearchFeaturesResponse) GetNextPageToken() string

func (*SearchFeaturesResponse) ProtoMessage

func (*SearchFeaturesResponse) ProtoMessage()

func (*SearchFeaturesResponse) ProtoReflect

func (x *SearchFeaturesResponse) ProtoReflect() protoreflect.Message

func (*SearchFeaturesResponse) Reset

func (x *SearchFeaturesResponse) Reset()

func (*SearchFeaturesResponse) String

func (x *SearchFeaturesResponse) String() string

type SearchMigratableResourcesRequest

type SearchMigratableResourcesRequest struct {

	// Required. The location that the migratable resources should be searched
	// from. It's the Vertex AI location that the resources can be migrated to,
	// not the resources' original location. Format:
	// `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard page size.
	// The default and maximum value is 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A filter for your search. You can use the following types of filters:
	//
	//   - Resource type filters. The following strings filter for a specific type
	//     of [MigratableResource][google.cloud.aiplatform.v1.MigratableResource]:
	//   - `ml_engine_model_version:*`
	//   - `automl_model:*`
	//   - `automl_dataset:*`
	//   - `data_labeling_dataset:*`
	//   - "Migrated or not" filters. The following strings filter for resources
	//     that either have or have not already been migrated:
	//   - `last_migrate_time:*` filters for migrated resources.
	//   - `NOT last_migrate_time:*` filters for not yet migrated resources.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources].

func (*SearchMigratableResourcesRequest) Descriptor deprecated

func (*SearchMigratableResourcesRequest) Descriptor() ([]byte, []int)

Deprecated: Use SearchMigratableResourcesRequest.ProtoReflect.Descriptor instead.

func (*SearchMigratableResourcesRequest) GetFilter

func (*SearchMigratableResourcesRequest) GetPageSize

func (x *SearchMigratableResourcesRequest) GetPageSize() int32

func (*SearchMigratableResourcesRequest) GetPageToken

func (x *SearchMigratableResourcesRequest) GetPageToken() string

func (*SearchMigratableResourcesRequest) GetParent

func (*SearchMigratableResourcesRequest) ProtoMessage

func (*SearchMigratableResourcesRequest) ProtoMessage()

func (*SearchMigratableResourcesRequest) ProtoReflect

func (*SearchMigratableResourcesRequest) Reset

func (*SearchMigratableResourcesRequest) String

type SearchMigratableResourcesResponse

type SearchMigratableResourcesResponse struct {

	// All migratable resources that can be migrated to the
	// location specified in the request.
	MigratableResources []*MigratableResource `protobuf:"bytes,1,rep,name=migratable_resources,json=migratableResources,proto3" json:"migratable_resources,omitempty"`
	// The standard next-page token.
	// The migratable_resources may not fill page_size in
	// SearchMigratableResourcesRequest even when there are subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources].

func (*SearchMigratableResourcesResponse) Descriptor deprecated

func (*SearchMigratableResourcesResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchMigratableResourcesResponse.ProtoReflect.Descriptor instead.

func (*SearchMigratableResourcesResponse) GetMigratableResources

func (x *SearchMigratableResourcesResponse) GetMigratableResources() []*MigratableResource

func (*SearchMigratableResourcesResponse) GetNextPageToken

func (x *SearchMigratableResourcesResponse) GetNextPageToken() string

func (*SearchMigratableResourcesResponse) ProtoMessage

func (*SearchMigratableResourcesResponse) ProtoMessage()

func (*SearchMigratableResourcesResponse) ProtoReflect

func (*SearchMigratableResourcesResponse) Reset

func (*SearchMigratableResourcesResponse) String

type SearchModelDeploymentMonitoringStatsAnomaliesRequest

type SearchModelDeploymentMonitoringStatsAnomaliesRequest struct {

	// Required. ModelDeploymentMonitoring Job resource name.
	// Format:
	// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
	ModelDeploymentMonitoringJob string `` /* 149-byte string literal not displayed */
	// Required. The DeployedModel ID of the
	// [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].
	DeployedModelId string `protobuf:"bytes,2,opt,name=deployed_model_id,json=deployedModelId,proto3" json:"deployed_model_id,omitempty"`
	// The feature display name. If specified, only return the stats belonging to
	// this feature. Format:
	// [ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name][google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name],
	// example: "user_destination".
	FeatureDisplayName string `protobuf:"bytes,3,opt,name=feature_display_name,json=featureDisplayName,proto3" json:"feature_display_name,omitempty"`
	// Required. Objectives of the stats to retrieve.
	Objectives []*SearchModelDeploymentMonitoringStatsAnomaliesRequest_StatsAnomaliesObjective `protobuf:"bytes,4,rep,name=objectives,proto3" json:"objectives,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,5,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token received from a previous
	// [JobService.SearchModelDeploymentMonitoringStatsAnomalies][google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies]
	// call.
	PageToken string `protobuf:"bytes,6,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// The earliest timestamp of stats being generated.
	// If not set, indicates fetching stats till the earliest possible one.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The latest timestamp of stats being generated.
	// If not set, indicates feching stats till the latest possible one.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.SearchModelDeploymentMonitoringStatsAnomalies][google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies].

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest) Descriptor deprecated

Deprecated: Use SearchModelDeploymentMonitoringStatsAnomaliesRequest.ProtoReflect.Descriptor instead.

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest) GetDeployedModelId

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest) GetEndTime

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest) GetFeatureDisplayName

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest) GetModelDeploymentMonitoringJob

func (x *SearchModelDeploymentMonitoringStatsAnomaliesRequest) GetModelDeploymentMonitoringJob() string

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest) GetPageSize

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest) GetPageToken

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest) GetStartTime

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest) ProtoMessage

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest) ProtoReflect

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest) Reset

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest) String

type SearchModelDeploymentMonitoringStatsAnomaliesRequest_StatsAnomaliesObjective

type SearchModelDeploymentMonitoringStatsAnomaliesRequest_StatsAnomaliesObjective struct {
	Type ModelDeploymentMonitoringObjectiveType `` /* 133-byte string literal not displayed */
	// If set, all attribution scores between
	// [SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time][google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time]
	// and
	// [SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time][google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time]
	// are fetched, and page token doesn't take effect in this case. Only used
	// to retrieve attribution score for the top Features which has the highest
	// attribution score in the latest monitoring run.
	TopFeatureCount int32 `protobuf:"varint,4,opt,name=top_feature_count,json=topFeatureCount,proto3" json:"top_feature_count,omitempty"`
	// contains filtered or unexported fields
}

Stats requested for specific objective.

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest_StatsAnomaliesObjective) Descriptor deprecated

Deprecated: Use SearchModelDeploymentMonitoringStatsAnomaliesRequest_StatsAnomaliesObjective.ProtoReflect.Descriptor instead.

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest_StatsAnomaliesObjective) GetTopFeatureCount

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest_StatsAnomaliesObjective) GetType

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest_StatsAnomaliesObjective) ProtoMessage

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest_StatsAnomaliesObjective) ProtoReflect

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest_StatsAnomaliesObjective) Reset

func (*SearchModelDeploymentMonitoringStatsAnomaliesRequest_StatsAnomaliesObjective) String

type SearchModelDeploymentMonitoringStatsAnomaliesResponse

type SearchModelDeploymentMonitoringStatsAnomaliesResponse struct {

	// Stats retrieved for requested objectives.
	// There are at most 1000
	// [ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats][google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats]
	// in the response.
	MonitoringStats []*ModelMonitoringStatsAnomalies `protobuf:"bytes,1,rep,name=monitoring_stats,json=monitoringStats,proto3" json:"monitoring_stats,omitempty"`
	// The page token that can be used by the next
	// [JobService.SearchModelDeploymentMonitoringStatsAnomalies][google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies]
	// call.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [JobService.SearchModelDeploymentMonitoringStatsAnomalies][google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies].

func (*SearchModelDeploymentMonitoringStatsAnomaliesResponse) Descriptor deprecated

Deprecated: Use SearchModelDeploymentMonitoringStatsAnomaliesResponse.ProtoReflect.Descriptor instead.

func (*SearchModelDeploymentMonitoringStatsAnomaliesResponse) GetMonitoringStats

func (*SearchModelDeploymentMonitoringStatsAnomaliesResponse) GetNextPageToken

func (*SearchModelDeploymentMonitoringStatsAnomaliesResponse) ProtoMessage

func (*SearchModelDeploymentMonitoringStatsAnomaliesResponse) ProtoReflect

func (*SearchModelDeploymentMonitoringStatsAnomaliesResponse) Reset

func (*SearchModelDeploymentMonitoringStatsAnomaliesResponse) String

type SearchNearestEntitiesRequest added in v1.60.0

type SearchNearestEntitiesRequest struct {

	// Required. FeatureView resource format
	// `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`
	FeatureView string `protobuf:"bytes,1,opt,name=feature_view,json=featureView,proto3" json:"feature_view,omitempty"`
	// Required. The query.
	Query *NearestNeighborQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// Optional. If set to true, the full entities (including all vector values
	// and metadata) of the nearest neighbors are returned; otherwise only entity
	// id of the nearest neighbors will be returned. Note that returning full
	// entities will significantly increase the latency and cost of the query.
	ReturnFullEntity bool `protobuf:"varint,3,opt,name=return_full_entity,json=returnFullEntity,proto3" json:"return_full_entity,omitempty"`
	// contains filtered or unexported fields
}

The request message for [FeatureOnlineStoreService.SearchNearestEntities][google.cloud.aiplatform.v1.FeatureOnlineStoreService.SearchNearestEntities].

func (*SearchNearestEntitiesRequest) Descriptor deprecated added in v1.60.0

func (*SearchNearestEntitiesRequest) Descriptor() ([]byte, []int)

Deprecated: Use SearchNearestEntitiesRequest.ProtoReflect.Descriptor instead.

func (*SearchNearestEntitiesRequest) GetFeatureView added in v1.60.0

func (x *SearchNearestEntitiesRequest) GetFeatureView() string

func (*SearchNearestEntitiesRequest) GetQuery added in v1.60.0

func (*SearchNearestEntitiesRequest) GetReturnFullEntity added in v1.60.0

func (x *SearchNearestEntitiesRequest) GetReturnFullEntity() bool

func (*SearchNearestEntitiesRequest) ProtoMessage added in v1.60.0

func (*SearchNearestEntitiesRequest) ProtoMessage()

func (*SearchNearestEntitiesRequest) ProtoReflect added in v1.60.0

func (*SearchNearestEntitiesRequest) Reset added in v1.60.0

func (x *SearchNearestEntitiesRequest) Reset()

func (*SearchNearestEntitiesRequest) String added in v1.60.0

type SearchNearestEntitiesResponse added in v1.60.0

type SearchNearestEntitiesResponse struct {

	// The nearest neighbors of the query entity.
	NearestNeighbors *NearestNeighbors `protobuf:"bytes,1,opt,name=nearest_neighbors,json=nearestNeighbors,proto3" json:"nearest_neighbors,omitempty"`
	// contains filtered or unexported fields
}

Response message for [FeatureOnlineStoreService.SearchNearestEntities][google.cloud.aiplatform.v1.FeatureOnlineStoreService.SearchNearestEntities]

func (*SearchNearestEntitiesResponse) Descriptor deprecated added in v1.60.0

func (*SearchNearestEntitiesResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchNearestEntitiesResponse.ProtoReflect.Descriptor instead.

func (*SearchNearestEntitiesResponse) GetNearestNeighbors added in v1.60.0

func (x *SearchNearestEntitiesResponse) GetNearestNeighbors() *NearestNeighbors

func (*SearchNearestEntitiesResponse) ProtoMessage added in v1.60.0

func (*SearchNearestEntitiesResponse) ProtoMessage()

func (*SearchNearestEntitiesResponse) ProtoReflect added in v1.60.0

func (*SearchNearestEntitiesResponse) Reset added in v1.60.0

func (x *SearchNearestEntitiesResponse) Reset()

func (*SearchNearestEntitiesResponse) String added in v1.60.0

type Segment added in v1.63.0

type Segment struct {

	// Output only. The index of a Part object within its parent Content object.
	PartIndex int32 `protobuf:"varint,1,opt,name=part_index,json=partIndex,proto3" json:"part_index,omitempty"`
	// Output only. Start index in the given Part, measured in bytes. Offset from
	// the start of the Part, inclusive, starting at zero.
	StartIndex int32 `protobuf:"varint,2,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
	// Output only. End index in the given Part, measured in bytes. Offset from
	// the start of the Part, exclusive, starting at zero.
	EndIndex int32 `protobuf:"varint,3,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
	// contains filtered or unexported fields
}

Segment of the content.

func (*Segment) Descriptor deprecated added in v1.63.0

func (*Segment) Descriptor() ([]byte, []int)

Deprecated: Use Segment.ProtoReflect.Descriptor instead.

func (*Segment) GetEndIndex added in v1.63.0

func (x *Segment) GetEndIndex() int32

func (*Segment) GetPartIndex added in v1.63.0

func (x *Segment) GetPartIndex() int32

func (*Segment) GetStartIndex added in v1.63.0

func (x *Segment) GetStartIndex() int32

func (*Segment) ProtoMessage added in v1.63.0

func (*Segment) ProtoMessage()

func (*Segment) ProtoReflect added in v1.63.0

func (x *Segment) ProtoReflect() protoreflect.Message

func (*Segment) Reset added in v1.63.0

func (x *Segment) Reset()

func (*Segment) String added in v1.63.0

func (x *Segment) String() string

type ServiceAccountSpec added in v1.67.0

type ServiceAccountSpec struct {

	// Required. If true, custom user-managed service account is enforced to run
	// any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses
	// the [Vertex AI Custom Code Service
	// Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
	EnableCustomServiceAccount bool `` /* 144-byte string literal not displayed */
	// Optional. Required when all below conditions are met
	//   - `enable_custom_service_account` is true;
	//   - any runtime is specified via `ResourceRuntimeSpec` on creation time,
	//     for example, Ray
	//
	// The users must have `iam.serviceAccounts.actAs` permission on this service
	// account and then the specified runtime containers will run as it.
	//
	// Do not set this field if you want to submit jobs using custom service
	// account to this PersistentResource after creation, but only specify the
	// `service_account` inside the job.
	ServiceAccount string `protobuf:"bytes,2,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// contains filtered or unexported fields
}

Configuration for the use of custom service account to run the workloads.

func (*ServiceAccountSpec) Descriptor deprecated added in v1.67.0

func (*ServiceAccountSpec) Descriptor() ([]byte, []int)

Deprecated: Use ServiceAccountSpec.ProtoReflect.Descriptor instead.

func (*ServiceAccountSpec) GetEnableCustomServiceAccount added in v1.67.0

func (x *ServiceAccountSpec) GetEnableCustomServiceAccount() bool

func (*ServiceAccountSpec) GetServiceAccount added in v1.67.0

func (x *ServiceAccountSpec) GetServiceAccount() string

func (*ServiceAccountSpec) ProtoMessage added in v1.67.0

func (*ServiceAccountSpec) ProtoMessage()

func (*ServiceAccountSpec) ProtoReflect added in v1.67.0

func (x *ServiceAccountSpec) ProtoReflect() protoreflect.Message

func (*ServiceAccountSpec) Reset added in v1.67.0

func (x *ServiceAccountSpec) Reset()

func (*ServiceAccountSpec) String added in v1.67.0

func (x *ServiceAccountSpec) String() string

type ShieldedVmConfig added in v1.67.0

type ShieldedVmConfig struct {

	// Defines whether the instance has [Secure
	// Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot)
	// enabled.
	//
	// Secure Boot helps ensure that the system only runs authentic software by
	// verifying the digital signature of all boot components, and halting the
	// boot process if signature verification fails.
	EnableSecureBoot bool `protobuf:"varint,1,opt,name=enable_secure_boot,json=enableSecureBoot,proto3" json:"enable_secure_boot,omitempty"`
	// contains filtered or unexported fields
}

A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).

func (*ShieldedVmConfig) Descriptor deprecated added in v1.67.0

func (*ShieldedVmConfig) Descriptor() ([]byte, []int)

Deprecated: Use ShieldedVmConfig.ProtoReflect.Descriptor instead.

func (*ShieldedVmConfig) GetEnableSecureBoot added in v1.67.0

func (x *ShieldedVmConfig) GetEnableSecureBoot() bool

func (*ShieldedVmConfig) ProtoMessage added in v1.67.0

func (*ShieldedVmConfig) ProtoMessage()

func (*ShieldedVmConfig) ProtoReflect added in v1.67.0

func (x *ShieldedVmConfig) ProtoReflect() protoreflect.Message

func (*ShieldedVmConfig) Reset added in v1.67.0

func (x *ShieldedVmConfig) Reset()

func (*ShieldedVmConfig) String added in v1.67.0

func (x *ShieldedVmConfig) String() string

type SmoothGradConfig

type SmoothGradConfig struct {

	// Represents the standard deviation of the gaussian kernel
	// that will be used to add noise to the interpolated inputs
	// prior to computing gradients.
	//
	// Types that are assignable to GradientNoiseSigma:
	//
	//	*SmoothGradConfig_NoiseSigma
	//	*SmoothGradConfig_FeatureNoiseSigma
	GradientNoiseSigma isSmoothGradConfig_GradientNoiseSigma `protobuf_oneof:"GradientNoiseSigma"`
	// The number of gradient samples to use for
	// approximation. The higher this number, the more accurate the gradient
	// is, but the runtime complexity increases by this factor as well.
	// Valid range of its value is [1, 50]. Defaults to 3.
	NoisySampleCount int32 `protobuf:"varint,3,opt,name=noisy_sample_count,json=noisySampleCount,proto3" json:"noisy_sample_count,omitempty"`
	// contains filtered or unexported fields
}

Config for SmoothGrad approximation of gradients.

When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf

func (*SmoothGradConfig) Descriptor deprecated

func (*SmoothGradConfig) Descriptor() ([]byte, []int)

Deprecated: Use SmoothGradConfig.ProtoReflect.Descriptor instead.

func (*SmoothGradConfig) GetFeatureNoiseSigma

func (x *SmoothGradConfig) GetFeatureNoiseSigma() *FeatureNoiseSigma

func (*SmoothGradConfig) GetGradientNoiseSigma

func (m *SmoothGradConfig) GetGradientNoiseSigma() isSmoothGradConfig_GradientNoiseSigma

func (*SmoothGradConfig) GetNoiseSigma

func (x *SmoothGradConfig) GetNoiseSigma() float32

func (*SmoothGradConfig) GetNoisySampleCount

func (x *SmoothGradConfig) GetNoisySampleCount() int32

func (*SmoothGradConfig) ProtoMessage

func (*SmoothGradConfig) ProtoMessage()

func (*SmoothGradConfig) ProtoReflect

func (x *SmoothGradConfig) ProtoReflect() protoreflect.Message

func (*SmoothGradConfig) Reset

func (x *SmoothGradConfig) Reset()

func (*SmoothGradConfig) String

func (x *SmoothGradConfig) String() string

type SmoothGradConfig_FeatureNoiseSigma

type SmoothGradConfig_FeatureNoiseSigma struct {
	// This is similar to
	// [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma],
	// but provides additional flexibility. A separate noise sigma can be
	// provided for each feature, which is useful if their distributions are
	// different. No noise is added to features that are not set. If this field
	// is unset,
	// [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma]
	// will be used for all features.
	FeatureNoiseSigma *FeatureNoiseSigma `protobuf:"bytes,2,opt,name=feature_noise_sigma,json=featureNoiseSigma,proto3,oneof"`
}

type SmoothGradConfig_NoiseSigma

type SmoothGradConfig_NoiseSigma struct {
	// This is a single float value and will be used to add noise to all the
	// features. Use this field when all features are normalized to have the
	// same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where
	// features are normalized to have 0-mean and 1-variance. Learn more about
	// [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization).
	//
	// For best results the recommended value is about 10% - 20% of the standard
	// deviation of the input feature. Refer to section 3.2 of the SmoothGrad
	// paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1.
	//
	// If the distribution is different per feature, set
	// [feature_noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.feature_noise_sigma]
	// instead for each feature.
	NoiseSigma float32 `protobuf:"fixed32,1,opt,name=noise_sigma,json=noiseSigma,proto3,oneof"`
}

type SpecialistPool

type SpecialistPool struct {

	// Required. The resource name of the SpecialistPool.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The user-defined name of the SpecialistPool.
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	// This field should be unique on project-level.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. The number of managers in this SpecialistPool.
	SpecialistManagersCount int32 `` /* 133-byte string literal not displayed */
	// The email addresses of the managers in the SpecialistPool.
	SpecialistManagerEmails []string `` /* 132-byte string literal not displayed */
	// Output only. The resource name of the pending data labeling jobs.
	PendingDataLabelingJobs []string `` /* 134-byte string literal not displayed */
	// The email addresses of workers in the SpecialistPool.
	SpecialistWorkerEmails []string `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

SpecialistPool represents customers' own workforce to work on their data labeling jobs. It includes a group of specialist managers and workers. Managers are responsible for managing the workers in this pool as well as customers' data labeling jobs associated with this pool. Customers create specialist pool as well as start data labeling jobs on Cloud, managers and workers handle the jobs using CrowdCompute console.

func (*SpecialistPool) Descriptor deprecated

func (*SpecialistPool) Descriptor() ([]byte, []int)

Deprecated: Use SpecialistPool.ProtoReflect.Descriptor instead.

func (*SpecialistPool) GetDisplayName

func (x *SpecialistPool) GetDisplayName() string

func (*SpecialistPool) GetName

func (x *SpecialistPool) GetName() string

func (*SpecialistPool) GetPendingDataLabelingJobs

func (x *SpecialistPool) GetPendingDataLabelingJobs() []string

func (*SpecialistPool) GetSpecialistManagerEmails

func (x *SpecialistPool) GetSpecialistManagerEmails() []string

func (*SpecialistPool) GetSpecialistManagersCount

func (x *SpecialistPool) GetSpecialistManagersCount() int32

func (*SpecialistPool) GetSpecialistWorkerEmails

func (x *SpecialistPool) GetSpecialistWorkerEmails() []string

func (*SpecialistPool) ProtoMessage

func (*SpecialistPool) ProtoMessage()

func (*SpecialistPool) ProtoReflect

func (x *SpecialistPool) ProtoReflect() protoreflect.Message

func (*SpecialistPool) Reset

func (x *SpecialistPool) Reset()

func (*SpecialistPool) String

func (x *SpecialistPool) String() string

type SpecialistPoolServiceClient

type SpecialistPoolServiceClient interface {
	// Creates a SpecialistPool.
	CreateSpecialistPool(ctx context.Context, in *CreateSpecialistPoolRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a SpecialistPool.
	GetSpecialistPool(ctx context.Context, in *GetSpecialistPoolRequest, opts ...grpc.CallOption) (*SpecialistPool, error)
	// Lists SpecialistPools in a Location.
	ListSpecialistPools(ctx context.Context, in *ListSpecialistPoolsRequest, opts ...grpc.CallOption) (*ListSpecialistPoolsResponse, error)
	// Deletes a SpecialistPool as well as all Specialists in the pool.
	DeleteSpecialistPool(ctx context.Context, in *DeleteSpecialistPoolRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates a SpecialistPool.
	UpdateSpecialistPool(ctx context.Context, in *UpdateSpecialistPoolRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

SpecialistPoolServiceClient is the client API for SpecialistPoolService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type SpecialistPoolServiceServer

type SpecialistPoolServiceServer interface {
	// Creates a SpecialistPool.
	CreateSpecialistPool(context.Context, *CreateSpecialistPoolRequest) (*longrunningpb.Operation, error)
	// Gets a SpecialistPool.
	GetSpecialistPool(context.Context, *GetSpecialistPoolRequest) (*SpecialistPool, error)
	// Lists SpecialistPools in a Location.
	ListSpecialistPools(context.Context, *ListSpecialistPoolsRequest) (*ListSpecialistPoolsResponse, error)
	// Deletes a SpecialistPool as well as all Specialists in the pool.
	DeleteSpecialistPool(context.Context, *DeleteSpecialistPoolRequest) (*longrunningpb.Operation, error)
	// Updates a SpecialistPool.
	UpdateSpecialistPool(context.Context, *UpdateSpecialistPoolRequest) (*longrunningpb.Operation, error)
}

SpecialistPoolServiceServer is the server API for SpecialistPoolService service.

type StartNotebookRuntimeOperationMetadata added in v1.67.0

type StartNotebookRuntimeOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// A human-readable message that shows the intermediate progress details of
	// NotebookRuntime.
	ProgressMessage string `protobuf:"bytes,2,opt,name=progress_message,json=progressMessage,proto3" json:"progress_message,omitempty"`
	// contains filtered or unexported fields
}

Metadata information for [NotebookService.StartNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.StartNotebookRuntime].

func (*StartNotebookRuntimeOperationMetadata) Descriptor deprecated added in v1.67.0

func (*StartNotebookRuntimeOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use StartNotebookRuntimeOperationMetadata.ProtoReflect.Descriptor instead.

func (*StartNotebookRuntimeOperationMetadata) GetGenericMetadata added in v1.67.0

func (*StartNotebookRuntimeOperationMetadata) GetProgressMessage added in v1.67.0

func (x *StartNotebookRuntimeOperationMetadata) GetProgressMessage() string

func (*StartNotebookRuntimeOperationMetadata) ProtoMessage added in v1.67.0

func (*StartNotebookRuntimeOperationMetadata) ProtoMessage()

func (*StartNotebookRuntimeOperationMetadata) ProtoReflect added in v1.67.0

func (*StartNotebookRuntimeOperationMetadata) Reset added in v1.67.0

func (*StartNotebookRuntimeOperationMetadata) String added in v1.67.0

type StartNotebookRuntimeRequest added in v1.67.0

type StartNotebookRuntimeRequest struct {

	// Required. The name of the NotebookRuntime resource to be started.
	// Instead of checking whether the name is in valid NotebookRuntime resource
	// name format, directly throw NotFound exception if there is no such
	// NotebookRuntime in spanner.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [NotebookService.StartNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.StartNotebookRuntime].

func (*StartNotebookRuntimeRequest) Descriptor deprecated added in v1.67.0

func (*StartNotebookRuntimeRequest) Descriptor() ([]byte, []int)

Deprecated: Use StartNotebookRuntimeRequest.ProtoReflect.Descriptor instead.

func (*StartNotebookRuntimeRequest) GetName added in v1.67.0

func (x *StartNotebookRuntimeRequest) GetName() string

func (*StartNotebookRuntimeRequest) ProtoMessage added in v1.67.0

func (*StartNotebookRuntimeRequest) ProtoMessage()

func (*StartNotebookRuntimeRequest) ProtoReflect added in v1.67.0

func (*StartNotebookRuntimeRequest) Reset added in v1.67.0

func (x *StartNotebookRuntimeRequest) Reset()

func (*StartNotebookRuntimeRequest) String added in v1.67.0

func (x *StartNotebookRuntimeRequest) String() string

type StartNotebookRuntimeResponse added in v1.67.0

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

Response message for [NotebookService.StartNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.StartNotebookRuntime].

func (*StartNotebookRuntimeResponse) Descriptor deprecated added in v1.67.0

func (*StartNotebookRuntimeResponse) Descriptor() ([]byte, []int)

Deprecated: Use StartNotebookRuntimeResponse.ProtoReflect.Descriptor instead.

func (*StartNotebookRuntimeResponse) ProtoMessage added in v1.67.0

func (*StartNotebookRuntimeResponse) ProtoMessage()

func (*StartNotebookRuntimeResponse) ProtoReflect added in v1.67.0

func (*StartNotebookRuntimeResponse) Reset added in v1.67.0

func (x *StartNotebookRuntimeResponse) Reset()

func (*StartNotebookRuntimeResponse) String added in v1.67.0

type StopTrialRequest

type StopTrialRequest struct {

	// Required. The Trial's name.
	// Format:
	// `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.StopTrial][google.cloud.aiplatform.v1.VizierService.StopTrial].

func (*StopTrialRequest) Descriptor deprecated

func (*StopTrialRequest) Descriptor() ([]byte, []int)

Deprecated: Use StopTrialRequest.ProtoReflect.Descriptor instead.

func (*StopTrialRequest) GetName

func (x *StopTrialRequest) GetName() string

func (*StopTrialRequest) ProtoMessage

func (*StopTrialRequest) ProtoMessage()

func (*StopTrialRequest) ProtoReflect

func (x *StopTrialRequest) ProtoReflect() protoreflect.Message

func (*StopTrialRequest) Reset

func (x *StopTrialRequest) Reset()

func (*StopTrialRequest) String

func (x *StopTrialRequest) String() string

type StratifiedSplit

type StratifiedSplit struct {

	// The fraction of the input data that is to be used to train the Model.
	TrainingFraction float64 `protobuf:"fixed64,1,opt,name=training_fraction,json=trainingFraction,proto3" json:"training_fraction,omitempty"`
	// The fraction of the input data that is to be used to validate the Model.
	ValidationFraction float64 `protobuf:"fixed64,2,opt,name=validation_fraction,json=validationFraction,proto3" json:"validation_fraction,omitempty"`
	// The fraction of the input data that is to be used to evaluate the Model.
	TestFraction float64 `protobuf:"fixed64,3,opt,name=test_fraction,json=testFraction,proto3" json:"test_fraction,omitempty"`
	// Required. The key is a name of one of the Dataset's data columns.
	// The key provided must be for a categorical column.
	Key string `protobuf:"bytes,4,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

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. The fraction values determine the relative sizes of the splits.

For example, if the specified column has three values, with 50% of the rows having value "A", 25% value "B", and 25% value "C", and the split fractions are specified as 80/10/10, then the training set will constitute 80% of the training data, with about 50% of the training set rows having the value "A" for the specified column, about 25% having the value "B", and about 25% having the value "C".

Only the top 500 occurring values are used; any values not in the top 500 values are randomly assigned to a split. If less than three rows contain a specific value, those rows are randomly assigned.

Supported only for tabular Datasets.

func (*StratifiedSplit) Descriptor deprecated

func (*StratifiedSplit) Descriptor() ([]byte, []int)

Deprecated: Use StratifiedSplit.ProtoReflect.Descriptor instead.

func (*StratifiedSplit) GetKey

func (x *StratifiedSplit) GetKey() string

func (*StratifiedSplit) GetTestFraction

func (x *StratifiedSplit) GetTestFraction() float64

func (*StratifiedSplit) GetTrainingFraction

func (x *StratifiedSplit) GetTrainingFraction() float64

func (*StratifiedSplit) GetValidationFraction

func (x *StratifiedSplit) GetValidationFraction() float64

func (*StratifiedSplit) ProtoMessage

func (*StratifiedSplit) ProtoMessage()

func (*StratifiedSplit) ProtoReflect

func (x *StratifiedSplit) ProtoReflect() protoreflect.Message

func (*StratifiedSplit) Reset

func (x *StratifiedSplit) Reset()

func (*StratifiedSplit) String

func (x *StratifiedSplit) String() string

type StreamDirectPredictRequest added in v1.59.0

type StreamDirectPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Optional. The prediction input.
	Inputs []*Tensor `protobuf:"bytes,2,rep,name=inputs,proto3" json:"inputs,omitempty"`
	// Optional. The parameters that govern the prediction.
	Parameters *Tensor `protobuf:"bytes,3,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.StreamDirectPredict][google.cloud.aiplatform.v1.PredictionService.StreamDirectPredict].

The first message must contain [endpoint][google.cloud.aiplatform.v1.StreamDirectPredictRequest.endpoint] field and optionally [input][]. The subsequent messages must contain [input][].

func (*StreamDirectPredictRequest) Descriptor deprecated added in v1.59.0

func (*StreamDirectPredictRequest) Descriptor() ([]byte, []int)

Deprecated: Use StreamDirectPredictRequest.ProtoReflect.Descriptor instead.

func (*StreamDirectPredictRequest) GetEndpoint added in v1.59.0

func (x *StreamDirectPredictRequest) GetEndpoint() string

func (*StreamDirectPredictRequest) GetInputs added in v1.59.0

func (x *StreamDirectPredictRequest) GetInputs() []*Tensor

func (*StreamDirectPredictRequest) GetParameters added in v1.59.0

func (x *StreamDirectPredictRequest) GetParameters() *Tensor

func (*StreamDirectPredictRequest) ProtoMessage added in v1.59.0

func (*StreamDirectPredictRequest) ProtoMessage()

func (*StreamDirectPredictRequest) ProtoReflect added in v1.59.0

func (*StreamDirectPredictRequest) Reset added in v1.59.0

func (x *StreamDirectPredictRequest) Reset()

func (*StreamDirectPredictRequest) String added in v1.59.0

func (x *StreamDirectPredictRequest) String() string

type StreamDirectPredictResponse added in v1.59.0

type StreamDirectPredictResponse struct {

	// The prediction output.
	Outputs []*Tensor `protobuf:"bytes,1,rep,name=outputs,proto3" json:"outputs,omitempty"`
	// The parameters that govern the prediction.
	Parameters *Tensor `protobuf:"bytes,2,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.StreamDirectPredict][google.cloud.aiplatform.v1.PredictionService.StreamDirectPredict].

func (*StreamDirectPredictResponse) Descriptor deprecated added in v1.59.0

func (*StreamDirectPredictResponse) Descriptor() ([]byte, []int)

Deprecated: Use StreamDirectPredictResponse.ProtoReflect.Descriptor instead.

func (*StreamDirectPredictResponse) GetOutputs added in v1.59.0

func (x *StreamDirectPredictResponse) GetOutputs() []*Tensor

func (*StreamDirectPredictResponse) GetParameters added in v1.59.0

func (x *StreamDirectPredictResponse) GetParameters() *Tensor

func (*StreamDirectPredictResponse) ProtoMessage added in v1.59.0

func (*StreamDirectPredictResponse) ProtoMessage()

func (*StreamDirectPredictResponse) ProtoReflect added in v1.59.0

func (*StreamDirectPredictResponse) Reset added in v1.59.0

func (x *StreamDirectPredictResponse) Reset()

func (*StreamDirectPredictResponse) String added in v1.59.0

func (x *StreamDirectPredictResponse) String() string

type StreamDirectRawPredictRequest added in v1.59.0

type StreamDirectRawPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Optional. Fully qualified name of the API method being invoked to perform
	// predictions.
	//
	// Format:
	// `/namespace.Service/Method/`
	// Example:
	// `/tensorflow.serving.PredictionService/Predict`
	MethodName string `protobuf:"bytes,2,opt,name=method_name,json=methodName,proto3" json:"method_name,omitempty"`
	// Optional. The prediction input.
	Input []byte `protobuf:"bytes,3,opt,name=input,proto3" json:"input,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.StreamDirectRawPredict][google.cloud.aiplatform.v1.PredictionService.StreamDirectRawPredict].

The first message must contain [endpoint][google.cloud.aiplatform.v1.StreamDirectRawPredictRequest.endpoint] and [method_name][google.cloud.aiplatform.v1.StreamDirectRawPredictRequest.method_name] fields and optionally [input][google.cloud.aiplatform.v1.StreamDirectRawPredictRequest.input]. The subsequent messages must contain [input][google.cloud.aiplatform.v1.StreamDirectRawPredictRequest.input]. [method_name][google.cloud.aiplatform.v1.StreamDirectRawPredictRequest.method_name] in the subsequent messages have no effect.

func (*StreamDirectRawPredictRequest) Descriptor deprecated added in v1.59.0

func (*StreamDirectRawPredictRequest) Descriptor() ([]byte, []int)

Deprecated: Use StreamDirectRawPredictRequest.ProtoReflect.Descriptor instead.

func (*StreamDirectRawPredictRequest) GetEndpoint added in v1.59.0

func (x *StreamDirectRawPredictRequest) GetEndpoint() string

func (*StreamDirectRawPredictRequest) GetInput added in v1.59.0

func (x *StreamDirectRawPredictRequest) GetInput() []byte

func (*StreamDirectRawPredictRequest) GetMethodName added in v1.59.0

func (x *StreamDirectRawPredictRequest) GetMethodName() string

func (*StreamDirectRawPredictRequest) ProtoMessage added in v1.59.0

func (*StreamDirectRawPredictRequest) ProtoMessage()

func (*StreamDirectRawPredictRequest) ProtoReflect added in v1.59.0

func (*StreamDirectRawPredictRequest) Reset added in v1.59.0

func (x *StreamDirectRawPredictRequest) Reset()

func (*StreamDirectRawPredictRequest) String added in v1.59.0

type StreamDirectRawPredictResponse added in v1.59.0

type StreamDirectRawPredictResponse struct {

	// The prediction output.
	Output []byte `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.StreamDirectRawPredict][google.cloud.aiplatform.v1.PredictionService.StreamDirectRawPredict].

func (*StreamDirectRawPredictResponse) Descriptor deprecated added in v1.59.0

func (*StreamDirectRawPredictResponse) Descriptor() ([]byte, []int)

Deprecated: Use StreamDirectRawPredictResponse.ProtoReflect.Descriptor instead.

func (*StreamDirectRawPredictResponse) GetOutput added in v1.59.0

func (x *StreamDirectRawPredictResponse) GetOutput() []byte

func (*StreamDirectRawPredictResponse) ProtoMessage added in v1.59.0

func (*StreamDirectRawPredictResponse) ProtoMessage()

func (*StreamDirectRawPredictResponse) ProtoReflect added in v1.59.0

func (*StreamDirectRawPredictResponse) Reset added in v1.59.0

func (x *StreamDirectRawPredictResponse) Reset()

func (*StreamDirectRawPredictResponse) String added in v1.59.0

type StreamRawPredictRequest added in v1.59.0

type StreamRawPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// The prediction input. Supports HTTP headers and arbitrary data payload.
	HttpBody *httpbody.HttpBody `protobuf:"bytes,2,opt,name=http_body,json=httpBody,proto3" json:"http_body,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.StreamRawPredict][google.cloud.aiplatform.v1.PredictionService.StreamRawPredict].

func (*StreamRawPredictRequest) Descriptor deprecated added in v1.59.0

func (*StreamRawPredictRequest) Descriptor() ([]byte, []int)

Deprecated: Use StreamRawPredictRequest.ProtoReflect.Descriptor instead.

func (*StreamRawPredictRequest) GetEndpoint added in v1.59.0

func (x *StreamRawPredictRequest) GetEndpoint() string

func (*StreamRawPredictRequest) GetHttpBody added in v1.59.0

func (x *StreamRawPredictRequest) GetHttpBody() *httpbody.HttpBody

func (*StreamRawPredictRequest) ProtoMessage added in v1.59.0

func (*StreamRawPredictRequest) ProtoMessage()

func (*StreamRawPredictRequest) ProtoReflect added in v1.59.0

func (x *StreamRawPredictRequest) ProtoReflect() protoreflect.Message

func (*StreamRawPredictRequest) Reset added in v1.59.0

func (x *StreamRawPredictRequest) Reset()

func (*StreamRawPredictRequest) String added in v1.59.0

func (x *StreamRawPredictRequest) String() string

type StreamingPredictRequest added in v1.48.0

type StreamingPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// The prediction input.
	Inputs []*Tensor `protobuf:"bytes,2,rep,name=inputs,proto3" json:"inputs,omitempty"`
	// The parameters that govern the prediction.
	Parameters *Tensor `protobuf:"bytes,3,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.StreamingPredict][google.cloud.aiplatform.v1.PredictionService.StreamingPredict].

The first message must contain [endpoint][google.cloud.aiplatform.v1.StreamingPredictRequest.endpoint] field and optionally [input][]. The subsequent messages must contain [input][].

func (*StreamingPredictRequest) Descriptor deprecated added in v1.48.0

func (*StreamingPredictRequest) Descriptor() ([]byte, []int)

Deprecated: Use StreamingPredictRequest.ProtoReflect.Descriptor instead.

func (*StreamingPredictRequest) GetEndpoint added in v1.48.0

func (x *StreamingPredictRequest) GetEndpoint() string

func (*StreamingPredictRequest) GetInputs added in v1.48.0

func (x *StreamingPredictRequest) GetInputs() []*Tensor

func (*StreamingPredictRequest) GetParameters added in v1.48.0

func (x *StreamingPredictRequest) GetParameters() *Tensor

func (*StreamingPredictRequest) ProtoMessage added in v1.48.0

func (*StreamingPredictRequest) ProtoMessage()

func (*StreamingPredictRequest) ProtoReflect added in v1.48.0

func (x *StreamingPredictRequest) ProtoReflect() protoreflect.Message

func (*StreamingPredictRequest) Reset added in v1.48.0

func (x *StreamingPredictRequest) Reset()

func (*StreamingPredictRequest) String added in v1.48.0

func (x *StreamingPredictRequest) String() string

type StreamingPredictResponse added in v1.48.0

type StreamingPredictResponse struct {

	// The prediction output.
	Outputs []*Tensor `protobuf:"bytes,1,rep,name=outputs,proto3" json:"outputs,omitempty"`
	// The parameters that govern the prediction.
	Parameters *Tensor `protobuf:"bytes,2,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.StreamingPredict][google.cloud.aiplatform.v1.PredictionService.StreamingPredict].

func (*StreamingPredictResponse) Descriptor deprecated added in v1.48.0

func (*StreamingPredictResponse) Descriptor() ([]byte, []int)

Deprecated: Use StreamingPredictResponse.ProtoReflect.Descriptor instead.

func (*StreamingPredictResponse) GetOutputs added in v1.48.0

func (x *StreamingPredictResponse) GetOutputs() []*Tensor

func (*StreamingPredictResponse) GetParameters added in v1.48.0

func (x *StreamingPredictResponse) GetParameters() *Tensor

func (*StreamingPredictResponse) ProtoMessage added in v1.48.0

func (*StreamingPredictResponse) ProtoMessage()

func (*StreamingPredictResponse) ProtoReflect added in v1.48.0

func (x *StreamingPredictResponse) ProtoReflect() protoreflect.Message

func (*StreamingPredictResponse) Reset added in v1.48.0

func (x *StreamingPredictResponse) Reset()

func (*StreamingPredictResponse) String added in v1.48.0

func (x *StreamingPredictResponse) String() string

type StreamingRawPredictRequest added in v1.55.0

type StreamingRawPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Fully qualified name of the API method being invoked to perform
	// predictions.
	//
	// Format:
	// `/namespace.Service/Method/`
	// Example:
	// `/tensorflow.serving.PredictionService/Predict`
	MethodName string `protobuf:"bytes,2,opt,name=method_name,json=methodName,proto3" json:"method_name,omitempty"`
	// The prediction input.
	Input []byte `protobuf:"bytes,3,opt,name=input,proto3" json:"input,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.StreamingRawPredict][google.cloud.aiplatform.v1.PredictionService.StreamingRawPredict].

The first message must contain [endpoint][google.cloud.aiplatform.v1.StreamingRawPredictRequest.endpoint] and [method_name][google.cloud.aiplatform.v1.StreamingRawPredictRequest.method_name] fields and optionally [input][google.cloud.aiplatform.v1.StreamingRawPredictRequest.input]. The subsequent messages must contain [input][google.cloud.aiplatform.v1.StreamingRawPredictRequest.input]. [method_name][google.cloud.aiplatform.v1.StreamingRawPredictRequest.method_name] in the subsequent messages have no effect.

func (*StreamingRawPredictRequest) Descriptor deprecated added in v1.55.0

func (*StreamingRawPredictRequest) Descriptor() ([]byte, []int)

Deprecated: Use StreamingRawPredictRequest.ProtoReflect.Descriptor instead.

func (*StreamingRawPredictRequest) GetEndpoint added in v1.55.0

func (x *StreamingRawPredictRequest) GetEndpoint() string

func (*StreamingRawPredictRequest) GetInput added in v1.55.0

func (x *StreamingRawPredictRequest) GetInput() []byte

func (*StreamingRawPredictRequest) GetMethodName added in v1.55.0

func (x *StreamingRawPredictRequest) GetMethodName() string

func (*StreamingRawPredictRequest) ProtoMessage added in v1.55.0

func (*StreamingRawPredictRequest) ProtoMessage()

func (*StreamingRawPredictRequest) ProtoReflect added in v1.55.0

func (*StreamingRawPredictRequest) Reset added in v1.55.0

func (x *StreamingRawPredictRequest) Reset()

func (*StreamingRawPredictRequest) String added in v1.55.0

func (x *StreamingRawPredictRequest) String() string

type StreamingRawPredictResponse added in v1.55.0

type StreamingRawPredictResponse struct {

	// The prediction output.
	Output []byte `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.StreamingRawPredict][google.cloud.aiplatform.v1.PredictionService.StreamingRawPredict].

func (*StreamingRawPredictResponse) Descriptor deprecated added in v1.55.0

func (*StreamingRawPredictResponse) Descriptor() ([]byte, []int)

Deprecated: Use StreamingRawPredictResponse.ProtoReflect.Descriptor instead.

func (*StreamingRawPredictResponse) GetOutput added in v1.55.0

func (x *StreamingRawPredictResponse) GetOutput() []byte

func (*StreamingRawPredictResponse) ProtoMessage added in v1.55.0

func (*StreamingRawPredictResponse) ProtoMessage()

func (*StreamingRawPredictResponse) ProtoReflect added in v1.55.0

func (*StreamingRawPredictResponse) Reset added in v1.55.0

func (x *StreamingRawPredictResponse) Reset()

func (*StreamingRawPredictResponse) String added in v1.55.0

func (x *StreamingRawPredictResponse) String() string

type StreamingReadFeatureValuesRequest

type StreamingReadFeatureValuesRequest struct {

	// Required. The resource name of the entities' type.
	// Value format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
	// For example,
	// for a machine learning model predicting user clicks on a website, an
	// EntityType ID could be `user`.
	EntityType string `protobuf:"bytes,1,opt,name=entity_type,json=entityType,proto3" json:"entity_type,omitempty"`
	// Required. IDs of entities to read Feature values of. The maximum number of
	// IDs is 100. For example, for a machine learning model predicting user
	// clicks on a website, an entity ID could be `user_123`.
	EntityIds []string `protobuf:"bytes,2,rep,name=entity_ids,json=entityIds,proto3" json:"entity_ids,omitempty"`
	// Required. Selector choosing Features of the target EntityType. Feature IDs
	// will be deduplicated.
	FeatureSelector *FeatureSelector `protobuf:"bytes,3,opt,name=feature_selector,json=featureSelector,proto3" json:"feature_selector,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreOnlineServingService.StreamingFeatureValuesRead][].

func (*StreamingReadFeatureValuesRequest) Descriptor deprecated

func (*StreamingReadFeatureValuesRequest) Descriptor() ([]byte, []int)

Deprecated: Use StreamingReadFeatureValuesRequest.ProtoReflect.Descriptor instead.

func (*StreamingReadFeatureValuesRequest) GetEntityIds

func (x *StreamingReadFeatureValuesRequest) GetEntityIds() []string

func (*StreamingReadFeatureValuesRequest) GetEntityType

func (x *StreamingReadFeatureValuesRequest) GetEntityType() string

func (*StreamingReadFeatureValuesRequest) GetFeatureSelector

func (x *StreamingReadFeatureValuesRequest) GetFeatureSelector() *FeatureSelector

func (*StreamingReadFeatureValuesRequest) ProtoMessage

func (*StreamingReadFeatureValuesRequest) ProtoMessage()

func (*StreamingReadFeatureValuesRequest) ProtoReflect

func (*StreamingReadFeatureValuesRequest) Reset

func (*StreamingReadFeatureValuesRequest) String

type StringArray

type StringArray struct {

	// A list of string values.
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

A list of string values.

func (*StringArray) Descriptor deprecated

func (*StringArray) Descriptor() ([]byte, []int)

Deprecated: Use StringArray.ProtoReflect.Descriptor instead.

func (*StringArray) GetValues

func (x *StringArray) GetValues() []string

func (*StringArray) ProtoMessage

func (*StringArray) ProtoMessage()

func (*StringArray) ProtoReflect

func (x *StringArray) ProtoReflect() protoreflect.Message

func (*StringArray) Reset

func (x *StringArray) Reset()

func (*StringArray) String

func (x *StringArray) String() string

type Study

type Study struct {

	// Output only. The name of a study. The study's globally unique identifier.
	// Format: `projects/{project}/locations/{location}/studies/{study}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Describes the Study, default value is empty string.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Required. Configuration of the Study.
	StudySpec *StudySpec `protobuf:"bytes,3,opt,name=study_spec,json=studySpec,proto3" json:"study_spec,omitempty"`
	// Output only. The detailed state of a Study.
	State Study_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.Study_State" json:"state,omitempty"`
	// Output only. Time at which the study was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. A human readable reason why the Study is inactive.
	// This should be empty if a study is ACTIVE or COMPLETED.
	InactiveReason string `protobuf:"bytes,6,opt,name=inactive_reason,json=inactiveReason,proto3" json:"inactive_reason,omitempty"`
	// contains filtered or unexported fields
}

A message representing a Study.

func (*Study) Descriptor deprecated

func (*Study) Descriptor() ([]byte, []int)

Deprecated: Use Study.ProtoReflect.Descriptor instead.

func (*Study) GetCreateTime

func (x *Study) GetCreateTime() *timestamppb.Timestamp

func (*Study) GetDisplayName

func (x *Study) GetDisplayName() string

func (*Study) GetInactiveReason

func (x *Study) GetInactiveReason() string

func (*Study) GetName

func (x *Study) GetName() string

func (*Study) GetState

func (x *Study) GetState() Study_State

func (*Study) GetStudySpec

func (x *Study) GetStudySpec() *StudySpec

func (*Study) ProtoMessage

func (*Study) ProtoMessage()

func (*Study) ProtoReflect

func (x *Study) ProtoReflect() protoreflect.Message

func (*Study) Reset

func (x *Study) Reset()

func (*Study) String

func (x *Study) String() string

type StudySpec

type StudySpec struct {

	// Types that are assignable to AutomatedStoppingSpec:
	//
	//	*StudySpec_DecayCurveStoppingSpec
	//	*StudySpec_MedianAutomatedStoppingSpec_
	//	*StudySpec_ConvexAutomatedStoppingSpec_
	AutomatedStoppingSpec isStudySpec_AutomatedStoppingSpec `protobuf_oneof:"automated_stopping_spec"`
	// Required. Metric specs for the Study.
	Metrics []*StudySpec_MetricSpec `protobuf:"bytes,1,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// Required. The set of parameters to tune.
	Parameters []*StudySpec_ParameterSpec `protobuf:"bytes,2,rep,name=parameters,proto3" json:"parameters,omitempty"`
	// The search algorithm specified for the Study.
	Algorithm StudySpec_Algorithm `protobuf:"varint,3,opt,name=algorithm,proto3,enum=google.cloud.aiplatform.v1.StudySpec_Algorithm" json:"algorithm,omitempty"`
	// The observation noise level of the study.
	// Currently only supported by the Vertex AI Vizier service. Not supported by
	// HyperparameterTuningJob or TrainingPipeline.
	ObservationNoise StudySpec_ObservationNoise `` /* 169-byte string literal not displayed */
	// Describe which measurement selection type will be used
	MeasurementSelectionType StudySpec_MeasurementSelectionType `` /* 203-byte string literal not displayed */
	// Conditions for automated stopping of a Study. Enable automated stopping by
	// configuring at least one condition.
	StudyStoppingConfig *StudySpec_StudyStoppingConfig `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents specification of a Study.

func (*StudySpec) Descriptor deprecated

func (*StudySpec) Descriptor() ([]byte, []int)

Deprecated: Use StudySpec.ProtoReflect.Descriptor instead.

func (*StudySpec) GetAlgorithm

func (x *StudySpec) GetAlgorithm() StudySpec_Algorithm

func (*StudySpec) GetAutomatedStoppingSpec

func (m *StudySpec) GetAutomatedStoppingSpec() isStudySpec_AutomatedStoppingSpec

func (*StudySpec) GetConvexAutomatedStoppingSpec

func (x *StudySpec) GetConvexAutomatedStoppingSpec() *StudySpec_ConvexAutomatedStoppingSpec

func (*StudySpec) GetDecayCurveStoppingSpec

func (x *StudySpec) GetDecayCurveStoppingSpec() *StudySpec_DecayCurveAutomatedStoppingSpec

func (*StudySpec) GetMeasurementSelectionType

func (x *StudySpec) GetMeasurementSelectionType() StudySpec_MeasurementSelectionType

func (*StudySpec) GetMedianAutomatedStoppingSpec

func (x *StudySpec) GetMedianAutomatedStoppingSpec() *StudySpec_MedianAutomatedStoppingSpec

func (*StudySpec) GetMetrics

func (x *StudySpec) GetMetrics() []*StudySpec_MetricSpec

func (*StudySpec) GetObservationNoise

func (x *StudySpec) GetObservationNoise() StudySpec_ObservationNoise

func (*StudySpec) GetParameters

func (x *StudySpec) GetParameters() []*StudySpec_ParameterSpec

func (*StudySpec) GetStudyStoppingConfig added in v1.54.0

func (x *StudySpec) GetStudyStoppingConfig() *StudySpec_StudyStoppingConfig

func (*StudySpec) ProtoMessage

func (*StudySpec) ProtoMessage()

func (*StudySpec) ProtoReflect

func (x *StudySpec) ProtoReflect() protoreflect.Message

func (*StudySpec) Reset

func (x *StudySpec) Reset()

func (*StudySpec) String

func (x *StudySpec) String() string

type StudySpec_Algorithm

type StudySpec_Algorithm int32

The available search algorithms for the Study.

const (
	// The default algorithm used by Vertex AI for [hyperparameter
	// tuning](https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview)
	// and [Vertex AI Vizier](https://cloud.google.com/vertex-ai/docs/vizier).
	StudySpec_ALGORITHM_UNSPECIFIED StudySpec_Algorithm = 0
	// Simple grid search within the feasible space. To use grid search,
	// all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`.
	StudySpec_GRID_SEARCH StudySpec_Algorithm = 2
	// Simple random search within the feasible space.
	StudySpec_RANDOM_SEARCH StudySpec_Algorithm = 3
)

func (StudySpec_Algorithm) Descriptor

func (StudySpec_Algorithm) Enum

func (StudySpec_Algorithm) EnumDescriptor deprecated

func (StudySpec_Algorithm) EnumDescriptor() ([]byte, []int)

Deprecated: Use StudySpec_Algorithm.Descriptor instead.

func (StudySpec_Algorithm) Number

func (StudySpec_Algorithm) String

func (x StudySpec_Algorithm) String() string

func (StudySpec_Algorithm) Type

type StudySpec_ConvexAutomatedStoppingSpec

type StudySpec_ConvexAutomatedStoppingSpec struct {

	// Steps used in predicting the final objective for early stopped trials. In
	// general, it's set to be the same as the defined steps in training /
	// tuning. If not defined, it will learn it from the completed trials. When
	// use_steps is false, this field is set to the maximum elapsed seconds.
	MaxStepCount int64 `protobuf:"varint,1,opt,name=max_step_count,json=maxStepCount,proto3" json:"max_step_count,omitempty"`
	// Minimum number of steps for a trial to complete. Trials which do not have
	// a measurement with step_count > min_step_count won't be considered for
	// early stopping. It's ok to set it to 0, and a trial can be early stopped
	// at any stage. By default, min_step_count is set to be one-tenth of the
	// max_step_count.
	// When use_elapsed_duration is true, this field is set to the minimum
	// elapsed seconds.
	MinStepCount int64 `protobuf:"varint,2,opt,name=min_step_count,json=minStepCount,proto3" json:"min_step_count,omitempty"`
	// The minimal number of measurements in a Trial.  Early-stopping checks
	// will not trigger if less than min_measurement_count+1 completed trials or
	// pending trials with less than min_measurement_count measurements. If not
	// defined, the default value is 5.
	MinMeasurementCount int64 `protobuf:"varint,3,opt,name=min_measurement_count,json=minMeasurementCount,proto3" json:"min_measurement_count,omitempty"`
	// The hyper-parameter name used in the tuning job that stands for learning
	// rate. Leave it blank if learning rate is not in a parameter in tuning.
	// The learning_rate is used to estimate the objective value of the ongoing
	// trial.
	LearningRateParameterName string `` /* 140-byte string literal not displayed */
	// This bool determines whether or not the rule is applied based on
	// elapsed_secs or steps. If use_elapsed_duration==false, the early stopping
	// decision is made according to the predicted objective values according to
	// the target steps. If use_elapsed_duration==true, elapsed_secs is used
	// instead of steps. Also, in this case, the parameters max_num_steps and
	// min_num_steps are overloaded to contain max_elapsed_seconds and
	// min_elapsed_seconds.
	UseElapsedDuration bool `protobuf:"varint,5,opt,name=use_elapsed_duration,json=useElapsedDuration,proto3" json:"use_elapsed_duration,omitempty"`
	// ConvexAutomatedStoppingSpec by default only updates the trials that needs
	// to be early stopped using a newly trained auto-regressive model. When
	// this flag is set to True, all stopped trials from the beginning are
	// potentially updated in terms of their `final_measurement`. Also, note
	// that the training logic of autoregressive models is different in this
	// case. Enabling this option has shown better results and this may be the
	// default option in the future.
	UpdateAllStoppedTrials *bool `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration for ConvexAutomatedStoppingSpec. When there are enough completed trials (configured by min_measurement_count), for pending trials with enough measurements and steps, the policy first computes an overestimate of the objective value at max_num_steps according to the slope of the incomplete objective value curve. No prediction can be made if the curve is completely flat. If the overestimation is worse than the best objective value of the completed trials, this pending trial will be early-stopped, but a last measurement will be added to the pending trial with max_num_steps and predicted objective value from the autoregression model.

func (*StudySpec_ConvexAutomatedStoppingSpec) Descriptor deprecated

func (*StudySpec_ConvexAutomatedStoppingSpec) Descriptor() ([]byte, []int)

Deprecated: Use StudySpec_ConvexAutomatedStoppingSpec.ProtoReflect.Descriptor instead.

func (*StudySpec_ConvexAutomatedStoppingSpec) GetLearningRateParameterName

func (x *StudySpec_ConvexAutomatedStoppingSpec) GetLearningRateParameterName() string

func (*StudySpec_ConvexAutomatedStoppingSpec) GetMaxStepCount

func (x *StudySpec_ConvexAutomatedStoppingSpec) GetMaxStepCount() int64

func (*StudySpec_ConvexAutomatedStoppingSpec) GetMinMeasurementCount

func (x *StudySpec_ConvexAutomatedStoppingSpec) GetMinMeasurementCount() int64

func (*StudySpec_ConvexAutomatedStoppingSpec) GetMinStepCount

func (x *StudySpec_ConvexAutomatedStoppingSpec) GetMinStepCount() int64

func (*StudySpec_ConvexAutomatedStoppingSpec) GetUpdateAllStoppedTrials added in v1.30.0

func (x *StudySpec_ConvexAutomatedStoppingSpec) GetUpdateAllStoppedTrials() bool

func (*StudySpec_ConvexAutomatedStoppingSpec) GetUseElapsedDuration

func (x *StudySpec_ConvexAutomatedStoppingSpec) GetUseElapsedDuration() bool

func (*StudySpec_ConvexAutomatedStoppingSpec) ProtoMessage

func (*StudySpec_ConvexAutomatedStoppingSpec) ProtoMessage()

func (*StudySpec_ConvexAutomatedStoppingSpec) ProtoReflect

func (*StudySpec_ConvexAutomatedStoppingSpec) Reset

func (*StudySpec_ConvexAutomatedStoppingSpec) String

type StudySpec_ConvexAutomatedStoppingSpec_

type StudySpec_ConvexAutomatedStoppingSpec_ struct {
	// The automated early stopping spec using convex stopping rule.
	ConvexAutomatedStoppingSpec *StudySpec_ConvexAutomatedStoppingSpec `protobuf:"bytes,9,opt,name=convex_automated_stopping_spec,json=convexAutomatedStoppingSpec,proto3,oneof"`
}

type StudySpec_DecayCurveAutomatedStoppingSpec

type StudySpec_DecayCurveAutomatedStoppingSpec struct {

	// True if
	// [Measurement.elapsed_duration][google.cloud.aiplatform.v1.Measurement.elapsed_duration]
	// is used as the x-axis of each Trials Decay Curve. Otherwise,
	// [Measurement.step_count][google.cloud.aiplatform.v1.Measurement.step_count]
	// will be used as the x-axis.
	UseElapsedDuration bool `protobuf:"varint,1,opt,name=use_elapsed_duration,json=useElapsedDuration,proto3" json:"use_elapsed_duration,omitempty"`
	// contains filtered or unexported fields
}

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. Early stopping is requested for the current Trial if there is very low probability to exceed the optimal value found so far.

func (*StudySpec_DecayCurveAutomatedStoppingSpec) Descriptor deprecated

func (*StudySpec_DecayCurveAutomatedStoppingSpec) Descriptor() ([]byte, []int)

Deprecated: Use StudySpec_DecayCurveAutomatedStoppingSpec.ProtoReflect.Descriptor instead.

func (*StudySpec_DecayCurveAutomatedStoppingSpec) GetUseElapsedDuration

func (x *StudySpec_DecayCurveAutomatedStoppingSpec) GetUseElapsedDuration() bool

func (*StudySpec_DecayCurveAutomatedStoppingSpec) ProtoMessage

func (*StudySpec_DecayCurveAutomatedStoppingSpec) ProtoReflect

func (*StudySpec_DecayCurveAutomatedStoppingSpec) Reset

func (*StudySpec_DecayCurveAutomatedStoppingSpec) String

type StudySpec_DecayCurveStoppingSpec

type StudySpec_DecayCurveStoppingSpec struct {
	// The automated early stopping spec using decay curve rule.
	DecayCurveStoppingSpec *StudySpec_DecayCurveAutomatedStoppingSpec `protobuf:"bytes,4,opt,name=decay_curve_stopping_spec,json=decayCurveStoppingSpec,proto3,oneof"`
}

type StudySpec_MeasurementSelectionType

type StudySpec_MeasurementSelectionType int32

This indicates which measurement to use if/when the service automatically selects the final measurement from previously reported intermediate measurements. Choose this based on two considerations:

A) Do you expect your measurements to monotonically improve?
   If so, choose LAST_MEASUREMENT. On the other hand, if you're in a
   situation where your system can "over-train" and you expect the
   performance to get better for a while but then start declining,
   choose BEST_MEASUREMENT.
B) Are your measurements significantly noisy and/or irreproducible?
   If so, BEST_MEASUREMENT will tend to be over-optimistic, and it
   may be better to choose LAST_MEASUREMENT.
If both or neither of (A) and (B) apply, it doesn't matter which
selection type is chosen.
const (
	// Will be treated as LAST_MEASUREMENT.
	StudySpec_MEASUREMENT_SELECTION_TYPE_UNSPECIFIED StudySpec_MeasurementSelectionType = 0
	// Use the last measurement reported.
	StudySpec_LAST_MEASUREMENT StudySpec_MeasurementSelectionType = 1
	// Use the best measurement reported.
	StudySpec_BEST_MEASUREMENT StudySpec_MeasurementSelectionType = 2
)

func (StudySpec_MeasurementSelectionType) Descriptor

func (StudySpec_MeasurementSelectionType) Enum

func (StudySpec_MeasurementSelectionType) EnumDescriptor deprecated

func (StudySpec_MeasurementSelectionType) EnumDescriptor() ([]byte, []int)

Deprecated: Use StudySpec_MeasurementSelectionType.Descriptor instead.

func (StudySpec_MeasurementSelectionType) Number

func (StudySpec_MeasurementSelectionType) String

func (StudySpec_MeasurementSelectionType) Type

type StudySpec_MedianAutomatedStoppingSpec

type StudySpec_MedianAutomatedStoppingSpec struct {

	// True if median automated stopping rule applies on
	// [Measurement.elapsed_duration][google.cloud.aiplatform.v1.Measurement.elapsed_duration].
	// It means that elapsed_duration field of latest measurement of current
	// Trial is used to compute median objective value for each completed
	// Trials.
	UseElapsedDuration bool `protobuf:"varint,1,opt,name=use_elapsed_duration,json=useElapsedDuration,proto3" json:"use_elapsed_duration,omitempty"`
	// contains filtered or unexported fields
}

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. Currently, 'performance' refers to the running average of the objective values reported by the Trial in each measurement.

func (*StudySpec_MedianAutomatedStoppingSpec) Descriptor deprecated

func (*StudySpec_MedianAutomatedStoppingSpec) Descriptor() ([]byte, []int)

Deprecated: Use StudySpec_MedianAutomatedStoppingSpec.ProtoReflect.Descriptor instead.

func (*StudySpec_MedianAutomatedStoppingSpec) GetUseElapsedDuration

func (x *StudySpec_MedianAutomatedStoppingSpec) GetUseElapsedDuration() bool

func (*StudySpec_MedianAutomatedStoppingSpec) ProtoMessage

func (*StudySpec_MedianAutomatedStoppingSpec) ProtoMessage()

func (*StudySpec_MedianAutomatedStoppingSpec) ProtoReflect

func (*StudySpec_MedianAutomatedStoppingSpec) Reset

func (*StudySpec_MedianAutomatedStoppingSpec) String

type StudySpec_MedianAutomatedStoppingSpec_

type StudySpec_MedianAutomatedStoppingSpec_ struct {
	// The automated early stopping spec using median rule.
	MedianAutomatedStoppingSpec *StudySpec_MedianAutomatedStoppingSpec `protobuf:"bytes,5,opt,name=median_automated_stopping_spec,json=medianAutomatedStoppingSpec,proto3,oneof"`
}

type StudySpec_MetricSpec

type StudySpec_MetricSpec struct {

	// Required. The ID of the metric. Must not contain whitespaces and must be
	// unique amongst all MetricSpecs.
	MetricId string `protobuf:"bytes,1,opt,name=metric_id,json=metricId,proto3" json:"metric_id,omitempty"`
	// Required. The optimization goal of the metric.
	Goal StudySpec_MetricSpec_GoalType `protobuf:"varint,2,opt,name=goal,proto3,enum=google.cloud.aiplatform.v1.StudySpec_MetricSpec_GoalType" json:"goal,omitempty"`
	// Used for safe search. In the case, the metric will be a safety
	// metric. You must provide a separate metric for objective metric.
	SafetyConfig *StudySpec_MetricSpec_SafetyMetricConfig `protobuf:"bytes,3,opt,name=safety_config,json=safetyConfig,proto3,oneof" json:"safety_config,omitempty"`
	// contains filtered or unexported fields
}

Represents a metric to optimize.

func (*StudySpec_MetricSpec) Descriptor deprecated

func (*StudySpec_MetricSpec) Descriptor() ([]byte, []int)

Deprecated: Use StudySpec_MetricSpec.ProtoReflect.Descriptor instead.

func (*StudySpec_MetricSpec) GetGoal

func (*StudySpec_MetricSpec) GetMetricId

func (x *StudySpec_MetricSpec) GetMetricId() string

func (*StudySpec_MetricSpec) GetSafetyConfig added in v1.34.0

func (*StudySpec_MetricSpec) ProtoMessage

func (*StudySpec_MetricSpec) ProtoMessage()

func (*StudySpec_MetricSpec) ProtoReflect

func (x *StudySpec_MetricSpec) ProtoReflect() protoreflect.Message

func (*StudySpec_MetricSpec) Reset

func (x *StudySpec_MetricSpec) Reset()

func (*StudySpec_MetricSpec) String

func (x *StudySpec_MetricSpec) String() string

type StudySpec_MetricSpec_GoalType

type StudySpec_MetricSpec_GoalType int32

The available types of optimization goals.

const (
	// Goal Type will default to maximize.
	StudySpec_MetricSpec_GOAL_TYPE_UNSPECIFIED StudySpec_MetricSpec_GoalType = 0
	// Maximize the goal metric.
	StudySpec_MetricSpec_MAXIMIZE StudySpec_MetricSpec_GoalType = 1
	// Minimize the goal metric.
	StudySpec_MetricSpec_MINIMIZE StudySpec_MetricSpec_GoalType = 2
)

func (StudySpec_MetricSpec_GoalType) Descriptor

func (StudySpec_MetricSpec_GoalType) Enum

func (StudySpec_MetricSpec_GoalType) EnumDescriptor deprecated

func (StudySpec_MetricSpec_GoalType) EnumDescriptor() ([]byte, []int)

Deprecated: Use StudySpec_MetricSpec_GoalType.Descriptor instead.

func (StudySpec_MetricSpec_GoalType) Number

func (StudySpec_MetricSpec_GoalType) String

func (StudySpec_MetricSpec_GoalType) Type

type StudySpec_MetricSpec_SafetyMetricConfig added in v1.34.0

type StudySpec_MetricSpec_SafetyMetricConfig struct {

	// Safety threshold (boundary value between safe and unsafe). NOTE that if
	// you leave SafetyMetricConfig unset, a default value of 0 will be used.
	SafetyThreshold float64 `protobuf:"fixed64,1,opt,name=safety_threshold,json=safetyThreshold,proto3" json:"safety_threshold,omitempty"`
	// Desired minimum fraction of safe trials (over total number of trials)
	// that should be targeted by the algorithm at any time during the
	// study (best effort). This should be between 0.0 and 1.0 and a value of
	// 0.0 means that there is no minimum and an algorithm proceeds without
	// targeting any specific fraction. A value of 1.0 means that the
	// algorithm attempts to only Suggest safe Trials.
	DesiredMinSafeTrialsFraction *float64 `` /* 159-byte string literal not displayed */
	// contains filtered or unexported fields
}

Used in safe optimization to specify threshold levels and risk tolerance.

func (*StudySpec_MetricSpec_SafetyMetricConfig) Descriptor deprecated added in v1.34.0

func (*StudySpec_MetricSpec_SafetyMetricConfig) Descriptor() ([]byte, []int)

Deprecated: Use StudySpec_MetricSpec_SafetyMetricConfig.ProtoReflect.Descriptor instead.

func (*StudySpec_MetricSpec_SafetyMetricConfig) GetDesiredMinSafeTrialsFraction added in v1.34.0

func (x *StudySpec_MetricSpec_SafetyMetricConfig) GetDesiredMinSafeTrialsFraction() float64

func (*StudySpec_MetricSpec_SafetyMetricConfig) GetSafetyThreshold added in v1.34.0

func (x *StudySpec_MetricSpec_SafetyMetricConfig) GetSafetyThreshold() float64

func (*StudySpec_MetricSpec_SafetyMetricConfig) ProtoMessage added in v1.34.0

func (*StudySpec_MetricSpec_SafetyMetricConfig) ProtoReflect added in v1.34.0

func (*StudySpec_MetricSpec_SafetyMetricConfig) Reset added in v1.34.0

func (*StudySpec_MetricSpec_SafetyMetricConfig) String added in v1.34.0

type StudySpec_ObservationNoise

type StudySpec_ObservationNoise int32

Describes the noise level of the repeated observations.

"Noisy" means that the repeated observations with the same Trial parameters may lead to different metric evaluations.

const (
	// The default noise level chosen by Vertex AI.
	StudySpec_OBSERVATION_NOISE_UNSPECIFIED StudySpec_ObservationNoise = 0
	// Vertex AI assumes that the objective function is (nearly)
	// perfectly reproducible, and will never repeat the same Trial
	// parameters.
	StudySpec_LOW StudySpec_ObservationNoise = 1
	// Vertex AI will estimate the amount of noise in metric
	// evaluations, it may repeat the same Trial parameters more than once.
	StudySpec_HIGH StudySpec_ObservationNoise = 2
)

func (StudySpec_ObservationNoise) Descriptor

func (StudySpec_ObservationNoise) Enum

func (StudySpec_ObservationNoise) EnumDescriptor deprecated

func (StudySpec_ObservationNoise) EnumDescriptor() ([]byte, []int)

Deprecated: Use StudySpec_ObservationNoise.Descriptor instead.

func (StudySpec_ObservationNoise) Number

func (StudySpec_ObservationNoise) String

func (StudySpec_ObservationNoise) Type

type StudySpec_ParameterSpec

type StudySpec_ParameterSpec struct {

	// Types that are assignable to ParameterValueSpec:
	//
	//	*StudySpec_ParameterSpec_DoubleValueSpec_
	//	*StudySpec_ParameterSpec_IntegerValueSpec_
	//	*StudySpec_ParameterSpec_CategoricalValueSpec_
	//	*StudySpec_ParameterSpec_DiscreteValueSpec_
	ParameterValueSpec isStudySpec_ParameterSpec_ParameterValueSpec `protobuf_oneof:"parameter_value_spec"`
	// Required. The ID of the parameter. Must not contain whitespaces and must
	// be unique amongst all ParameterSpecs.
	ParameterId string `protobuf:"bytes,1,opt,name=parameter_id,json=parameterId,proto3" json:"parameter_id,omitempty"`
	// How the parameter should be scaled.
	// Leave unset for `CATEGORICAL` parameters.
	ScaleType StudySpec_ParameterSpec_ScaleType `` /* 155-byte string literal not displayed */
	// A conditional parameter node is active if the parameter's value matches
	// the conditional node's parent_value_condition.
	//
	// If two items in conditional_parameter_specs have the same name, they
	// must have disjoint parent_value_condition.
	ConditionalParameterSpecs []*StudySpec_ParameterSpec_ConditionalParameterSpec `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents a single parameter to optimize.

func (*StudySpec_ParameterSpec) Descriptor deprecated

func (*StudySpec_ParameterSpec) Descriptor() ([]byte, []int)

Deprecated: Use StudySpec_ParameterSpec.ProtoReflect.Descriptor instead.

func (*StudySpec_ParameterSpec) GetCategoricalValueSpec

func (*StudySpec_ParameterSpec) GetConditionalParameterSpecs

func (*StudySpec_ParameterSpec) GetDiscreteValueSpec

func (*StudySpec_ParameterSpec) GetDoubleValueSpec

func (*StudySpec_ParameterSpec) GetIntegerValueSpec

func (*StudySpec_ParameterSpec) GetParameterId

func (x *StudySpec_ParameterSpec) GetParameterId() string

func (*StudySpec_ParameterSpec) GetParameterValueSpec

func (m *StudySpec_ParameterSpec) GetParameterValueSpec() isStudySpec_ParameterSpec_ParameterValueSpec

func (*StudySpec_ParameterSpec) GetScaleType

func (*StudySpec_ParameterSpec) ProtoMessage

func (*StudySpec_ParameterSpec) ProtoMessage()

func (*StudySpec_ParameterSpec) ProtoReflect

func (x *StudySpec_ParameterSpec) ProtoReflect() protoreflect.Message

func (*StudySpec_ParameterSpec) Reset

func (x *StudySpec_ParameterSpec) Reset()

func (*StudySpec_ParameterSpec) String

func (x *StudySpec_ParameterSpec) String() string

type StudySpec_ParameterSpec_CategoricalValueSpec

type StudySpec_ParameterSpec_CategoricalValueSpec struct {

	// Required. The list of possible categories.
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// A default value for a `CATEGORICAL` parameter that is assumed to be a
	// relatively good starting point.  Unset value signals that there is no
	// offered starting point.
	//
	// Currently only supported by the Vertex AI Vizier service. Not supported
	// by HyperparameterTuningJob or TrainingPipeline.
	DefaultValue *string `protobuf:"bytes,3,opt,name=default_value,json=defaultValue,proto3,oneof" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

Value specification for a parameter in `CATEGORICAL` type.

func (*StudySpec_ParameterSpec_CategoricalValueSpec) Descriptor deprecated

Deprecated: Use StudySpec_ParameterSpec_CategoricalValueSpec.ProtoReflect.Descriptor instead.

func (*StudySpec_ParameterSpec_CategoricalValueSpec) GetDefaultValue

func (*StudySpec_ParameterSpec_CategoricalValueSpec) GetValues

func (*StudySpec_ParameterSpec_CategoricalValueSpec) ProtoMessage

func (*StudySpec_ParameterSpec_CategoricalValueSpec) ProtoReflect

func (*StudySpec_ParameterSpec_CategoricalValueSpec) Reset

func (*StudySpec_ParameterSpec_CategoricalValueSpec) String

type StudySpec_ParameterSpec_CategoricalValueSpec_

type StudySpec_ParameterSpec_CategoricalValueSpec_ struct {
	// The value spec for a 'CATEGORICAL' parameter.
	CategoricalValueSpec *StudySpec_ParameterSpec_CategoricalValueSpec `protobuf:"bytes,4,opt,name=categorical_value_spec,json=categoricalValueSpec,proto3,oneof"`
}

type StudySpec_ParameterSpec_ConditionalParameterSpec

type StudySpec_ParameterSpec_ConditionalParameterSpec struct {

	// A set of parameter values from the parent ParameterSpec's feasible
	// space.
	//
	// Types that are assignable to ParentValueCondition:
	//
	//	*StudySpec_ParameterSpec_ConditionalParameterSpec_ParentDiscreteValues
	//	*StudySpec_ParameterSpec_ConditionalParameterSpec_ParentIntValues
	//	*StudySpec_ParameterSpec_ConditionalParameterSpec_ParentCategoricalValues
	ParentValueCondition isStudySpec_ParameterSpec_ConditionalParameterSpec_ParentValueCondition `protobuf_oneof:"parent_value_condition"`
	// Required. The spec for a conditional parameter.
	ParameterSpec *StudySpec_ParameterSpec `protobuf:"bytes,1,opt,name=parameter_spec,json=parameterSpec,proto3" json:"parameter_spec,omitempty"`
	// contains filtered or unexported fields
}

Represents a parameter spec with condition from its parent parameter.

func (*StudySpec_ParameterSpec_ConditionalParameterSpec) Descriptor deprecated

Deprecated: Use StudySpec_ParameterSpec_ConditionalParameterSpec.ProtoReflect.Descriptor instead.

func (*StudySpec_ParameterSpec_ConditionalParameterSpec) GetParameterSpec

func (*StudySpec_ParameterSpec_ConditionalParameterSpec) GetParentCategoricalValues

func (*StudySpec_ParameterSpec_ConditionalParameterSpec) GetParentDiscreteValues

func (*StudySpec_ParameterSpec_ConditionalParameterSpec) GetParentIntValues

func (*StudySpec_ParameterSpec_ConditionalParameterSpec) GetParentValueCondition

func (m *StudySpec_ParameterSpec_ConditionalParameterSpec) GetParentValueCondition() isStudySpec_ParameterSpec_ConditionalParameterSpec_ParentValueCondition

func (*StudySpec_ParameterSpec_ConditionalParameterSpec) ProtoMessage

func (*StudySpec_ParameterSpec_ConditionalParameterSpec) ProtoReflect

func (*StudySpec_ParameterSpec_ConditionalParameterSpec) Reset

func (*StudySpec_ParameterSpec_ConditionalParameterSpec) String

type StudySpec_ParameterSpec_ConditionalParameterSpec_CategoricalValueCondition

type StudySpec_ParameterSpec_ConditionalParameterSpec_CategoricalValueCondition struct {

	// Required. Matches values of the parent parameter of 'CATEGORICAL'
	// type. All values must exist in `categorical_value_spec` of parent
	// parameter.
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

Represents the spec to match categorical values from parent parameter.

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_CategoricalValueCondition) Descriptor deprecated

Deprecated: Use StudySpec_ParameterSpec_ConditionalParameterSpec_CategoricalValueCondition.ProtoReflect.Descriptor instead.

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_CategoricalValueCondition) GetValues

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_CategoricalValueCondition) ProtoMessage

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_CategoricalValueCondition) ProtoReflect

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_CategoricalValueCondition) Reset

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_CategoricalValueCondition) String

type StudySpec_ParameterSpec_ConditionalParameterSpec_DiscreteValueCondition

type StudySpec_ParameterSpec_ConditionalParameterSpec_DiscreteValueCondition struct {

	// Required. Matches values of the parent parameter of 'DISCRETE' type.
	// All values must exist in `discrete_value_spec` of parent parameter.
	//
	// The Epsilon of the value matching is 1e-10.
	Values []float64 `protobuf:"fixed64,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

Represents the spec to match discrete values from parent parameter.

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_DiscreteValueCondition) Descriptor deprecated

Deprecated: Use StudySpec_ParameterSpec_ConditionalParameterSpec_DiscreteValueCondition.ProtoReflect.Descriptor instead.

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_DiscreteValueCondition) GetValues

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_DiscreteValueCondition) ProtoMessage

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_DiscreteValueCondition) ProtoReflect

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_DiscreteValueCondition) Reset

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_DiscreteValueCondition) String

type StudySpec_ParameterSpec_ConditionalParameterSpec_IntValueCondition

type StudySpec_ParameterSpec_ConditionalParameterSpec_IntValueCondition struct {

	// Required. Matches values of the parent parameter of 'INTEGER' type.
	// All values must lie in `integer_value_spec` of parent parameter.
	Values []int64 `protobuf:"varint,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

Represents the spec to match integer values from parent parameter.

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_IntValueCondition) Descriptor deprecated

Deprecated: Use StudySpec_ParameterSpec_ConditionalParameterSpec_IntValueCondition.ProtoReflect.Descriptor instead.

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_IntValueCondition) GetValues

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_IntValueCondition) ProtoMessage

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_IntValueCondition) ProtoReflect

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_IntValueCondition) Reset

func (*StudySpec_ParameterSpec_ConditionalParameterSpec_IntValueCondition) String

type StudySpec_ParameterSpec_ConditionalParameterSpec_ParentCategoricalValues

type StudySpec_ParameterSpec_ConditionalParameterSpec_ParentCategoricalValues struct {
	// The spec for matching values from a parent parameter of
	// `CATEGORICAL` type.
	ParentCategoricalValues *StudySpec_ParameterSpec_ConditionalParameterSpec_CategoricalValueCondition `protobuf:"bytes,4,opt,name=parent_categorical_values,json=parentCategoricalValues,proto3,oneof"`
}

type StudySpec_ParameterSpec_ConditionalParameterSpec_ParentDiscreteValues

type StudySpec_ParameterSpec_ConditionalParameterSpec_ParentDiscreteValues struct {
	// The spec for matching values from a parent parameter of
	// `DISCRETE` type.
	ParentDiscreteValues *StudySpec_ParameterSpec_ConditionalParameterSpec_DiscreteValueCondition `protobuf:"bytes,2,opt,name=parent_discrete_values,json=parentDiscreteValues,proto3,oneof"`
}

type StudySpec_ParameterSpec_ConditionalParameterSpec_ParentIntValues

type StudySpec_ParameterSpec_ConditionalParameterSpec_ParentIntValues struct {
	// The spec for matching values from a parent parameter of `INTEGER`
	// type.
	ParentIntValues *StudySpec_ParameterSpec_ConditionalParameterSpec_IntValueCondition `protobuf:"bytes,3,opt,name=parent_int_values,json=parentIntValues,proto3,oneof"`
}

type StudySpec_ParameterSpec_DiscreteValueSpec

type StudySpec_ParameterSpec_DiscreteValueSpec struct {

	// Required. A list of possible values.
	// The list should be in increasing order and at least 1e-10 apart.
	// For instance, this parameter might have possible settings of 1.5, 2.5,
	// and 4.0. This list should not contain more than 1,000 values.
	Values []float64 `protobuf:"fixed64,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// A default value for a `DISCRETE` parameter that is assumed to be a
	// relatively good starting point.  Unset value signals that there is no
	// offered starting point.  It automatically rounds to the
	// nearest feasible discrete point.
	//
	// Currently only supported by the Vertex AI Vizier service. Not supported
	// by HyperparameterTuningJob or TrainingPipeline.
	DefaultValue *float64 `protobuf:"fixed64,3,opt,name=default_value,json=defaultValue,proto3,oneof" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

Value specification for a parameter in `DISCRETE` type.

func (*StudySpec_ParameterSpec_DiscreteValueSpec) Descriptor deprecated

func (*StudySpec_ParameterSpec_DiscreteValueSpec) Descriptor() ([]byte, []int)

Deprecated: Use StudySpec_ParameterSpec_DiscreteValueSpec.ProtoReflect.Descriptor instead.

func (*StudySpec_ParameterSpec_DiscreteValueSpec) GetDefaultValue

func (*StudySpec_ParameterSpec_DiscreteValueSpec) GetValues

func (*StudySpec_ParameterSpec_DiscreteValueSpec) ProtoMessage

func (*StudySpec_ParameterSpec_DiscreteValueSpec) ProtoReflect

func (*StudySpec_ParameterSpec_DiscreteValueSpec) Reset

func (*StudySpec_ParameterSpec_DiscreteValueSpec) String

type StudySpec_ParameterSpec_DiscreteValueSpec_

type StudySpec_ParameterSpec_DiscreteValueSpec_ struct {
	// The value spec for a 'DISCRETE' parameter.
	DiscreteValueSpec *StudySpec_ParameterSpec_DiscreteValueSpec `protobuf:"bytes,5,opt,name=discrete_value_spec,json=discreteValueSpec,proto3,oneof"`
}

type StudySpec_ParameterSpec_DoubleValueSpec

type StudySpec_ParameterSpec_DoubleValueSpec struct {

	// Required. Inclusive minimum value of the parameter.
	MinValue float64 `protobuf:"fixed64,1,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
	// Required. Inclusive maximum value of the parameter.
	MaxValue float64 `protobuf:"fixed64,2,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
	// A default value for a `DOUBLE` parameter that is assumed to be a
	// relatively good starting point.  Unset value signals that there is no
	// offered starting point.
	//
	// Currently only supported by the Vertex AI Vizier service. Not supported
	// by HyperparameterTuningJob or TrainingPipeline.
	DefaultValue *float64 `protobuf:"fixed64,4,opt,name=default_value,json=defaultValue,proto3,oneof" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

Value specification for a parameter in `DOUBLE` type.

func (*StudySpec_ParameterSpec_DoubleValueSpec) Descriptor deprecated

func (*StudySpec_ParameterSpec_DoubleValueSpec) Descriptor() ([]byte, []int)

Deprecated: Use StudySpec_ParameterSpec_DoubleValueSpec.ProtoReflect.Descriptor instead.

func (*StudySpec_ParameterSpec_DoubleValueSpec) GetDefaultValue

func (x *StudySpec_ParameterSpec_DoubleValueSpec) GetDefaultValue() float64

func (*StudySpec_ParameterSpec_DoubleValueSpec) GetMaxValue

func (*StudySpec_ParameterSpec_DoubleValueSpec) GetMinValue

func (*StudySpec_ParameterSpec_DoubleValueSpec) ProtoMessage

func (*StudySpec_ParameterSpec_DoubleValueSpec) ProtoReflect

func (*StudySpec_ParameterSpec_DoubleValueSpec) Reset

func (*StudySpec_ParameterSpec_DoubleValueSpec) String

type StudySpec_ParameterSpec_DoubleValueSpec_

type StudySpec_ParameterSpec_DoubleValueSpec_ struct {
	// The value spec for a 'DOUBLE' parameter.
	DoubleValueSpec *StudySpec_ParameterSpec_DoubleValueSpec `protobuf:"bytes,2,opt,name=double_value_spec,json=doubleValueSpec,proto3,oneof"`
}

type StudySpec_ParameterSpec_IntegerValueSpec

type StudySpec_ParameterSpec_IntegerValueSpec struct {

	// Required. Inclusive minimum value of the parameter.
	MinValue int64 `protobuf:"varint,1,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
	// Required. Inclusive maximum value of the parameter.
	MaxValue int64 `protobuf:"varint,2,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
	// A default value for an `INTEGER` parameter that is assumed to be a
	// relatively good starting point.  Unset value signals that there is no
	// offered starting point.
	//
	// Currently only supported by the Vertex AI Vizier service. Not supported
	// by HyperparameterTuningJob or TrainingPipeline.
	DefaultValue *int64 `protobuf:"varint,4,opt,name=default_value,json=defaultValue,proto3,oneof" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

Value specification for a parameter in `INTEGER` type.

func (*StudySpec_ParameterSpec_IntegerValueSpec) Descriptor deprecated

func (*StudySpec_ParameterSpec_IntegerValueSpec) Descriptor() ([]byte, []int)

Deprecated: Use StudySpec_ParameterSpec_IntegerValueSpec.ProtoReflect.Descriptor instead.

func (*StudySpec_ParameterSpec_IntegerValueSpec) GetDefaultValue

func (x *StudySpec_ParameterSpec_IntegerValueSpec) GetDefaultValue() int64

func (*StudySpec_ParameterSpec_IntegerValueSpec) GetMaxValue

func (*StudySpec_ParameterSpec_IntegerValueSpec) GetMinValue

func (*StudySpec_ParameterSpec_IntegerValueSpec) ProtoMessage

func (*StudySpec_ParameterSpec_IntegerValueSpec) ProtoReflect

func (*StudySpec_ParameterSpec_IntegerValueSpec) Reset

func (*StudySpec_ParameterSpec_IntegerValueSpec) String

type StudySpec_ParameterSpec_IntegerValueSpec_

type StudySpec_ParameterSpec_IntegerValueSpec_ struct {
	// The value spec for an 'INTEGER' parameter.
	IntegerValueSpec *StudySpec_ParameterSpec_IntegerValueSpec `protobuf:"bytes,3,opt,name=integer_value_spec,json=integerValueSpec,proto3,oneof"`
}

type StudySpec_ParameterSpec_ScaleType

type StudySpec_ParameterSpec_ScaleType int32

The type of scaling that should be applied to this parameter.

const (
	// By default, no scaling is applied.
	StudySpec_ParameterSpec_SCALE_TYPE_UNSPECIFIED StudySpec_ParameterSpec_ScaleType = 0
	// Scales the feasible space to (0, 1) linearly.
	StudySpec_ParameterSpec_UNIT_LINEAR_SCALE StudySpec_ParameterSpec_ScaleType = 1
	// Scales the feasible space logarithmically to (0, 1). The entire
	// feasible space must be strictly positive.
	StudySpec_ParameterSpec_UNIT_LOG_SCALE StudySpec_ParameterSpec_ScaleType = 2
	// Scales the feasible space "reverse" logarithmically to (0, 1). The
	// result is that values close to the top of the feasible space are spread
	// out more than points near the bottom. The entire feasible space must be
	// strictly positive.
	StudySpec_ParameterSpec_UNIT_REVERSE_LOG_SCALE StudySpec_ParameterSpec_ScaleType = 3
)

func (StudySpec_ParameterSpec_ScaleType) Descriptor

func (StudySpec_ParameterSpec_ScaleType) Enum

func (StudySpec_ParameterSpec_ScaleType) EnumDescriptor deprecated

func (StudySpec_ParameterSpec_ScaleType) EnumDescriptor() ([]byte, []int)

Deprecated: Use StudySpec_ParameterSpec_ScaleType.Descriptor instead.

func (StudySpec_ParameterSpec_ScaleType) Number

func (StudySpec_ParameterSpec_ScaleType) String

func (StudySpec_ParameterSpec_ScaleType) Type

type StudySpec_StudyStoppingConfig added in v1.54.0

type StudySpec_StudyStoppingConfig struct {

	// If true, a Study enters STOPPING_ASAP whenever it would normally enters
	// STOPPING state.
	//
	// The bottom line is: set to true if you want to interrupt on-going
	// evaluations of Trials as soon as the study stopping condition is met.
	// (Please see Study.State documentation for the source of truth).
	ShouldStopAsap *wrapperspb.BoolValue `protobuf:"bytes,1,opt,name=should_stop_asap,json=shouldStopAsap,proto3" json:"should_stop_asap,omitempty"`
	// Each "stopping rule" in this proto specifies an "if" condition. Before
	// Vizier would generate a new suggestion, it first checks each specified
	// stopping rule, from top to bottom in this list.
	// Note that the first few rules (e.g. minimum_runtime_constraint,
	// min_num_trials) will prevent other stopping rules from being evaluated
	// until they are met. For example, setting `min_num_trials=5` and
	// `always_stop_after= 1 hour` means that the Study will ONLY stop after it
	// has 5 COMPLETED trials, even if more than an hour has passed since its
	// creation. It follows the first applicable rule (whose "if" condition is
	// satisfied) to make a stopping decision. If none of the specified rules
	// are applicable, then Vizier decides that the study should not stop.
	// If Vizier decides that the study should stop, the study enters
	// STOPPING state (or STOPPING_ASAP if should_stop_asap = true).
	// IMPORTANT: The automatic study state transition happens precisely as
	// described above; that is, deleting trials or updating StudyConfig NEVER
	// automatically moves the study state back to ACTIVE. If you want to
	// _resume_ a Study that was stopped, 1) change the stopping conditions if
	// necessary, 2) activate the study, and then 3) ask for suggestions.
	// If the specified time or duration has not passed, do not stop the
	// study.
	MinimumRuntimeConstraint *StudyTimeConstraint `` /* 135-byte string literal not displayed */
	// If the specified time or duration has passed, stop the study.
	MaximumRuntimeConstraint *StudyTimeConstraint `` /* 135-byte string literal not displayed */
	// If there are fewer than this many COMPLETED trials, do not stop the
	// study.
	MinNumTrials *wrapperspb.Int32Value `protobuf:"bytes,4,opt,name=min_num_trials,json=minNumTrials,proto3" json:"min_num_trials,omitempty"`
	// If there are more than this many trials, stop the study.
	MaxNumTrials *wrapperspb.Int32Value `protobuf:"bytes,5,opt,name=max_num_trials,json=maxNumTrials,proto3" json:"max_num_trials,omitempty"`
	// If the objective value has not improved for this many consecutive
	// trials, stop the study.
	//
	// WARNING: Effective only for single-objective studies.
	MaxNumTrialsNoProgress *wrapperspb.Int32Value `` /* 133-byte string literal not displayed */
	// If the objective value has not improved for this much time, stop the
	// study.
	//
	// WARNING: Effective only for single-objective studies.
	MaxDurationNoProgress *durationpb.Duration `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection.

func (*StudySpec_StudyStoppingConfig) Descriptor deprecated added in v1.54.0

func (*StudySpec_StudyStoppingConfig) Descriptor() ([]byte, []int)

Deprecated: Use StudySpec_StudyStoppingConfig.ProtoReflect.Descriptor instead.

func (*StudySpec_StudyStoppingConfig) GetMaxDurationNoProgress added in v1.54.0

func (x *StudySpec_StudyStoppingConfig) GetMaxDurationNoProgress() *durationpb.Duration

func (*StudySpec_StudyStoppingConfig) GetMaxNumTrials added in v1.54.0

func (x *StudySpec_StudyStoppingConfig) GetMaxNumTrials() *wrapperspb.Int32Value

func (*StudySpec_StudyStoppingConfig) GetMaxNumTrialsNoProgress added in v1.54.0

func (x *StudySpec_StudyStoppingConfig) GetMaxNumTrialsNoProgress() *wrapperspb.Int32Value

func (*StudySpec_StudyStoppingConfig) GetMaximumRuntimeConstraint added in v1.54.0

func (x *StudySpec_StudyStoppingConfig) GetMaximumRuntimeConstraint() *StudyTimeConstraint

func (*StudySpec_StudyStoppingConfig) GetMinNumTrials added in v1.54.0

func (x *StudySpec_StudyStoppingConfig) GetMinNumTrials() *wrapperspb.Int32Value

func (*StudySpec_StudyStoppingConfig) GetMinimumRuntimeConstraint added in v1.54.0

func (x *StudySpec_StudyStoppingConfig) GetMinimumRuntimeConstraint() *StudyTimeConstraint

func (*StudySpec_StudyStoppingConfig) GetShouldStopAsap added in v1.54.0

func (x *StudySpec_StudyStoppingConfig) GetShouldStopAsap() *wrapperspb.BoolValue

func (*StudySpec_StudyStoppingConfig) ProtoMessage added in v1.54.0

func (*StudySpec_StudyStoppingConfig) ProtoMessage()

func (*StudySpec_StudyStoppingConfig) ProtoReflect added in v1.54.0

func (*StudySpec_StudyStoppingConfig) Reset added in v1.54.0

func (x *StudySpec_StudyStoppingConfig) Reset()

func (*StudySpec_StudyStoppingConfig) String added in v1.54.0

type StudyTimeConstraint added in v1.54.0

type StudyTimeConstraint struct {

	// Types that are assignable to Constraint:
	//
	//	*StudyTimeConstraint_MaxDuration
	//	*StudyTimeConstraint_EndTime
	Constraint isStudyTimeConstraint_Constraint `protobuf_oneof:"constraint"`
	// contains filtered or unexported fields
}

Time-based Constraint for Study

func (*StudyTimeConstraint) Descriptor deprecated added in v1.54.0

func (*StudyTimeConstraint) Descriptor() ([]byte, []int)

Deprecated: Use StudyTimeConstraint.ProtoReflect.Descriptor instead.

func (*StudyTimeConstraint) GetConstraint added in v1.54.0

func (m *StudyTimeConstraint) GetConstraint() isStudyTimeConstraint_Constraint

func (*StudyTimeConstraint) GetEndTime added in v1.54.0

func (x *StudyTimeConstraint) GetEndTime() *timestamppb.Timestamp

func (*StudyTimeConstraint) GetMaxDuration added in v1.54.0

func (x *StudyTimeConstraint) GetMaxDuration() *durationpb.Duration

func (*StudyTimeConstraint) ProtoMessage added in v1.54.0

func (*StudyTimeConstraint) ProtoMessage()

func (*StudyTimeConstraint) ProtoReflect added in v1.54.0

func (x *StudyTimeConstraint) ProtoReflect() protoreflect.Message

func (*StudyTimeConstraint) Reset added in v1.54.0

func (x *StudyTimeConstraint) Reset()

func (*StudyTimeConstraint) String added in v1.54.0

func (x *StudyTimeConstraint) String() string

type StudyTimeConstraint_EndTime added in v1.54.0

type StudyTimeConstraint_EndTime struct {
	// Compares the wallclock time to this time. Must use UTC timezone.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3,oneof"`
}

type StudyTimeConstraint_MaxDuration added in v1.54.0

type StudyTimeConstraint_MaxDuration struct {
	// Counts the wallclock time passed since the creation of this Study.
	MaxDuration *durationpb.Duration `protobuf:"bytes,1,opt,name=max_duration,json=maxDuration,proto3,oneof"`
}

type Study_State

type Study_State int32

Describes the Study state.

const (
	// The study state is unspecified.
	Study_STATE_UNSPECIFIED Study_State = 0
	// The study is active.
	Study_ACTIVE Study_State = 1
	// The study is stopped due to an internal error.
	Study_INACTIVE Study_State = 2
	// The study is done when the service exhausts the parameter search space
	// or max_trial_count is reached.
	Study_COMPLETED Study_State = 3
)

func (Study_State) Descriptor

func (Study_State) Enum

func (x Study_State) Enum() *Study_State

func (Study_State) EnumDescriptor deprecated

func (Study_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Study_State.Descriptor instead.

func (Study_State) Number

func (x Study_State) Number() protoreflect.EnumNumber

func (Study_State) String

func (x Study_State) String() string

func (Study_State) Type

type SuggestTrialsMetadata

type SuggestTrialsMetadata struct {

	// Operation metadata for suggesting Trials.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// The identifier of the client that is requesting the suggestion.
	//
	// If multiple SuggestTrialsRequests have the same `client_id`,
	// the service will return the identical suggested Trial if the Trial is
	// pending, and provide a new Trial if the last suggested Trial was completed.
	ClientId string `protobuf:"bytes,2,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform Trials suggestion.

func (*SuggestTrialsMetadata) Descriptor deprecated

func (*SuggestTrialsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use SuggestTrialsMetadata.ProtoReflect.Descriptor instead.

func (*SuggestTrialsMetadata) GetClientId

func (x *SuggestTrialsMetadata) GetClientId() string

func (*SuggestTrialsMetadata) GetGenericMetadata

func (x *SuggestTrialsMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*SuggestTrialsMetadata) ProtoMessage

func (*SuggestTrialsMetadata) ProtoMessage()

func (*SuggestTrialsMetadata) ProtoReflect

func (x *SuggestTrialsMetadata) ProtoReflect() protoreflect.Message

func (*SuggestTrialsMetadata) Reset

func (x *SuggestTrialsMetadata) Reset()

func (*SuggestTrialsMetadata) String

func (x *SuggestTrialsMetadata) String() string

type SuggestTrialsRequest

type SuggestTrialsRequest struct {

	// Required. The project and location that the Study belongs to.
	// Format: `projects/{project}/locations/{location}/studies/{study}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The number of suggestions requested. It must be positive.
	SuggestionCount int32 `protobuf:"varint,2,opt,name=suggestion_count,json=suggestionCount,proto3" json:"suggestion_count,omitempty"`
	// Required. The identifier of the client that is requesting the suggestion.
	//
	// If multiple SuggestTrialsRequests have the same `client_id`,
	// the service will return the identical suggested Trial if the Trial is
	// pending, and provide a new Trial if the last suggested Trial was completed.
	ClientId string `protobuf:"bytes,3,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
	// Optional. This allows you to specify the "context" for a Trial; a context
	// is a slice (a subspace) of the search space.
	//
	// Typical uses for contexts:
	//  1. You are using Vizier to tune a server for best performance, but there's
	//     a strong weekly cycle.  The context specifies the day-of-week.
	//     This allows Tuesday to generalize from Wednesday without assuming that
	//     everything is identical.
	//  2. Imagine you're optimizing some medical treatment for people.
	//     As they walk in the door, you know certain facts about them
	//     (e.g. sex, weight, height, blood-pressure).  Put that information in the
	//     context, and Vizier will adapt its suggestions to the patient.
	//  3. You want to do a fair A/B test efficiently.  Specify the "A" and "B"
	//     conditions as contexts, and Vizier will generalize between "A" and "B"
	//     conditions.  If they are similar, this will allow Vizier to converge
	//     to the optimum faster than if "A" and "B" were separate Studies.
	//     NOTE: You can also enter contexts as REQUESTED Trials, e.g. via the
	//     CreateTrial() RPC; that's the asynchronous option where you don't need a
	//     close association between contexts and suggestions.
	//
	// NOTE: All the Parameters you set in a context MUST be defined in the
	//
	//	Study.
	//
	// NOTE: You must supply 0 or $suggestion_count contexts.
	//
	//	If you don't supply any contexts, Vizier will make suggestions
	//	from the full search space specified in the StudySpec; if you supply
	//	a full set of context, each suggestion will match the corresponding
	//	context.
	//
	// NOTE: A Context with no features set matches anything, and allows
	//
	//	suggestions from the full search space.
	//
	// NOTE: Contexts MUST lie within the search space specified in the
	//
	//	StudySpec.  It's an error if they don't.
	//
	// NOTE: Contexts preferentially match ACTIVE then REQUESTED trials before
	//
	//	new suggestions are generated.
	//
	// NOTE: Generation of suggestions involves a match between a Context and
	//
	//	(optionally) a REQUESTED trial; if that match is not fully specified, a
	//	suggestion will be geneated in the merged subspace.
	Contexts []*TrialContext `protobuf:"bytes,4,rep,name=contexts,proto3" json:"contexts,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials].

func (*SuggestTrialsRequest) Descriptor deprecated

func (*SuggestTrialsRequest) Descriptor() ([]byte, []int)

Deprecated: Use SuggestTrialsRequest.ProtoReflect.Descriptor instead.

func (*SuggestTrialsRequest) GetClientId

func (x *SuggestTrialsRequest) GetClientId() string

func (*SuggestTrialsRequest) GetContexts added in v1.50.0

func (x *SuggestTrialsRequest) GetContexts() []*TrialContext

func (*SuggestTrialsRequest) GetParent

func (x *SuggestTrialsRequest) GetParent() string

func (*SuggestTrialsRequest) GetSuggestionCount

func (x *SuggestTrialsRequest) GetSuggestionCount() int32

func (*SuggestTrialsRequest) ProtoMessage

func (*SuggestTrialsRequest) ProtoMessage()

func (*SuggestTrialsRequest) ProtoReflect

func (x *SuggestTrialsRequest) ProtoReflect() protoreflect.Message

func (*SuggestTrialsRequest) Reset

func (x *SuggestTrialsRequest) Reset()

func (*SuggestTrialsRequest) String

func (x *SuggestTrialsRequest) String() string

type SuggestTrialsResponse

type SuggestTrialsResponse struct {

	// A list of Trials.
	Trials []*Trial `protobuf:"bytes,1,rep,name=trials,proto3" json:"trials,omitempty"`
	// The state of the Study.
	StudyState Study_State `` /* 136-byte string literal not displayed */
	// The time at which the operation was started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The time at which operation processing completed.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Response message for [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials].

func (*SuggestTrialsResponse) Descriptor deprecated

func (*SuggestTrialsResponse) Descriptor() ([]byte, []int)

Deprecated: Use SuggestTrialsResponse.ProtoReflect.Descriptor instead.

func (*SuggestTrialsResponse) GetEndTime

func (x *SuggestTrialsResponse) GetEndTime() *timestamppb.Timestamp

func (*SuggestTrialsResponse) GetStartTime

func (x *SuggestTrialsResponse) GetStartTime() *timestamppb.Timestamp

func (*SuggestTrialsResponse) GetStudyState

func (x *SuggestTrialsResponse) GetStudyState() Study_State

func (*SuggestTrialsResponse) GetTrials

func (x *SuggestTrialsResponse) GetTrials() []*Trial

func (*SuggestTrialsResponse) ProtoMessage

func (*SuggestTrialsResponse) ProtoMessage()

func (*SuggestTrialsResponse) ProtoReflect

func (x *SuggestTrialsResponse) ProtoReflect() protoreflect.Message

func (*SuggestTrialsResponse) Reset

func (x *SuggestTrialsResponse) Reset()

func (*SuggestTrialsResponse) String

func (x *SuggestTrialsResponse) String() string

type SupervisedHyperParameters added in v1.67.0

type SupervisedHyperParameters struct {

	// Optional. Number of training epoches for this tuning job.
	EpochCount int64 `protobuf:"varint,1,opt,name=epoch_count,json=epochCount,proto3" json:"epoch_count,omitempty"`
	// Optional. Learning rate multiplier for tuning.
	LearningRateMultiplier float64 `` /* 131-byte string literal not displayed */
	// Optional. Adapter size for tuning.
	AdapterSize SupervisedHyperParameters_AdapterSize `` /* 165-byte string literal not displayed */
	// contains filtered or unexported fields
}

Hyperparameters for SFT.

func (*SupervisedHyperParameters) Descriptor deprecated added in v1.67.0

func (*SupervisedHyperParameters) Descriptor() ([]byte, []int)

Deprecated: Use SupervisedHyperParameters.ProtoReflect.Descriptor instead.

func (*SupervisedHyperParameters) GetAdapterSize added in v1.67.0

func (*SupervisedHyperParameters) GetEpochCount added in v1.67.0

func (x *SupervisedHyperParameters) GetEpochCount() int64

func (*SupervisedHyperParameters) GetLearningRateMultiplier added in v1.67.0

func (x *SupervisedHyperParameters) GetLearningRateMultiplier() float64

func (*SupervisedHyperParameters) ProtoMessage added in v1.67.0

func (*SupervisedHyperParameters) ProtoMessage()

func (*SupervisedHyperParameters) ProtoReflect added in v1.67.0

func (*SupervisedHyperParameters) Reset added in v1.67.0

func (x *SupervisedHyperParameters) Reset()

func (*SupervisedHyperParameters) String added in v1.67.0

func (x *SupervisedHyperParameters) String() string

type SupervisedHyperParameters_AdapterSize added in v1.67.0

type SupervisedHyperParameters_AdapterSize int32

Supported adapter sizes for tuning.

const (
	// Adapter size is unspecified.
	SupervisedHyperParameters_ADAPTER_SIZE_UNSPECIFIED SupervisedHyperParameters_AdapterSize = 0
	// Adapter size 1.
	SupervisedHyperParameters_ADAPTER_SIZE_ONE SupervisedHyperParameters_AdapterSize = 1
	// Adapter size 4.
	SupervisedHyperParameters_ADAPTER_SIZE_FOUR SupervisedHyperParameters_AdapterSize = 2
	// Adapter size 8.
	SupervisedHyperParameters_ADAPTER_SIZE_EIGHT SupervisedHyperParameters_AdapterSize = 3
	// Adapter size 16.
	SupervisedHyperParameters_ADAPTER_SIZE_SIXTEEN SupervisedHyperParameters_AdapterSize = 4
)

func (SupervisedHyperParameters_AdapterSize) Descriptor added in v1.67.0

func (SupervisedHyperParameters_AdapterSize) Enum added in v1.67.0

func (SupervisedHyperParameters_AdapterSize) EnumDescriptor deprecated added in v1.67.0

func (SupervisedHyperParameters_AdapterSize) EnumDescriptor() ([]byte, []int)

Deprecated: Use SupervisedHyperParameters_AdapterSize.Descriptor instead.

func (SupervisedHyperParameters_AdapterSize) Number added in v1.67.0

func (SupervisedHyperParameters_AdapterSize) String added in v1.67.0

func (SupervisedHyperParameters_AdapterSize) Type added in v1.67.0

type SupervisedTuningDataStats added in v1.67.0

type SupervisedTuningDataStats struct {

	// Output only. Number of examples in the tuning dataset.
	TuningDatasetExampleCount int64 `` /* 141-byte string literal not displayed */
	// Output only. Number of tuning characters in the tuning dataset.
	TotalTuningCharacterCount int64 `` /* 141-byte string literal not displayed */
	// Output only. Number of billable characters in the tuning dataset.
	TotalBillableCharacterCount int64 `` /* 147-byte string literal not displayed */
	// Output only. Number of tuning steps for this Tuning Job.
	TuningStepCount int64 `protobuf:"varint,4,opt,name=tuning_step_count,json=tuningStepCount,proto3" json:"tuning_step_count,omitempty"`
	// Output only. Dataset distributions for the user input tokens.
	UserInputTokenDistribution *SupervisedTuningDatasetDistribution `` /* 143-byte string literal not displayed */
	// Output only. Dataset distributions for the user output tokens.
	UserOutputTokenDistribution *SupervisedTuningDatasetDistribution `` /* 146-byte string literal not displayed */
	// Output only. Dataset distributions for the messages per example.
	UserMessagePerExampleDistribution *SupervisedTuningDatasetDistribution `` /* 166-byte string literal not displayed */
	// Output only. Sample user messages in the training dataset uri.
	UserDatasetExamples []*Content `protobuf:"bytes,8,rep,name=user_dataset_examples,json=userDatasetExamples,proto3" json:"user_dataset_examples,omitempty"`
	// contains filtered or unexported fields
}

Tuning data statistics for Supervised Tuning.

func (*SupervisedTuningDataStats) Descriptor deprecated added in v1.67.0

func (*SupervisedTuningDataStats) Descriptor() ([]byte, []int)

Deprecated: Use SupervisedTuningDataStats.ProtoReflect.Descriptor instead.

func (*SupervisedTuningDataStats) GetTotalBillableCharacterCount added in v1.67.0

func (x *SupervisedTuningDataStats) GetTotalBillableCharacterCount() int64

func (*SupervisedTuningDataStats) GetTotalTuningCharacterCount added in v1.67.0

func (x *SupervisedTuningDataStats) GetTotalTuningCharacterCount() int64

func (*SupervisedTuningDataStats) GetTuningDatasetExampleCount added in v1.67.0

func (x *SupervisedTuningDataStats) GetTuningDatasetExampleCount() int64

func (*SupervisedTuningDataStats) GetTuningStepCount added in v1.67.0

func (x *SupervisedTuningDataStats) GetTuningStepCount() int64

func (*SupervisedTuningDataStats) GetUserDatasetExamples added in v1.67.0

func (x *SupervisedTuningDataStats) GetUserDatasetExamples() []*Content

func (*SupervisedTuningDataStats) GetUserInputTokenDistribution added in v1.67.0

func (x *SupervisedTuningDataStats) GetUserInputTokenDistribution() *SupervisedTuningDatasetDistribution

func (*SupervisedTuningDataStats) GetUserMessagePerExampleDistribution added in v1.67.0

func (x *SupervisedTuningDataStats) GetUserMessagePerExampleDistribution() *SupervisedTuningDatasetDistribution

func (*SupervisedTuningDataStats) GetUserOutputTokenDistribution added in v1.67.0

func (x *SupervisedTuningDataStats) GetUserOutputTokenDistribution() *SupervisedTuningDatasetDistribution

func (*SupervisedTuningDataStats) ProtoMessage added in v1.67.0

func (*SupervisedTuningDataStats) ProtoMessage()

func (*SupervisedTuningDataStats) ProtoReflect added in v1.67.0

func (*SupervisedTuningDataStats) Reset added in v1.67.0

func (x *SupervisedTuningDataStats) Reset()

func (*SupervisedTuningDataStats) String added in v1.67.0

func (x *SupervisedTuningDataStats) String() string

type SupervisedTuningDatasetDistribution added in v1.67.0

type SupervisedTuningDatasetDistribution struct {

	// Output only. Sum of a given population of values.
	Sum int64 `protobuf:"varint,1,opt,name=sum,proto3" json:"sum,omitempty"`
	// Output only. The minimum of the population values.
	Min float64 `protobuf:"fixed64,2,opt,name=min,proto3" json:"min,omitempty"`
	// Output only. The maximum of the population values.
	Max float64 `protobuf:"fixed64,3,opt,name=max,proto3" json:"max,omitempty"`
	// Output only. The arithmetic mean of the values in the population.
	Mean float64 `protobuf:"fixed64,4,opt,name=mean,proto3" json:"mean,omitempty"`
	// Output only. The median of the values in the population.
	Median float64 `protobuf:"fixed64,5,opt,name=median,proto3" json:"median,omitempty"`
	// Output only. The 5th percentile of the values in the population.
	P5 float64 `protobuf:"fixed64,6,opt,name=p5,proto3" json:"p5,omitempty"`
	// Output only. The 95th percentile of the values in the population.
	P95 float64 `protobuf:"fixed64,7,opt,name=p95,proto3" json:"p95,omitempty"`
	// Output only. Defines the histogram bucket.
	Buckets []*SupervisedTuningDatasetDistribution_DatasetBucket `protobuf:"bytes,8,rep,name=buckets,proto3" json:"buckets,omitempty"`
	// contains filtered or unexported fields
}

Dataset distribution for Supervised Tuning.

func (*SupervisedTuningDatasetDistribution) Descriptor deprecated added in v1.67.0

func (*SupervisedTuningDatasetDistribution) Descriptor() ([]byte, []int)

Deprecated: Use SupervisedTuningDatasetDistribution.ProtoReflect.Descriptor instead.

func (*SupervisedTuningDatasetDistribution) GetBuckets added in v1.67.0

func (*SupervisedTuningDatasetDistribution) GetMax added in v1.67.0

func (*SupervisedTuningDatasetDistribution) GetMean added in v1.67.0

func (*SupervisedTuningDatasetDistribution) GetMedian added in v1.67.0

func (*SupervisedTuningDatasetDistribution) GetMin added in v1.67.0

func (*SupervisedTuningDatasetDistribution) GetP5 added in v1.67.0

func (*SupervisedTuningDatasetDistribution) GetP95 added in v1.67.0

func (*SupervisedTuningDatasetDistribution) GetSum added in v1.67.0

func (*SupervisedTuningDatasetDistribution) ProtoMessage added in v1.67.0

func (*SupervisedTuningDatasetDistribution) ProtoMessage()

func (*SupervisedTuningDatasetDistribution) ProtoReflect added in v1.67.0

func (*SupervisedTuningDatasetDistribution) Reset added in v1.67.0

func (*SupervisedTuningDatasetDistribution) String added in v1.67.0

type SupervisedTuningDatasetDistribution_DatasetBucket added in v1.67.0

type SupervisedTuningDatasetDistribution_DatasetBucket struct {

	// Output only. Number of values in the bucket.
	Count float64 `protobuf:"fixed64,1,opt,name=count,proto3" json:"count,omitempty"`
	// Output only. Left bound of the bucket.
	Left float64 `protobuf:"fixed64,2,opt,name=left,proto3" json:"left,omitempty"`
	// Output only. Right bound of the bucket.
	Right float64 `protobuf:"fixed64,3,opt,name=right,proto3" json:"right,omitempty"`
	// contains filtered or unexported fields
}

Dataset bucket used to create a histogram for the distribution given a population of values.

func (*SupervisedTuningDatasetDistribution_DatasetBucket) Descriptor deprecated added in v1.67.0

Deprecated: Use SupervisedTuningDatasetDistribution_DatasetBucket.ProtoReflect.Descriptor instead.

func (*SupervisedTuningDatasetDistribution_DatasetBucket) GetCount added in v1.67.0

func (*SupervisedTuningDatasetDistribution_DatasetBucket) GetLeft added in v1.67.0

func (*SupervisedTuningDatasetDistribution_DatasetBucket) GetRight added in v1.67.0

func (*SupervisedTuningDatasetDistribution_DatasetBucket) ProtoMessage added in v1.67.0

func (*SupervisedTuningDatasetDistribution_DatasetBucket) ProtoReflect added in v1.67.0

func (*SupervisedTuningDatasetDistribution_DatasetBucket) Reset added in v1.67.0

func (*SupervisedTuningDatasetDistribution_DatasetBucket) String added in v1.67.0

type SupervisedTuningSpec added in v1.67.0

type SupervisedTuningSpec struct {

	// Required. Cloud Storage path to file containing training dataset for
	// tuning.
	TrainingDatasetUri string `protobuf:"bytes,1,opt,name=training_dataset_uri,json=trainingDatasetUri,proto3" json:"training_dataset_uri,omitempty"`
	// Optional. Cloud Storage path to file containing validation dataset for
	// tuning.
	ValidationDatasetUri string `protobuf:"bytes,2,opt,name=validation_dataset_uri,json=validationDatasetUri,proto3" json:"validation_dataset_uri,omitempty"`
	// Optional. Hyperparameters for SFT.
	HyperParameters *SupervisedHyperParameters `protobuf:"bytes,3,opt,name=hyper_parameters,json=hyperParameters,proto3" json:"hyper_parameters,omitempty"`
	// contains filtered or unexported fields
}

Tuning Spec for Supervised Tuning.

func (*SupervisedTuningSpec) Descriptor deprecated added in v1.67.0

func (*SupervisedTuningSpec) Descriptor() ([]byte, []int)

Deprecated: Use SupervisedTuningSpec.ProtoReflect.Descriptor instead.

func (*SupervisedTuningSpec) GetHyperParameters added in v1.67.0

func (x *SupervisedTuningSpec) GetHyperParameters() *SupervisedHyperParameters

func (*SupervisedTuningSpec) GetTrainingDatasetUri added in v1.67.0

func (x *SupervisedTuningSpec) GetTrainingDatasetUri() string

func (*SupervisedTuningSpec) GetValidationDatasetUri added in v1.67.0

func (x *SupervisedTuningSpec) GetValidationDatasetUri() string

func (*SupervisedTuningSpec) ProtoMessage added in v1.67.0

func (*SupervisedTuningSpec) ProtoMessage()

func (*SupervisedTuningSpec) ProtoReflect added in v1.67.0

func (x *SupervisedTuningSpec) ProtoReflect() protoreflect.Message

func (*SupervisedTuningSpec) Reset added in v1.67.0

func (x *SupervisedTuningSpec) Reset()

func (*SupervisedTuningSpec) String added in v1.67.0

func (x *SupervisedTuningSpec) String() string

type SyncFeatureViewRequest added in v1.54.0

type SyncFeatureViewRequest struct {

	// Required. Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
	FeatureView string `protobuf:"bytes,1,opt,name=feature_view,json=featureView,proto3" json:"feature_view,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.SyncFeatureView][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.SyncFeatureView].

func (*SyncFeatureViewRequest) Descriptor deprecated added in v1.54.0

func (*SyncFeatureViewRequest) Descriptor() ([]byte, []int)

Deprecated: Use SyncFeatureViewRequest.ProtoReflect.Descriptor instead.

func (*SyncFeatureViewRequest) GetFeatureView added in v1.54.0

func (x *SyncFeatureViewRequest) GetFeatureView() string

func (*SyncFeatureViewRequest) ProtoMessage added in v1.54.0

func (*SyncFeatureViewRequest) ProtoMessage()

func (*SyncFeatureViewRequest) ProtoReflect added in v1.54.0

func (x *SyncFeatureViewRequest) ProtoReflect() protoreflect.Message

func (*SyncFeatureViewRequest) Reset added in v1.54.0

func (x *SyncFeatureViewRequest) Reset()

func (*SyncFeatureViewRequest) String added in v1.54.0

func (x *SyncFeatureViewRequest) String() string

type SyncFeatureViewResponse added in v1.54.0

type SyncFeatureViewResponse struct {

	// Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`
	FeatureViewSync string `protobuf:"bytes,1,opt,name=feature_view_sync,json=featureViewSync,proto3" json:"feature_view_sync,omitempty"`
	// contains filtered or unexported fields
}

Respose message for [FeatureOnlineStoreAdminService.SyncFeatureView][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.SyncFeatureView].

func (*SyncFeatureViewResponse) Descriptor deprecated added in v1.54.0

func (*SyncFeatureViewResponse) Descriptor() ([]byte, []int)

Deprecated: Use SyncFeatureViewResponse.ProtoReflect.Descriptor instead.

func (*SyncFeatureViewResponse) GetFeatureViewSync added in v1.54.0

func (x *SyncFeatureViewResponse) GetFeatureViewSync() string

func (*SyncFeatureViewResponse) ProtoMessage added in v1.54.0

func (*SyncFeatureViewResponse) ProtoMessage()

func (*SyncFeatureViewResponse) ProtoReflect added in v1.54.0

func (x *SyncFeatureViewResponse) ProtoReflect() protoreflect.Message

func (*SyncFeatureViewResponse) Reset added in v1.54.0

func (x *SyncFeatureViewResponse) Reset()

func (*SyncFeatureViewResponse) String added in v1.54.0

func (x *SyncFeatureViewResponse) String() string

type TFRecordDestination

type TFRecordDestination struct {

	// Required. Google Cloud Storage location.
	GcsDestination *GcsDestination `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3" json:"gcs_destination,omitempty"`
	// contains filtered or unexported fields
}

The storage details for TFRecord output content.

func (*TFRecordDestination) Descriptor deprecated

func (*TFRecordDestination) Descriptor() ([]byte, []int)

Deprecated: Use TFRecordDestination.ProtoReflect.Descriptor instead.

func (*TFRecordDestination) GetGcsDestination

func (x *TFRecordDestination) GetGcsDestination() *GcsDestination

func (*TFRecordDestination) ProtoMessage

func (*TFRecordDestination) ProtoMessage()

func (*TFRecordDestination) ProtoReflect

func (x *TFRecordDestination) ProtoReflect() protoreflect.Message

func (*TFRecordDestination) Reset

func (x *TFRecordDestination) Reset()

func (*TFRecordDestination) String

func (x *TFRecordDestination) String() string

type Tensor added in v1.48.0

type Tensor struct {

	// The data type of tensor.
	Dtype Tensor_DataType `protobuf:"varint,1,opt,name=dtype,proto3,enum=google.cloud.aiplatform.v1.Tensor_DataType" json:"dtype,omitempty"`
	// Shape of the tensor.
	Shape []int64 `protobuf:"varint,2,rep,packed,name=shape,proto3" json:"shape,omitempty"`
	// Type specific representations that make it easy to create tensor protos in
	// all languages.  Only the representation corresponding to "dtype" can
	// be set.  The values hold the flattened representation of the tensor in
	// row major order.
	//
	// [BOOL][google.aiplatform.master.Tensor.DataType.BOOL]
	BoolVal []bool `protobuf:"varint,3,rep,packed,name=bool_val,json=boolVal,proto3" json:"bool_val,omitempty"`
	// [STRING][google.aiplatform.master.Tensor.DataType.STRING]
	StringVal []string `protobuf:"bytes,14,rep,name=string_val,json=stringVal,proto3" json:"string_val,omitempty"`
	// [STRING][google.aiplatform.master.Tensor.DataType.STRING]
	BytesVal [][]byte `protobuf:"bytes,15,rep,name=bytes_val,json=bytesVal,proto3" json:"bytes_val,omitempty"`
	// [FLOAT][google.aiplatform.master.Tensor.DataType.FLOAT]
	FloatVal []float32 `protobuf:"fixed32,5,rep,packed,name=float_val,json=floatVal,proto3" json:"float_val,omitempty"`
	// [DOUBLE][google.aiplatform.master.Tensor.DataType.DOUBLE]
	DoubleVal []float64 `protobuf:"fixed64,6,rep,packed,name=double_val,json=doubleVal,proto3" json:"double_val,omitempty"`
	// [INT_8][google.aiplatform.master.Tensor.DataType.INT8]
	// [INT_16][google.aiplatform.master.Tensor.DataType.INT16]
	// [INT_32][google.aiplatform.master.Tensor.DataType.INT32]
	IntVal []int32 `protobuf:"varint,7,rep,packed,name=int_val,json=intVal,proto3" json:"int_val,omitempty"`
	// [INT64][google.aiplatform.master.Tensor.DataType.INT64]
	Int64Val []int64 `protobuf:"varint,8,rep,packed,name=int64_val,json=int64Val,proto3" json:"int64_val,omitempty"`
	// [UINT8][google.aiplatform.master.Tensor.DataType.UINT8]
	// [UINT16][google.aiplatform.master.Tensor.DataType.UINT16]
	// [UINT32][google.aiplatform.master.Tensor.DataType.UINT32]
	UintVal []uint32 `protobuf:"varint,9,rep,packed,name=uint_val,json=uintVal,proto3" json:"uint_val,omitempty"`
	// [UINT64][google.aiplatform.master.Tensor.DataType.UINT64]
	Uint64Val []uint64 `protobuf:"varint,10,rep,packed,name=uint64_val,json=uint64Val,proto3" json:"uint64_val,omitempty"`
	// A list of tensor values.
	ListVal []*Tensor `protobuf:"bytes,11,rep,name=list_val,json=listVal,proto3" json:"list_val,omitempty"`
	// A map of string to tensor.
	StructVal map[string]*Tensor `` /* 177-byte string literal not displayed */
	// Serialized raw tensor content.
	TensorVal []byte `protobuf:"bytes,13,opt,name=tensor_val,json=tensorVal,proto3" json:"tensor_val,omitempty"`
	// contains filtered or unexported fields
}

A tensor value type.

func (*Tensor) Descriptor deprecated added in v1.48.0

func (*Tensor) Descriptor() ([]byte, []int)

Deprecated: Use Tensor.ProtoReflect.Descriptor instead.

func (*Tensor) GetBoolVal added in v1.48.0

func (x *Tensor) GetBoolVal() []bool

func (*Tensor) GetBytesVal added in v1.48.0

func (x *Tensor) GetBytesVal() [][]byte

func (*Tensor) GetDoubleVal added in v1.48.0

func (x *Tensor) GetDoubleVal() []float64

func (*Tensor) GetDtype added in v1.48.0

func (x *Tensor) GetDtype() Tensor_DataType

func (*Tensor) GetFloatVal added in v1.48.0

func (x *Tensor) GetFloatVal() []float32

func (*Tensor) GetInt64Val added in v1.48.0

func (x *Tensor) GetInt64Val() []int64

func (*Tensor) GetIntVal added in v1.48.0

func (x *Tensor) GetIntVal() []int32

func (*Tensor) GetListVal added in v1.48.0

func (x *Tensor) GetListVal() []*Tensor

func (*Tensor) GetShape added in v1.48.0

func (x *Tensor) GetShape() []int64

func (*Tensor) GetStringVal added in v1.48.0

func (x *Tensor) GetStringVal() []string

func (*Tensor) GetStructVal added in v1.48.0

func (x *Tensor) GetStructVal() map[string]*Tensor

func (*Tensor) GetTensorVal added in v1.48.0

func (x *Tensor) GetTensorVal() []byte

func (*Tensor) GetUint64Val added in v1.48.0

func (x *Tensor) GetUint64Val() []uint64

func (*Tensor) GetUintVal added in v1.48.0

func (x *Tensor) GetUintVal() []uint32

func (*Tensor) ProtoMessage added in v1.48.0

func (*Tensor) ProtoMessage()

func (*Tensor) ProtoReflect added in v1.48.0

func (x *Tensor) ProtoReflect() protoreflect.Message

func (*Tensor) Reset added in v1.48.0

func (x *Tensor) Reset()

func (*Tensor) String added in v1.48.0

func (x *Tensor) String() string

type Tensor_DataType added in v1.48.0

type Tensor_DataType int32

Data type of the tensor.

const (
	// Not a legal value for DataType. Used to indicate a DataType field has not
	// been set.
	Tensor_DATA_TYPE_UNSPECIFIED Tensor_DataType = 0
	// Data types that all computation devices are expected to be
	// capable to support.
	Tensor_BOOL   Tensor_DataType = 1
	Tensor_STRING Tensor_DataType = 2
	Tensor_FLOAT  Tensor_DataType = 3
	Tensor_DOUBLE Tensor_DataType = 4
	Tensor_INT8   Tensor_DataType = 5
	Tensor_INT16  Tensor_DataType = 6
	Tensor_INT32  Tensor_DataType = 7
	Tensor_INT64  Tensor_DataType = 8
	Tensor_UINT8  Tensor_DataType = 9
	Tensor_UINT16 Tensor_DataType = 10
	Tensor_UINT32 Tensor_DataType = 11
	Tensor_UINT64 Tensor_DataType = 12
)

func (Tensor_DataType) Descriptor added in v1.48.0

func (Tensor_DataType) Enum added in v1.48.0

func (x Tensor_DataType) Enum() *Tensor_DataType

func (Tensor_DataType) EnumDescriptor deprecated added in v1.48.0

func (Tensor_DataType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Tensor_DataType.Descriptor instead.

func (Tensor_DataType) Number added in v1.48.0

func (Tensor_DataType) String added in v1.48.0

func (x Tensor_DataType) String() string

func (Tensor_DataType) Type added in v1.48.0

type Tensorboard

type Tensorboard struct {

	// Output only. Name of the Tensorboard.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. User provided name of this Tensorboard.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Description of this Tensorboard.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Customer-managed encryption key spec for a Tensorboard. If set, this
	// Tensorboard and all sub-resources of this Tensorboard will be secured by
	// this key.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,11,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// Output only. Consumer project Cloud Storage path prefix used to store blob
	// data, which can either be a bucket or directory. Does not end with a '/'.
	BlobStoragePathPrefix string `` /* 129-byte string literal not displayed */
	// Output only. The number of Runs stored in this Tensorboard.
	RunCount int32 `protobuf:"varint,5,opt,name=run_count,json=runCount,proto3" json:"run_count,omitempty"`
	// Output only. Timestamp when this Tensorboard was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Tensorboard was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The labels with user-defined metadata to organize your Tensorboards.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one Tensorboard
	// (System labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Used to perform a consistent read-modify-write updates. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,9,opt,name=etag,proto3" json:"etag,omitempty"`
	// Used to indicate if the TensorBoard instance is the default one.
	// Each project & region can have at most one default TensorBoard instance.
	// Creation of a default TensorBoard instance and updating an existing
	// TensorBoard instance to be default will mark all other TensorBoard
	// instances (if any) as non default.
	IsDefault bool `protobuf:"varint,12,opt,name=is_default,json=isDefault,proto3" json:"is_default,omitempty"`
	// contains filtered or unexported fields
}

Tensorboard is a physical database that stores users' training metrics. A default Tensorboard is provided in each region of a Google Cloud project. If needed users can also create extra Tensorboards in their projects.

func (*Tensorboard) Descriptor deprecated

func (*Tensorboard) Descriptor() ([]byte, []int)

Deprecated: Use Tensorboard.ProtoReflect.Descriptor instead.

func (*Tensorboard) GetBlobStoragePathPrefix

func (x *Tensorboard) GetBlobStoragePathPrefix() string

func (*Tensorboard) GetCreateTime

func (x *Tensorboard) GetCreateTime() *timestamppb.Timestamp

func (*Tensorboard) GetDescription

func (x *Tensorboard) GetDescription() string

func (*Tensorboard) GetDisplayName

func (x *Tensorboard) GetDisplayName() string

func (*Tensorboard) GetEncryptionSpec

func (x *Tensorboard) GetEncryptionSpec() *EncryptionSpec

func (*Tensorboard) GetEtag

func (x *Tensorboard) GetEtag() string

func (*Tensorboard) GetIsDefault added in v1.39.0

func (x *Tensorboard) GetIsDefault() bool

func (*Tensorboard) GetLabels

func (x *Tensorboard) GetLabels() map[string]string

func (*Tensorboard) GetName

func (x *Tensorboard) GetName() string

func (*Tensorboard) GetRunCount

func (x *Tensorboard) GetRunCount() int32

func (*Tensorboard) GetUpdateTime

func (x *Tensorboard) GetUpdateTime() *timestamppb.Timestamp

func (*Tensorboard) ProtoMessage

func (*Tensorboard) ProtoMessage()

func (*Tensorboard) ProtoReflect

func (x *Tensorboard) ProtoReflect() protoreflect.Message

func (*Tensorboard) Reset

func (x *Tensorboard) Reset()

func (*Tensorboard) String

func (x *Tensorboard) String() string

type TensorboardBlob

type TensorboardBlob struct {

	// Output only. A URI safe key uniquely identifying a blob. Can be used to
	// locate the blob stored in the Cloud Storage bucket of the consumer project.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Optional. The bytes of the blob is not present unless it's returned by the
	// ReadTensorboardBlobData endpoint.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

One blob (e.g, image, graph) viewable on a blob metric plot.

func (*TensorboardBlob) Descriptor deprecated

func (*TensorboardBlob) Descriptor() ([]byte, []int)

Deprecated: Use TensorboardBlob.ProtoReflect.Descriptor instead.

func (*TensorboardBlob) GetData

func (x *TensorboardBlob) GetData() []byte

func (*TensorboardBlob) GetId

func (x *TensorboardBlob) GetId() string

func (*TensorboardBlob) ProtoMessage

func (*TensorboardBlob) ProtoMessage()

func (*TensorboardBlob) ProtoReflect

func (x *TensorboardBlob) ProtoReflect() protoreflect.Message

func (*TensorboardBlob) Reset

func (x *TensorboardBlob) Reset()

func (*TensorboardBlob) String

func (x *TensorboardBlob) String() string

type TensorboardBlobSequence

type TensorboardBlobSequence struct {

	// List of blobs contained within the sequence.
	Values []*TensorboardBlob `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*TensorboardBlobSequence) Descriptor deprecated

func (*TensorboardBlobSequence) Descriptor() ([]byte, []int)

Deprecated: Use TensorboardBlobSequence.ProtoReflect.Descriptor instead.

func (*TensorboardBlobSequence) GetValues

func (x *TensorboardBlobSequence) GetValues() []*TensorboardBlob

func (*TensorboardBlobSequence) ProtoMessage

func (*TensorboardBlobSequence) ProtoMessage()

func (*TensorboardBlobSequence) ProtoReflect

func (x *TensorboardBlobSequence) ProtoReflect() protoreflect.Message

func (*TensorboardBlobSequence) Reset

func (x *TensorboardBlobSequence) Reset()

func (*TensorboardBlobSequence) String

func (x *TensorboardBlobSequence) String() string

type TensorboardExperiment

type TensorboardExperiment struct {

	// Output only. Name of the TensorboardExperiment.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// User provided name of this TensorboardExperiment.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Description of this TensorboardExperiment.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. Timestamp when this TensorboardExperiment was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this TensorboardExperiment was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The labels with user-defined metadata to organize your
	// TensorboardExperiment.
	//
	// Label keys and values cannot be longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one Dataset (System
	// labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with `aiplatform.googleapis.com/`
	// and are immutable. The following system labels exist for each Dataset:
	//
	//   - `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its
	//     value is the
	//     [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
	//     title.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Used to perform consistent read-modify-write updates. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,7,opt,name=etag,proto3" json:"etag,omitempty"`
	// Immutable. Source of the TensorboardExperiment. Example: a custom training
	// job.
	Source string `protobuf:"bytes,8,opt,name=source,proto3" json:"source,omitempty"`
	// contains filtered or unexported fields
}

A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.

func (*TensorboardExperiment) Descriptor deprecated

func (*TensorboardExperiment) Descriptor() ([]byte, []int)

Deprecated: Use TensorboardExperiment.ProtoReflect.Descriptor instead.

func (*TensorboardExperiment) GetCreateTime

func (x *TensorboardExperiment) GetCreateTime() *timestamppb.Timestamp

func (*TensorboardExperiment) GetDescription

func (x *TensorboardExperiment) GetDescription() string

func (*TensorboardExperiment) GetDisplayName

func (x *TensorboardExperiment) GetDisplayName() string

func (*TensorboardExperiment) GetEtag

func (x *TensorboardExperiment) GetEtag() string

func (*TensorboardExperiment) GetLabels

func (x *TensorboardExperiment) GetLabels() map[string]string

func (*TensorboardExperiment) GetName

func (x *TensorboardExperiment) GetName() string

func (*TensorboardExperiment) GetSource

func (x *TensorboardExperiment) GetSource() string

func (*TensorboardExperiment) GetUpdateTime

func (x *TensorboardExperiment) GetUpdateTime() *timestamppb.Timestamp

func (*TensorboardExperiment) ProtoMessage

func (*TensorboardExperiment) ProtoMessage()

func (*TensorboardExperiment) ProtoReflect

func (x *TensorboardExperiment) ProtoReflect() protoreflect.Message

func (*TensorboardExperiment) Reset

func (x *TensorboardExperiment) Reset()

func (*TensorboardExperiment) String

func (x *TensorboardExperiment) String() string

type TensorboardRun

type TensorboardRun struct {

	// Output only. Name of the TensorboardRun.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. User provided name of this TensorboardRun.
	// This value must be unique among all TensorboardRuns
	// belonging to the same parent TensorboardExperiment.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Description of this TensorboardRun.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. Timestamp when this TensorboardRun was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this TensorboardRun was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The labels with user-defined metadata to organize your TensorboardRuns.
	//
	// This field will be used to filter and visualize Runs in the Tensorboard UI.
	// For example, a Vertex AI training job can set a label
	// aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
	// within that job. An end user can set a label experiment_id=xxxxx for all
	// the runs produced in a Jupyter notebook. These runs can be grouped by a
	// label value and visualized together in the Tensorboard UI.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one TensorboardRun
	// (System labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Used to perform a consistent read-modify-write updates. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,9,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

TensorboardRun maps to a specific execution of a training job with a given set of hyperparameter values, model definition, dataset, etc

func (*TensorboardRun) Descriptor deprecated

func (*TensorboardRun) Descriptor() ([]byte, []int)

Deprecated: Use TensorboardRun.ProtoReflect.Descriptor instead.

func (*TensorboardRun) GetCreateTime

func (x *TensorboardRun) GetCreateTime() *timestamppb.Timestamp

func (*TensorboardRun) GetDescription

func (x *TensorboardRun) GetDescription() string

func (*TensorboardRun) GetDisplayName

func (x *TensorboardRun) GetDisplayName() string

func (*TensorboardRun) GetEtag

func (x *TensorboardRun) GetEtag() string

func (*TensorboardRun) GetLabels

func (x *TensorboardRun) GetLabels() map[string]string

func (*TensorboardRun) GetName

func (x *TensorboardRun) GetName() string

func (*TensorboardRun) GetUpdateTime

func (x *TensorboardRun) GetUpdateTime() *timestamppb.Timestamp

func (*TensorboardRun) ProtoMessage

func (*TensorboardRun) ProtoMessage()

func (*TensorboardRun) ProtoReflect

func (x *TensorboardRun) ProtoReflect() protoreflect.Message

func (*TensorboardRun) Reset

func (x *TensorboardRun) Reset()

func (*TensorboardRun) String

func (x *TensorboardRun) String() string

type TensorboardServiceClient

type TensorboardServiceClient interface {
	// Creates a Tensorboard.
	CreateTensorboard(ctx context.Context, in *CreateTensorboardRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a Tensorboard.
	GetTensorboard(ctx context.Context, in *GetTensorboardRequest, opts ...grpc.CallOption) (*Tensorboard, error)
	// Updates a Tensorboard.
	UpdateTensorboard(ctx context.Context, in *UpdateTensorboardRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Lists Tensorboards in a Location.
	ListTensorboards(ctx context.Context, in *ListTensorboardsRequest, opts ...grpc.CallOption) (*ListTensorboardsResponse, error)
	// Deletes a Tensorboard.
	DeleteTensorboard(ctx context.Context, in *DeleteTensorboardRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Returns a list of monthly active users for a given TensorBoard instance.
	ReadTensorboardUsage(ctx context.Context, in *ReadTensorboardUsageRequest, opts ...grpc.CallOption) (*ReadTensorboardUsageResponse, error)
	// Returns the storage size for a given TensorBoard instance.
	ReadTensorboardSize(ctx context.Context, in *ReadTensorboardSizeRequest, opts ...grpc.CallOption) (*ReadTensorboardSizeResponse, error)
	// Creates a TensorboardExperiment.
	CreateTensorboardExperiment(ctx context.Context, in *CreateTensorboardExperimentRequest, opts ...grpc.CallOption) (*TensorboardExperiment, error)
	// Gets a TensorboardExperiment.
	GetTensorboardExperiment(ctx context.Context, in *GetTensorboardExperimentRequest, opts ...grpc.CallOption) (*TensorboardExperiment, error)
	// Updates a TensorboardExperiment.
	UpdateTensorboardExperiment(ctx context.Context, in *UpdateTensorboardExperimentRequest, opts ...grpc.CallOption) (*TensorboardExperiment, error)
	// Lists TensorboardExperiments in a Location.
	ListTensorboardExperiments(ctx context.Context, in *ListTensorboardExperimentsRequest, opts ...grpc.CallOption) (*ListTensorboardExperimentsResponse, error)
	// Deletes a TensorboardExperiment.
	DeleteTensorboardExperiment(ctx context.Context, in *DeleteTensorboardExperimentRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a TensorboardRun.
	CreateTensorboardRun(ctx context.Context, in *CreateTensorboardRunRequest, opts ...grpc.CallOption) (*TensorboardRun, error)
	// Batch create TensorboardRuns.
	BatchCreateTensorboardRuns(ctx context.Context, in *BatchCreateTensorboardRunsRequest, opts ...grpc.CallOption) (*BatchCreateTensorboardRunsResponse, error)
	// Gets a TensorboardRun.
	GetTensorboardRun(ctx context.Context, in *GetTensorboardRunRequest, opts ...grpc.CallOption) (*TensorboardRun, error)
	// Updates a TensorboardRun.
	UpdateTensorboardRun(ctx context.Context, in *UpdateTensorboardRunRequest, opts ...grpc.CallOption) (*TensorboardRun, error)
	// Lists TensorboardRuns in a Location.
	ListTensorboardRuns(ctx context.Context, in *ListTensorboardRunsRequest, opts ...grpc.CallOption) (*ListTensorboardRunsResponse, error)
	// Deletes a TensorboardRun.
	DeleteTensorboardRun(ctx context.Context, in *DeleteTensorboardRunRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
	BatchCreateTensorboardTimeSeries(ctx context.Context, in *BatchCreateTensorboardTimeSeriesRequest, opts ...grpc.CallOption) (*BatchCreateTensorboardTimeSeriesResponse, error)
	// Creates a TensorboardTimeSeries.
	CreateTensorboardTimeSeries(ctx context.Context, in *CreateTensorboardTimeSeriesRequest, opts ...grpc.CallOption) (*TensorboardTimeSeries, error)
	// Gets a TensorboardTimeSeries.
	GetTensorboardTimeSeries(ctx context.Context, in *GetTensorboardTimeSeriesRequest, opts ...grpc.CallOption) (*TensorboardTimeSeries, error)
	// Updates a TensorboardTimeSeries.
	UpdateTensorboardTimeSeries(ctx context.Context, in *UpdateTensorboardTimeSeriesRequest, opts ...grpc.CallOption) (*TensorboardTimeSeries, error)
	// Lists TensorboardTimeSeries in a Location.
	ListTensorboardTimeSeries(ctx context.Context, in *ListTensorboardTimeSeriesRequest, opts ...grpc.CallOption) (*ListTensorboardTimeSeriesResponse, error)
	// Deletes a TensorboardTimeSeries.
	DeleteTensorboardTimeSeries(ctx context.Context, in *DeleteTensorboardTimeSeriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Reads multiple TensorboardTimeSeries' data. The data point number limit is
	// 1000 for scalars, 100 for tensors and blob references. If the number of
	// data points stored is less than the limit, all data is returned.
	// Otherwise, the number limit of data points is randomly selected from
	// this time series and returned.
	BatchReadTensorboardTimeSeriesData(ctx context.Context, in *BatchReadTensorboardTimeSeriesDataRequest, opts ...grpc.CallOption) (*BatchReadTensorboardTimeSeriesDataResponse, error)
	// Reads a TensorboardTimeSeries' data. By default, if the number of data
	// points stored is less than 1000, all data is returned. Otherwise, 1000
	// data points is randomly selected from this time series and returned.
	// This value can be changed by changing max_data_points, which can't be
	// greater than 10k.
	ReadTensorboardTimeSeriesData(ctx context.Context, in *ReadTensorboardTimeSeriesDataRequest, opts ...grpc.CallOption) (*ReadTensorboardTimeSeriesDataResponse, error)
	// Gets bytes of TensorboardBlobs.
	// This is to allow reading blob data stored in consumer project's Cloud
	// Storage bucket without users having to obtain Cloud Storage access
	// permission.
	ReadTensorboardBlobData(ctx context.Context, in *ReadTensorboardBlobDataRequest, opts ...grpc.CallOption) (TensorboardService_ReadTensorboardBlobDataClient, error)
	// Write time series data points of multiple TensorboardTimeSeries in multiple
	// TensorboardRun's. If any data fail to be ingested, an error is returned.
	WriteTensorboardExperimentData(ctx context.Context, in *WriteTensorboardExperimentDataRequest, opts ...grpc.CallOption) (*WriteTensorboardExperimentDataResponse, error)
	// Write time series data points into multiple TensorboardTimeSeries under
	// a TensorboardRun. If any data fail to be ingested, an error is returned.
	WriteTensorboardRunData(ctx context.Context, in *WriteTensorboardRunDataRequest, opts ...grpc.CallOption) (*WriteTensorboardRunDataResponse, error)
	// Exports a TensorboardTimeSeries' data. Data is returned in paginated
	// responses.
	ExportTensorboardTimeSeriesData(ctx context.Context, in *ExportTensorboardTimeSeriesDataRequest, opts ...grpc.CallOption) (*ExportTensorboardTimeSeriesDataResponse, error)
}

TensorboardServiceClient is the client API for TensorboardService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type TensorboardServiceServer

type TensorboardServiceServer interface {
	// Creates a Tensorboard.
	CreateTensorboard(context.Context, *CreateTensorboardRequest) (*longrunningpb.Operation, error)
	// Gets a Tensorboard.
	GetTensorboard(context.Context, *GetTensorboardRequest) (*Tensorboard, error)
	// Updates a Tensorboard.
	UpdateTensorboard(context.Context, *UpdateTensorboardRequest) (*longrunningpb.Operation, error)
	// Lists Tensorboards in a Location.
	ListTensorboards(context.Context, *ListTensorboardsRequest) (*ListTensorboardsResponse, error)
	// Deletes a Tensorboard.
	DeleteTensorboard(context.Context, *DeleteTensorboardRequest) (*longrunningpb.Operation, error)
	// Returns a list of monthly active users for a given TensorBoard instance.
	ReadTensorboardUsage(context.Context, *ReadTensorboardUsageRequest) (*ReadTensorboardUsageResponse, error)
	// Returns the storage size for a given TensorBoard instance.
	ReadTensorboardSize(context.Context, *ReadTensorboardSizeRequest) (*ReadTensorboardSizeResponse, error)
	// Creates a TensorboardExperiment.
	CreateTensorboardExperiment(context.Context, *CreateTensorboardExperimentRequest) (*TensorboardExperiment, error)
	// Gets a TensorboardExperiment.
	GetTensorboardExperiment(context.Context, *GetTensorboardExperimentRequest) (*TensorboardExperiment, error)
	// Updates a TensorboardExperiment.
	UpdateTensorboardExperiment(context.Context, *UpdateTensorboardExperimentRequest) (*TensorboardExperiment, error)
	// Lists TensorboardExperiments in a Location.
	ListTensorboardExperiments(context.Context, *ListTensorboardExperimentsRequest) (*ListTensorboardExperimentsResponse, error)
	// Deletes a TensorboardExperiment.
	DeleteTensorboardExperiment(context.Context, *DeleteTensorboardExperimentRequest) (*longrunningpb.Operation, error)
	// Creates a TensorboardRun.
	CreateTensorboardRun(context.Context, *CreateTensorboardRunRequest) (*TensorboardRun, error)
	// Batch create TensorboardRuns.
	BatchCreateTensorboardRuns(context.Context, *BatchCreateTensorboardRunsRequest) (*BatchCreateTensorboardRunsResponse, error)
	// Gets a TensorboardRun.
	GetTensorboardRun(context.Context, *GetTensorboardRunRequest) (*TensorboardRun, error)
	// Updates a TensorboardRun.
	UpdateTensorboardRun(context.Context, *UpdateTensorboardRunRequest) (*TensorboardRun, error)
	// Lists TensorboardRuns in a Location.
	ListTensorboardRuns(context.Context, *ListTensorboardRunsRequest) (*ListTensorboardRunsResponse, error)
	// Deletes a TensorboardRun.
	DeleteTensorboardRun(context.Context, *DeleteTensorboardRunRequest) (*longrunningpb.Operation, error)
	// Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
	BatchCreateTensorboardTimeSeries(context.Context, *BatchCreateTensorboardTimeSeriesRequest) (*BatchCreateTensorboardTimeSeriesResponse, error)
	// Creates a TensorboardTimeSeries.
	CreateTensorboardTimeSeries(context.Context, *CreateTensorboardTimeSeriesRequest) (*TensorboardTimeSeries, error)
	// Gets a TensorboardTimeSeries.
	GetTensorboardTimeSeries(context.Context, *GetTensorboardTimeSeriesRequest) (*TensorboardTimeSeries, error)
	// Updates a TensorboardTimeSeries.
	UpdateTensorboardTimeSeries(context.Context, *UpdateTensorboardTimeSeriesRequest) (*TensorboardTimeSeries, error)
	// Lists TensorboardTimeSeries in a Location.
	ListTensorboardTimeSeries(context.Context, *ListTensorboardTimeSeriesRequest) (*ListTensorboardTimeSeriesResponse, error)
	// Deletes a TensorboardTimeSeries.
	DeleteTensorboardTimeSeries(context.Context, *DeleteTensorboardTimeSeriesRequest) (*longrunningpb.Operation, error)
	// Reads multiple TensorboardTimeSeries' data. The data point number limit is
	// 1000 for scalars, 100 for tensors and blob references. If the number of
	// data points stored is less than the limit, all data is returned.
	// Otherwise, the number limit of data points is randomly selected from
	// this time series and returned.
	BatchReadTensorboardTimeSeriesData(context.Context, *BatchReadTensorboardTimeSeriesDataRequest) (*BatchReadTensorboardTimeSeriesDataResponse, error)
	// Reads a TensorboardTimeSeries' data. By default, if the number of data
	// points stored is less than 1000, all data is returned. Otherwise, 1000
	// data points is randomly selected from this time series and returned.
	// This value can be changed by changing max_data_points, which can't be
	// greater than 10k.
	ReadTensorboardTimeSeriesData(context.Context, *ReadTensorboardTimeSeriesDataRequest) (*ReadTensorboardTimeSeriesDataResponse, error)
	// Gets bytes of TensorboardBlobs.
	// This is to allow reading blob data stored in consumer project's Cloud
	// Storage bucket without users having to obtain Cloud Storage access
	// permission.
	ReadTensorboardBlobData(*ReadTensorboardBlobDataRequest, TensorboardService_ReadTensorboardBlobDataServer) error
	// Write time series data points of multiple TensorboardTimeSeries in multiple
	// TensorboardRun's. If any data fail to be ingested, an error is returned.
	WriteTensorboardExperimentData(context.Context, *WriteTensorboardExperimentDataRequest) (*WriteTensorboardExperimentDataResponse, error)
	// Write time series data points into multiple TensorboardTimeSeries under
	// a TensorboardRun. If any data fail to be ingested, an error is returned.
	WriteTensorboardRunData(context.Context, *WriteTensorboardRunDataRequest) (*WriteTensorboardRunDataResponse, error)
	// Exports a TensorboardTimeSeries' data. Data is returned in paginated
	// responses.
	ExportTensorboardTimeSeriesData(context.Context, *ExportTensorboardTimeSeriesDataRequest) (*ExportTensorboardTimeSeriesDataResponse, error)
}

TensorboardServiceServer is the server API for TensorboardService service.

type TensorboardService_ReadTensorboardBlobDataClient

type TensorboardService_ReadTensorboardBlobDataClient interface {
	Recv() (*ReadTensorboardBlobDataResponse, error)
	grpc.ClientStream
}

type TensorboardService_ReadTensorboardBlobDataServer

type TensorboardService_ReadTensorboardBlobDataServer interface {
	Send(*ReadTensorboardBlobDataResponse) error
	grpc.ServerStream
}

type TensorboardTensor

type TensorboardTensor struct {

	// Required. Serialized form of
	// https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto
	Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// Optional. Version number of TensorProto used to serialize
	// [value][google.cloud.aiplatform.v1.TensorboardTensor.value].
	VersionNumber int32 `protobuf:"varint,2,opt,name=version_number,json=versionNumber,proto3" json:"version_number,omitempty"`
	// contains filtered or unexported fields
}

One point viewable on a tensor metric plot.

func (*TensorboardTensor) Descriptor deprecated

func (*TensorboardTensor) Descriptor() ([]byte, []int)

Deprecated: Use TensorboardTensor.ProtoReflect.Descriptor instead.

func (*TensorboardTensor) GetValue

func (x *TensorboardTensor) GetValue() []byte

func (*TensorboardTensor) GetVersionNumber

func (x *TensorboardTensor) GetVersionNumber() int32

func (*TensorboardTensor) ProtoMessage

func (*TensorboardTensor) ProtoMessage()

func (*TensorboardTensor) ProtoReflect

func (x *TensorboardTensor) ProtoReflect() protoreflect.Message

func (*TensorboardTensor) Reset

func (x *TensorboardTensor) Reset()

func (*TensorboardTensor) String

func (x *TensorboardTensor) String() string

type TensorboardTimeSeries

type TensorboardTimeSeries struct {

	// Output only. Name of the TensorboardTimeSeries.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. User provided name of this TensorboardTimeSeries.
	// This value should be unique among all TensorboardTimeSeries resources
	// belonging to the same TensorboardRun resource (parent resource).
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Description of this TensorboardTimeSeries.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Required. Immutable. Type of TensorboardTimeSeries value.
	ValueType TensorboardTimeSeries_ValueType `` /* 153-byte string literal not displayed */
	// Output only. Timestamp when this TensorboardTimeSeries was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this TensorboardTimeSeries was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Used to perform a consistent read-modify-write updates. If not set, a blind
	// "overwrite" update happens.
	Etag string `protobuf:"bytes,7,opt,name=etag,proto3" json:"etag,omitempty"`
	// Immutable. Name of the plugin this time series pertain to. Such as Scalar,
	// Tensor, Blob
	PluginName string `protobuf:"bytes,8,opt,name=plugin_name,json=pluginName,proto3" json:"plugin_name,omitempty"`
	// Data of the current plugin, with the size limited to 65KB.
	PluginData []byte `protobuf:"bytes,9,opt,name=plugin_data,json=pluginData,proto3" json:"plugin_data,omitempty"`
	// Output only. Scalar, Tensor, or Blob metadata for this
	// TensorboardTimeSeries.
	Metadata *TensorboardTimeSeries_Metadata `protobuf:"bytes,10,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

TensorboardTimeSeries maps to times series produced in training runs

func (*TensorboardTimeSeries) Descriptor deprecated

func (*TensorboardTimeSeries) Descriptor() ([]byte, []int)

Deprecated: Use TensorboardTimeSeries.ProtoReflect.Descriptor instead.

func (*TensorboardTimeSeries) GetCreateTime

func (x *TensorboardTimeSeries) GetCreateTime() *timestamppb.Timestamp

func (*TensorboardTimeSeries) GetDescription

func (x *TensorboardTimeSeries) GetDescription() string

func (*TensorboardTimeSeries) GetDisplayName

func (x *TensorboardTimeSeries) GetDisplayName() string

func (*TensorboardTimeSeries) GetEtag

func (x *TensorboardTimeSeries) GetEtag() string

func (*TensorboardTimeSeries) GetMetadata

func (*TensorboardTimeSeries) GetName

func (x *TensorboardTimeSeries) GetName() string

func (*TensorboardTimeSeries) GetPluginData

func (x *TensorboardTimeSeries) GetPluginData() []byte

func (*TensorboardTimeSeries) GetPluginName

func (x *TensorboardTimeSeries) GetPluginName() string

func (*TensorboardTimeSeries) GetUpdateTime

func (x *TensorboardTimeSeries) GetUpdateTime() *timestamppb.Timestamp

func (*TensorboardTimeSeries) GetValueType

func (*TensorboardTimeSeries) ProtoMessage

func (*TensorboardTimeSeries) ProtoMessage()

func (*TensorboardTimeSeries) ProtoReflect

func (x *TensorboardTimeSeries) ProtoReflect() protoreflect.Message

func (*TensorboardTimeSeries) Reset

func (x *TensorboardTimeSeries) Reset()

func (*TensorboardTimeSeries) String

func (x *TensorboardTimeSeries) String() string

type TensorboardTimeSeries_Metadata

type TensorboardTimeSeries_Metadata struct {

	// Output only. Max step index of all data points within a
	// TensorboardTimeSeries.
	MaxStep int64 `protobuf:"varint,1,opt,name=max_step,json=maxStep,proto3" json:"max_step,omitempty"`
	// Output only. Max wall clock timestamp of all data points within a
	// TensorboardTimeSeries.
	MaxWallTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=max_wall_time,json=maxWallTime,proto3" json:"max_wall_time,omitempty"`
	// Output only. The largest blob sequence length (number of blobs) of all
	// data points in this time series, if its ValueType is BLOB_SEQUENCE.
	MaxBlobSequenceLength int64 `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes metadata for a TensorboardTimeSeries.

func (*TensorboardTimeSeries_Metadata) Descriptor deprecated

func (*TensorboardTimeSeries_Metadata) Descriptor() ([]byte, []int)

Deprecated: Use TensorboardTimeSeries_Metadata.ProtoReflect.Descriptor instead.

func (*TensorboardTimeSeries_Metadata) GetMaxBlobSequenceLength

func (x *TensorboardTimeSeries_Metadata) GetMaxBlobSequenceLength() int64

func (*TensorboardTimeSeries_Metadata) GetMaxStep

func (x *TensorboardTimeSeries_Metadata) GetMaxStep() int64

func (*TensorboardTimeSeries_Metadata) GetMaxWallTime

func (*TensorboardTimeSeries_Metadata) ProtoMessage

func (*TensorboardTimeSeries_Metadata) ProtoMessage()

func (*TensorboardTimeSeries_Metadata) ProtoReflect

func (*TensorboardTimeSeries_Metadata) Reset

func (x *TensorboardTimeSeries_Metadata) Reset()

func (*TensorboardTimeSeries_Metadata) String

type TensorboardTimeSeries_ValueType

type TensorboardTimeSeries_ValueType int32

An enum representing the value type of a TensorboardTimeSeries.

const (
	// The value type is unspecified.
	TensorboardTimeSeries_VALUE_TYPE_UNSPECIFIED TensorboardTimeSeries_ValueType = 0
	// Used for TensorboardTimeSeries that is a list of scalars.
	// E.g. accuracy of a model over epochs/time.
	TensorboardTimeSeries_SCALAR TensorboardTimeSeries_ValueType = 1
	// Used for TensorboardTimeSeries that is a list of tensors.
	// E.g. histograms of weights of layer in a model over epoch/time.
	TensorboardTimeSeries_TENSOR TensorboardTimeSeries_ValueType = 2
	// Used for TensorboardTimeSeries that is a list of blob sequences.
	// E.g. set of sample images with labels over epochs/time.
	TensorboardTimeSeries_BLOB_SEQUENCE TensorboardTimeSeries_ValueType = 3
)

func (TensorboardTimeSeries_ValueType) Descriptor

func (TensorboardTimeSeries_ValueType) Enum

func (TensorboardTimeSeries_ValueType) EnumDescriptor deprecated

func (TensorboardTimeSeries_ValueType) EnumDescriptor() ([]byte, []int)

Deprecated: Use TensorboardTimeSeries_ValueType.Descriptor instead.

func (TensorboardTimeSeries_ValueType) Number

func (TensorboardTimeSeries_ValueType) String

func (TensorboardTimeSeries_ValueType) Type

type ThresholdConfig

type ThresholdConfig struct {

	// Types that are assignable to Threshold:
	//
	//	*ThresholdConfig_Value
	Threshold isThresholdConfig_Threshold `protobuf_oneof:"threshold"`
	// contains filtered or unexported fields
}

The config for feature monitoring threshold.

func (*ThresholdConfig) Descriptor deprecated

func (*ThresholdConfig) Descriptor() ([]byte, []int)

Deprecated: Use ThresholdConfig.ProtoReflect.Descriptor instead.

func (*ThresholdConfig) GetThreshold

func (m *ThresholdConfig) GetThreshold() isThresholdConfig_Threshold

func (*ThresholdConfig) GetValue

func (x *ThresholdConfig) GetValue() float64

func (*ThresholdConfig) ProtoMessage

func (*ThresholdConfig) ProtoMessage()

func (*ThresholdConfig) ProtoReflect

func (x *ThresholdConfig) ProtoReflect() protoreflect.Message

func (*ThresholdConfig) Reset

func (x *ThresholdConfig) Reset()

func (*ThresholdConfig) String

func (x *ThresholdConfig) String() string

type ThresholdConfig_Value

type ThresholdConfig_Value struct {
	// Specify a threshold value that can trigger the alert.
	// If this threshold config is for feature distribution distance:
	//  1. For categorical feature, the distribution distance is calculated by
	//     L-inifinity norm.
	//  2. For numerical feature, the distribution distance is calculated by
	//     Jensen–Shannon divergence.
	//
	// Each feature must have a non-zero threshold if they need to be monitored.
	// Otherwise no alert will be triggered for that feature.
	Value float64 `protobuf:"fixed64,1,opt,name=value,proto3,oneof"`
}

type TimeSeriesData

type TimeSeriesData struct {

	// Required. The ID of the TensorboardTimeSeries, which will become the final
	// component of the TensorboardTimeSeries' resource name
	TensorboardTimeSeriesId string `` /* 134-byte string literal not displayed */
	// Required. Immutable. The value type of this time series. All the values in
	// this time series data must match this value type.
	ValueType TensorboardTimeSeries_ValueType `` /* 153-byte string literal not displayed */
	// Required. Data points in this time series.
	Values []*TimeSeriesDataPoint `protobuf:"bytes,3,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

All the data stored in a TensorboardTimeSeries.

func (*TimeSeriesData) Descriptor deprecated

func (*TimeSeriesData) Descriptor() ([]byte, []int)

Deprecated: Use TimeSeriesData.ProtoReflect.Descriptor instead.

func (*TimeSeriesData) GetTensorboardTimeSeriesId

func (x *TimeSeriesData) GetTensorboardTimeSeriesId() string

func (*TimeSeriesData) GetValueType

func (*TimeSeriesData) GetValues

func (x *TimeSeriesData) GetValues() []*TimeSeriesDataPoint

func (*TimeSeriesData) ProtoMessage

func (*TimeSeriesData) ProtoMessage()

func (*TimeSeriesData) ProtoReflect

func (x *TimeSeriesData) ProtoReflect() protoreflect.Message

func (*TimeSeriesData) Reset

func (x *TimeSeriesData) Reset()

func (*TimeSeriesData) String

func (x *TimeSeriesData) String() string

type TimeSeriesDataPoint

type TimeSeriesDataPoint struct {

	// Value of this time series data point.
	//
	// Types that are assignable to Value:
	//
	//	*TimeSeriesDataPoint_Scalar
	//	*TimeSeriesDataPoint_Tensor
	//	*TimeSeriesDataPoint_Blobs
	Value isTimeSeriesDataPoint_Value `protobuf_oneof:"value"`
	// Wall clock timestamp when this data point is generated by the end user.
	WallTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=wall_time,json=wallTime,proto3" json:"wall_time,omitempty"`
	// Step index of this data point within the run.
	Step int64 `protobuf:"varint,2,opt,name=step,proto3" json:"step,omitempty"`
	// contains filtered or unexported fields
}

A TensorboardTimeSeries data point.

func (*TimeSeriesDataPoint) Descriptor deprecated

func (*TimeSeriesDataPoint) Descriptor() ([]byte, []int)

Deprecated: Use TimeSeriesDataPoint.ProtoReflect.Descriptor instead.

func (*TimeSeriesDataPoint) GetBlobs

func (*TimeSeriesDataPoint) GetScalar

func (x *TimeSeriesDataPoint) GetScalar() *Scalar

func (*TimeSeriesDataPoint) GetStep

func (x *TimeSeriesDataPoint) GetStep() int64

func (*TimeSeriesDataPoint) GetTensor

func (x *TimeSeriesDataPoint) GetTensor() *TensorboardTensor

func (*TimeSeriesDataPoint) GetValue

func (m *TimeSeriesDataPoint) GetValue() isTimeSeriesDataPoint_Value

func (*TimeSeriesDataPoint) GetWallTime

func (x *TimeSeriesDataPoint) GetWallTime() *timestamppb.Timestamp

func (*TimeSeriesDataPoint) ProtoMessage

func (*TimeSeriesDataPoint) ProtoMessage()

func (*TimeSeriesDataPoint) ProtoReflect

func (x *TimeSeriesDataPoint) ProtoReflect() protoreflect.Message

func (*TimeSeriesDataPoint) Reset

func (x *TimeSeriesDataPoint) Reset()

func (*TimeSeriesDataPoint) String

func (x *TimeSeriesDataPoint) String() string

type TimeSeriesDataPoint_Blobs

type TimeSeriesDataPoint_Blobs struct {
	// A blob sequence value.
	Blobs *TensorboardBlobSequence `protobuf:"bytes,5,opt,name=blobs,proto3,oneof"`
}

type TimeSeriesDataPoint_Scalar

type TimeSeriesDataPoint_Scalar struct {
	// A scalar value.
	Scalar *Scalar `protobuf:"bytes,3,opt,name=scalar,proto3,oneof"`
}

type TimeSeriesDataPoint_Tensor

type TimeSeriesDataPoint_Tensor struct {
	// A tensor value.
	Tensor *TensorboardTensor `protobuf:"bytes,4,opt,name=tensor,proto3,oneof"`
}

type TimestampSplit

type TimestampSplit struct {

	// The fraction of the input data that is to be used to train the Model.
	TrainingFraction float64 `protobuf:"fixed64,1,opt,name=training_fraction,json=trainingFraction,proto3" json:"training_fraction,omitempty"`
	// The fraction of the input data that is to be used to validate the Model.
	ValidationFraction float64 `protobuf:"fixed64,2,opt,name=validation_fraction,json=validationFraction,proto3" json:"validation_fraction,omitempty"`
	// The fraction of the input data that is to be used to evaluate the Model.
	TestFraction float64 `protobuf:"fixed64,3,opt,name=test_fraction,json=testFraction,proto3" json:"test_fraction,omitempty"`
	// Required. The key is a name of one of the Dataset's data columns.
	// The values of the key (the values in the column) must be in RFC 3339
	// `date-time` format, where `time-offset` = `"Z"`
	// (e.g. 1985-04-12T23:20:50.52Z). If for a piece of data the key is not
	// present or has an invalid value, that piece is ignored by the pipeline.
	Key string `protobuf:"bytes,4,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

Assigns input data to training, validation, and test sets based on a provided timestamps. The youngest data pieces are assigned to training set, next to validation set, and the oldest to the test set.

Supported only for tabular Datasets.

func (*TimestampSplit) Descriptor deprecated

func (*TimestampSplit) Descriptor() ([]byte, []int)

Deprecated: Use TimestampSplit.ProtoReflect.Descriptor instead.

func (*TimestampSplit) GetKey

func (x *TimestampSplit) GetKey() string

func (*TimestampSplit) GetTestFraction

func (x *TimestampSplit) GetTestFraction() float64

func (*TimestampSplit) GetTrainingFraction

func (x *TimestampSplit) GetTrainingFraction() float64

func (*TimestampSplit) GetValidationFraction

func (x *TimestampSplit) GetValidationFraction() float64

func (*TimestampSplit) ProtoMessage

func (*TimestampSplit) ProtoMessage()

func (*TimestampSplit) ProtoReflect

func (x *TimestampSplit) ProtoReflect() protoreflect.Message

func (*TimestampSplit) Reset

func (x *TimestampSplit) Reset()

func (*TimestampSplit) String

func (x *TimestampSplit) String() string

type TokensInfo added in v1.54.0

type TokensInfo struct {

	// A list of tokens from the input.
	Tokens [][]byte `protobuf:"bytes,1,rep,name=tokens,proto3" json:"tokens,omitempty"`
	// A list of token ids from the input.
	TokenIds []int64 `protobuf:"varint,2,rep,packed,name=token_ids,json=tokenIds,proto3" json:"token_ids,omitempty"`
	// contains filtered or unexported fields
}

Tokens info with a list of tokens and the corresponding list of token ids.

func (*TokensInfo) Descriptor deprecated added in v1.54.0

func (*TokensInfo) Descriptor() ([]byte, []int)

Deprecated: Use TokensInfo.ProtoReflect.Descriptor instead.

func (*TokensInfo) GetTokenIds added in v1.54.0

func (x *TokensInfo) GetTokenIds() []int64

func (*TokensInfo) GetTokens added in v1.54.0

func (x *TokensInfo) GetTokens() [][]byte

func (*TokensInfo) ProtoMessage added in v1.54.0

func (*TokensInfo) ProtoMessage()

func (*TokensInfo) ProtoReflect added in v1.54.0

func (x *TokensInfo) ProtoReflect() protoreflect.Message

func (*TokensInfo) Reset added in v1.54.0

func (x *TokensInfo) Reset()

func (*TokensInfo) String added in v1.54.0

func (x *TokensInfo) String() string

type Tool added in v1.57.0

type Tool struct {

	// Optional. Function tool type.
	// One or more function declarations to be passed to the model along with the
	// current user query. Model may decide to call a subset of these functions
	// by populating [FunctionCall][content.part.function_call] in the response.
	// User should provide a [FunctionResponse][content.part.function_response]
	// for each function call in the next turn. Based on the function responses,
	// Model will generate the final response back to the user.
	// Maximum 64 function declarations can be provided.
	FunctionDeclarations []*FunctionDeclaration `protobuf:"bytes,1,rep,name=function_declarations,json=functionDeclarations,proto3" json:"function_declarations,omitempty"`
	// Optional. Retrieval tool type.
	// System will always execute the provided retrieval tool(s) to get external
	// knowledge to answer the prompt. Retrieval results are presented to the
	// model for generation.
	Retrieval *Retrieval `protobuf:"bytes,2,opt,name=retrieval,proto3" json:"retrieval,omitempty"`
	// Optional. GoogleSearchRetrieval tool type.
	// Specialized retrieval tool that is powered by Google search.
	GoogleSearchRetrieval *GoogleSearchRetrieval `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Tool details that the model may use to generate response.

A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).

func (*Tool) Descriptor deprecated added in v1.57.0

func (*Tool) Descriptor() ([]byte, []int)

Deprecated: Use Tool.ProtoReflect.Descriptor instead.

func (*Tool) GetFunctionDeclarations added in v1.57.0

func (x *Tool) GetFunctionDeclarations() []*FunctionDeclaration

func (*Tool) GetGoogleSearchRetrieval added in v1.63.0

func (x *Tool) GetGoogleSearchRetrieval() *GoogleSearchRetrieval

func (*Tool) GetRetrieval added in v1.63.0

func (x *Tool) GetRetrieval() *Retrieval

func (*Tool) ProtoMessage added in v1.57.0

func (*Tool) ProtoMessage()

func (*Tool) ProtoReflect added in v1.57.0

func (x *Tool) ProtoReflect() protoreflect.Message

func (*Tool) Reset added in v1.57.0

func (x *Tool) Reset()

func (*Tool) String added in v1.57.0

func (x *Tool) String() string

type TrainingConfig

type TrainingConfig struct {

	// The timeout hours for the CMLE training job, expressed in milli hours
	// i.e. 1,000 value in this field means 1 hour.
	TimeoutTrainingMilliHours int64 `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

CMLE training config. For every active learning labeling iteration, system will train a machine learning model on CMLE. The trained model will be used by data sampling algorithm to select DataItems.

func (*TrainingConfig) Descriptor deprecated

func (*TrainingConfig) Descriptor() ([]byte, []int)

Deprecated: Use TrainingConfig.ProtoReflect.Descriptor instead.

func (*TrainingConfig) GetTimeoutTrainingMilliHours

func (x *TrainingConfig) GetTimeoutTrainingMilliHours() int64

func (*TrainingConfig) ProtoMessage

func (*TrainingConfig) ProtoMessage()

func (*TrainingConfig) ProtoReflect

func (x *TrainingConfig) ProtoReflect() protoreflect.Message

func (*TrainingConfig) Reset

func (x *TrainingConfig) Reset()

func (*TrainingConfig) String

func (x *TrainingConfig) String() string

type TrainingPipeline

type TrainingPipeline struct {

	// Output only. Resource name of the TrainingPipeline.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The user-defined name of this TrainingPipeline.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Specifies Vertex AI owned input data that may be used for training the
	// Model. The TrainingPipeline's
	// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]
	// should make clear whether this config is used and if there are any special
	// requirements on how it should be filled. If nothing about this config is
	// mentioned in the
	// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition],
	// then it should be assumed that the TrainingPipeline does not depend on this
	// configuration.
	InputDataConfig *InputDataConfig `protobuf:"bytes,3,opt,name=input_data_config,json=inputDataConfig,proto3" json:"input_data_config,omitempty"`
	// Required. A Google Cloud Storage path to the YAML file that defines the
	// training task which is responsible for producing the model artifact, and
	// may also include additional auxiliary work. The definition files that can
	// be used here are found in
	// gs://google-cloud-aiplatform/schema/trainingjob/definition/.
	// Note: The URI given on output will be immutable and probably different,
	// including the URI scheme, than the one given on input. The output URI will
	// point to a location where the user only has a read access.
	TrainingTaskDefinition string `` /* 129-byte string literal not displayed */
	// Required. The training task's parameter(s), as specified in the
	// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s
	// `inputs`.
	TrainingTaskInputs *structpb.Value `protobuf:"bytes,5,opt,name=training_task_inputs,json=trainingTaskInputs,proto3" json:"training_task_inputs,omitempty"`
	// Output only. The metadata information as specified in the
	// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s
	// `metadata`. This metadata is an auxiliary runtime and final information
	// about the training task. While the pipeline is running this information is
	// populated only at a best effort basis. Only present if the
	// pipeline's
	// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]
	// contains `metadata` object.
	TrainingTaskMetadata *structpb.Value `protobuf:"bytes,6,opt,name=training_task_metadata,json=trainingTaskMetadata,proto3" json:"training_task_metadata,omitempty"`
	// Describes the Model that may be uploaded (via
	// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel])
	// by this TrainingPipeline. The TrainingPipeline's
	// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]
	// should make clear whether this Model description should be populated, and
	// if there are any special requirements regarding how it should be filled. If
	// nothing is mentioned in the
	// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition],
	// then it should be assumed that this field should not be filled and the
	// training task either uploads the Model without a need of this information,
	// or that training task does not support uploading a Model as part of the
	// pipeline. When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and
	// the trained Model had been uploaded into Vertex AI, then the
	// model_to_upload's resource [name][google.cloud.aiplatform.v1.Model.name] is
	// populated. The Model is always uploaded into the Project and Location in
	// which this pipeline is.
	ModelToUpload *Model `protobuf:"bytes,7,opt,name=model_to_upload,json=modelToUpload,proto3" json:"model_to_upload,omitempty"`
	// Optional. The ID to use for the uploaded Model, which will become the final
	// component of the model resource name.
	//
	// This value may be up to 63 characters, and valid characters are
	// `[a-z0-9_-]`. The first character cannot be a number or hyphen.
	ModelId string `protobuf:"bytes,22,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
	// Optional. When specify this field, the `model_to_upload` will not be
	// uploaded as a new model, instead, it will become a new version of this
	// `parent_model`.
	ParentModel string `protobuf:"bytes,21,opt,name=parent_model,json=parentModel,proto3" json:"parent_model,omitempty"`
	// Output only. The detailed state of the pipeline.
	State PipelineState `protobuf:"varint,9,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.PipelineState" json:"state,omitempty"`
	// Output only. Only populated when the pipeline's state is
	// `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.
	Error *status.Status `protobuf:"bytes,10,opt,name=error,proto3" json:"error,omitempty"`
	// Output only. Time when the TrainingPipeline was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Time when the TrainingPipeline for the first time entered the
	// `PIPELINE_STATE_RUNNING` state.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. Time when the TrainingPipeline entered any of the following
	// states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`,
	// `PIPELINE_STATE_CANCELLED`.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Time when the TrainingPipeline was most recently updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The labels with user-defined metadata to organize TrainingPipelines.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Customer-managed encryption key spec for a TrainingPipeline. If set, this
	// TrainingPipeline will be secured by this key.
	//
	// Note: Model trained by this TrainingPipeline is also secured by this key if
	// [model_to_upload][google.cloud.aiplatform.v1.TrainingPipeline.encryption_spec]
	// is not set separately.
	EncryptionSpec *EncryptionSpec `protobuf:"bytes,18,opt,name=encryption_spec,json=encryptionSpec,proto3" json:"encryption_spec,omitempty"`
	// contains filtered or unexported fields
}

The TrainingPipeline orchestrates tasks associated with training a Model. It always executes the training task, and optionally may also export data from Vertex AI's Dataset which becomes the training input, [upload][google.cloud.aiplatform.v1.ModelService.UploadModel] the Model to Vertex AI, and evaluate the Model.

func (*TrainingPipeline) Descriptor deprecated

func (*TrainingPipeline) Descriptor() ([]byte, []int)

Deprecated: Use TrainingPipeline.ProtoReflect.Descriptor instead.

func (*TrainingPipeline) GetCreateTime

func (x *TrainingPipeline) GetCreateTime() *timestamppb.Timestamp

func (*TrainingPipeline) GetDisplayName

func (x *TrainingPipeline) GetDisplayName() string

func (*TrainingPipeline) GetEncryptionSpec

func (x *TrainingPipeline) GetEncryptionSpec() *EncryptionSpec

func (*TrainingPipeline) GetEndTime

func (x *TrainingPipeline) GetEndTime() *timestamppb.Timestamp

func (*TrainingPipeline) GetError

func (x *TrainingPipeline) GetError() *status.Status

func (*TrainingPipeline) GetInputDataConfig

func (x *TrainingPipeline) GetInputDataConfig() *InputDataConfig

func (*TrainingPipeline) GetLabels

func (x *TrainingPipeline) GetLabels() map[string]string

func (*TrainingPipeline) GetModelId

func (x *TrainingPipeline) GetModelId() string

func (*TrainingPipeline) GetModelToUpload

func (x *TrainingPipeline) GetModelToUpload() *Model

func (*TrainingPipeline) GetName

func (x *TrainingPipeline) GetName() string

func (*TrainingPipeline) GetParentModel

func (x *TrainingPipeline) GetParentModel() string

func (*TrainingPipeline) GetStartTime

func (x *TrainingPipeline) GetStartTime() *timestamppb.Timestamp

func (*TrainingPipeline) GetState

func (x *TrainingPipeline) GetState() PipelineState

func (*TrainingPipeline) GetTrainingTaskDefinition

func (x *TrainingPipeline) GetTrainingTaskDefinition() string

func (*TrainingPipeline) GetTrainingTaskInputs

func (x *TrainingPipeline) GetTrainingTaskInputs() *structpb.Value

func (*TrainingPipeline) GetTrainingTaskMetadata

func (x *TrainingPipeline) GetTrainingTaskMetadata() *structpb.Value

func (*TrainingPipeline) GetUpdateTime

func (x *TrainingPipeline) GetUpdateTime() *timestamppb.Timestamp

func (*TrainingPipeline) ProtoMessage

func (*TrainingPipeline) ProtoMessage()

func (*TrainingPipeline) ProtoReflect

func (x *TrainingPipeline) ProtoReflect() protoreflect.Message

func (*TrainingPipeline) Reset

func (x *TrainingPipeline) Reset()

func (*TrainingPipeline) String

func (x *TrainingPipeline) String() string

type Trial

type Trial struct {

	// Output only. Resource name of the Trial assigned by the service.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The identifier of the Trial assigned by the service.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// Output only. The detailed state of the Trial.
	State Trial_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.Trial_State" json:"state,omitempty"`
	// Output only. The parameters of the Trial.
	Parameters []*Trial_Parameter `protobuf:"bytes,4,rep,name=parameters,proto3" json:"parameters,omitempty"`
	// Output only. The final measurement containing the objective value.
	FinalMeasurement *Measurement `protobuf:"bytes,5,opt,name=final_measurement,json=finalMeasurement,proto3" json:"final_measurement,omitempty"`
	// Output only. A list of measurements that are strictly lexicographically
	// ordered by their induced tuples (steps, elapsed_duration).
	// These are used for early stopping computations.
	Measurements []*Measurement `protobuf:"bytes,6,rep,name=measurements,proto3" json:"measurements,omitempty"`
	// Output only. Time when the Trial was started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. Time when the Trial's status changed to `SUCCEEDED` or
	// `INFEASIBLE`.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. The identifier of the client that originally requested this
	// Trial. Each client is identified by a unique client_id. When a client asks
	// for a suggestion, Vertex AI Vizier will assign it a Trial. The client
	// should evaluate the Trial, complete it, and report back to Vertex AI
	// Vizier. If suggestion is asked again by same client_id before the Trial is
	// completed, the same Trial will be returned. Multiple clients with
	// different client_ids can ask for suggestions simultaneously, each of them
	// will get their own Trial.
	ClientId string `protobuf:"bytes,9,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
	// Output only. A human readable string describing why the Trial is
	// infeasible. This is set only if Trial state is `INFEASIBLE`.
	InfeasibleReason string `protobuf:"bytes,10,opt,name=infeasible_reason,json=infeasibleReason,proto3" json:"infeasible_reason,omitempty"`
	// Output only. The CustomJob name linked to the Trial.
	// It's set for a HyperparameterTuningJob's Trial.
	CustomJob string `protobuf:"bytes,11,opt,name=custom_job,json=customJob,proto3" json:"custom_job,omitempty"`
	// Output only. URIs for accessing [interactive
	// shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
	// (one URI for each training node). Only available if this trial is part of
	// a
	// [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob]
	// and the job's
	// [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
	// field is `true`.
	//
	// The keys are names of each node used for the trial; for example,
	// `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
	// the second worker pool, and `workerpool1-1` for the second node in the
	// second worker pool.
	//
	// The values are the URIs for each node's interactive shell.
	WebAccessUris map[string]string `` /* 191-byte string literal not displayed */
	// contains filtered or unexported fields
}

A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.

func (*Trial) Descriptor deprecated

func (*Trial) Descriptor() ([]byte, []int)

Deprecated: Use Trial.ProtoReflect.Descriptor instead.

func (*Trial) GetClientId

func (x *Trial) GetClientId() string

func (*Trial) GetCustomJob

func (x *Trial) GetCustomJob() string

func (*Trial) GetEndTime

func (x *Trial) GetEndTime() *timestamppb.Timestamp

func (*Trial) GetFinalMeasurement

func (x *Trial) GetFinalMeasurement() *Measurement

func (*Trial) GetId

func (x *Trial) GetId() string

func (*Trial) GetInfeasibleReason

func (x *Trial) GetInfeasibleReason() string

func (*Trial) GetMeasurements

func (x *Trial) GetMeasurements() []*Measurement

func (*Trial) GetName

func (x *Trial) GetName() string

func (*Trial) GetParameters

func (x *Trial) GetParameters() []*Trial_Parameter

func (*Trial) GetStartTime

func (x *Trial) GetStartTime() *timestamppb.Timestamp

func (*Trial) GetState

func (x *Trial) GetState() Trial_State

func (*Trial) GetWebAccessUris

func (x *Trial) GetWebAccessUris() map[string]string

func (*Trial) ProtoMessage

func (*Trial) ProtoMessage()

func (*Trial) ProtoReflect

func (x *Trial) ProtoReflect() protoreflect.Message

func (*Trial) Reset

func (x *Trial) Reset()

func (*Trial) String

func (x *Trial) String() string

type TrialContext added in v1.50.0

type TrialContext struct {

	// A human-readable field which can store a description of this context.
	// This will become part of the resulting Trial's description field.
	Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	// If/when a Trial is generated or selected from this Context,
	// its Parameters will match any parameters specified here.
	// (I.e. if this context specifies parameter name:'a' int_value:3,
	// then a resulting Trial will have int_value:3 for its parameter named
	// 'a'.) Note that we first attempt to match existing REQUESTED Trials with
	// contexts, and if there are no matches, we generate suggestions in the
	// subspace defined by the parameters specified here.
	// NOTE: a Context without any Parameters matches the entire feasible search
	//
	//	space.
	Parameters []*Trial_Parameter `protobuf:"bytes,2,rep,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Next ID: 3

func (*TrialContext) Descriptor deprecated added in v1.50.0

func (*TrialContext) Descriptor() ([]byte, []int)

Deprecated: Use TrialContext.ProtoReflect.Descriptor instead.

func (*TrialContext) GetDescription added in v1.50.0

func (x *TrialContext) GetDescription() string

func (*TrialContext) GetParameters added in v1.50.0

func (x *TrialContext) GetParameters() []*Trial_Parameter

func (*TrialContext) ProtoMessage added in v1.50.0

func (*TrialContext) ProtoMessage()

func (*TrialContext) ProtoReflect added in v1.50.0

func (x *TrialContext) ProtoReflect() protoreflect.Message

func (*TrialContext) Reset added in v1.50.0

func (x *TrialContext) Reset()

func (*TrialContext) String added in v1.50.0

func (x *TrialContext) String() string

type Trial_Parameter

type Trial_Parameter struct {

	// Output only. The ID of the parameter. The parameter should be defined in
	// [StudySpec's
	// Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
	ParameterId string `protobuf:"bytes,1,opt,name=parameter_id,json=parameterId,proto3" json:"parameter_id,omitempty"`
	// Output only. The value of the parameter.
	// `number_value` will be set if a parameter defined in StudySpec is
	// in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
	// `string_value` will be set if a parameter defined in StudySpec is
	// in type 'CATEGORICAL'.
	Value *structpb.Value `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

A message representing a parameter to be tuned.

func (*Trial_Parameter) Descriptor deprecated

func (*Trial_Parameter) Descriptor() ([]byte, []int)

Deprecated: Use Trial_Parameter.ProtoReflect.Descriptor instead.

func (*Trial_Parameter) GetParameterId

func (x *Trial_Parameter) GetParameterId() string

func (*Trial_Parameter) GetValue

func (x *Trial_Parameter) GetValue() *structpb.Value

func (*Trial_Parameter) ProtoMessage

func (*Trial_Parameter) ProtoMessage()

func (*Trial_Parameter) ProtoReflect

func (x *Trial_Parameter) ProtoReflect() protoreflect.Message

func (*Trial_Parameter) Reset

func (x *Trial_Parameter) Reset()

func (*Trial_Parameter) String

func (x *Trial_Parameter) String() string

type Trial_State

type Trial_State int32

Describes a Trial state.

const (
	// The Trial state is unspecified.
	Trial_STATE_UNSPECIFIED Trial_State = 0
	// Indicates that a specific Trial has been requested, but it has not yet
	// been suggested by the service.
	Trial_REQUESTED Trial_State = 1
	// Indicates that the Trial has been suggested.
	Trial_ACTIVE Trial_State = 2
	// Indicates that the Trial should stop according to the service.
	Trial_STOPPING Trial_State = 3
	// Indicates that the Trial is completed successfully.
	Trial_SUCCEEDED Trial_State = 4
	// Indicates that the Trial should not be attempted again.
	// The service will set a Trial to INFEASIBLE when it's done but missing
	// the final_measurement.
	Trial_INFEASIBLE Trial_State = 5
)

func (Trial_State) Descriptor

func (Trial_State) Enum

func (x Trial_State) Enum() *Trial_State

func (Trial_State) EnumDescriptor deprecated

func (Trial_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Trial_State.Descriptor instead.

func (Trial_State) Number

func (x Trial_State) Number() protoreflect.EnumNumber

func (Trial_State) String

func (x Trial_State) String() string

func (Trial_State) Type

type TunedModel added in v1.67.0

type TunedModel struct {

	// Output only. The resource name of the TunedModel. Format:
	// `projects/{project}/locations/{location}/models/{model}`.
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Output only. A resource name of an Endpoint. Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`.
	Endpoint string `protobuf:"bytes,2,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// contains filtered or unexported fields
}

The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob[google.cloud.aiplatform.v1.TuningJob].

func (*TunedModel) Descriptor deprecated added in v1.67.0

func (*TunedModel) Descriptor() ([]byte, []int)

Deprecated: Use TunedModel.ProtoReflect.Descriptor instead.

func (*TunedModel) GetEndpoint added in v1.67.0

func (x *TunedModel) GetEndpoint() string

func (*TunedModel) GetModel added in v1.67.0

func (x *TunedModel) GetModel() string

func (*TunedModel) ProtoMessage added in v1.67.0

func (*TunedModel) ProtoMessage()

func (*TunedModel) ProtoReflect added in v1.67.0

func (x *TunedModel) ProtoReflect() protoreflect.Message

func (*TunedModel) Reset added in v1.67.0

func (x *TunedModel) Reset()

func (*TunedModel) String added in v1.67.0

func (x *TunedModel) String() string

type TuningDataStats added in v1.67.0

type TuningDataStats struct {

	// Types that are assignable to TuningDataStats:
	//
	//	*TuningDataStats_SupervisedTuningDataStats
	TuningDataStats isTuningDataStats_TuningDataStats `protobuf_oneof:"tuning_data_stats"`
	// contains filtered or unexported fields
}

The tuning data statistic values for TuningJob[google.cloud.aiplatform.v1.TuningJob].

func (*TuningDataStats) Descriptor deprecated added in v1.67.0

func (*TuningDataStats) Descriptor() ([]byte, []int)

Deprecated: Use TuningDataStats.ProtoReflect.Descriptor instead.

func (*TuningDataStats) GetSupervisedTuningDataStats added in v1.67.0

func (x *TuningDataStats) GetSupervisedTuningDataStats() *SupervisedTuningDataStats

func (*TuningDataStats) GetTuningDataStats added in v1.67.0

func (m *TuningDataStats) GetTuningDataStats() isTuningDataStats_TuningDataStats

func (*TuningDataStats) ProtoMessage added in v1.67.0

func (*TuningDataStats) ProtoMessage()

func (*TuningDataStats) ProtoReflect added in v1.67.0

func (x *TuningDataStats) ProtoReflect() protoreflect.Message

func (*TuningDataStats) Reset added in v1.67.0

func (x *TuningDataStats) Reset()

func (*TuningDataStats) String added in v1.67.0

func (x *TuningDataStats) String() string

type TuningDataStats_SupervisedTuningDataStats added in v1.67.0

type TuningDataStats_SupervisedTuningDataStats struct {
	// The SFT Tuning data stats.
	SupervisedTuningDataStats *SupervisedTuningDataStats `protobuf:"bytes,1,opt,name=supervised_tuning_data_stats,json=supervisedTuningDataStats,proto3,oneof"`
}

type TuningJob added in v1.67.0

type TuningJob struct {

	// Types that are assignable to SourceModel:
	//
	//	*TuningJob_BaseModel
	SourceModel isTuningJob_SourceModel `protobuf_oneof:"source_model"`
	// Types that are assignable to TuningSpec:
	//
	//	*TuningJob_SupervisedTuningSpec
	TuningSpec isTuningJob_TuningSpec `protobuf_oneof:"tuning_spec"`
	// Output only. Identifier. Resource name of a TuningJob. Format:
	// `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The display name of the
	// [TunedModel][google.cloud.aiplatform.v1.Model]. The name can be up to
	// 128 characters long and can consist of any UTF-8 characters.
	TunedModelDisplayName string `` /* 128-byte string literal not displayed */
	// Optional. The description of the
	// [TuningJob][google.cloud.aiplatform.v1.TuningJob].
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. The detailed state of the job.
	State JobState `protobuf:"varint,6,opt,name=state,proto3,enum=google.cloud.aiplatform.v1.JobState" json:"state,omitempty"`
	// Output only. Time when the
	// [TuningJob][google.cloud.aiplatform.v1.TuningJob] was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Time when the
	// [TuningJob][google.cloud.aiplatform.v1.TuningJob] for the first time
	// entered the `JOB_STATE_RUNNING` state.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. Time when the TuningJob entered any of the following
	// [JobStates][google.cloud.aiplatform.v1.JobState]: `JOB_STATE_SUCCEEDED`,
	// `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Time when the
	// [TuningJob][google.cloud.aiplatform.v1.TuningJob] was most recently
	// updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Only populated when job's state is `JOB_STATE_FAILED` or
	// `JOB_STATE_CANCELLED`.
	Error *status.Status `protobuf:"bytes,11,opt,name=error,proto3" json:"error,omitempty"`
	// Optional. The labels with user-defined metadata to organize
	// [TuningJob][google.cloud.aiplatform.v1.TuningJob] and generated resources
	// such as [Model][google.cloud.aiplatform.v1.Model] and
	// [Endpoint][google.cloud.aiplatform.v1.Endpoint].
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Output only. The Experiment associated with this
	// [TuningJob][google.cloud.aiplatform.v1.TuningJob].
	Experiment string `protobuf:"bytes,13,opt,name=experiment,proto3" json:"experiment,omitempty"`
	// Output only. The tuned model resources assiociated with this
	// [TuningJob][google.cloud.aiplatform.v1.TuningJob].
	TunedModel *TunedModel `protobuf:"bytes,14,opt,name=tuned_model,json=tunedModel,proto3" json:"tuned_model,omitempty"`
	// Output only. The tuning data statistics associated with this
	// [TuningJob][google.cloud.aiplatform.v1.TuningJob].
	TuningDataStats *TuningDataStats `protobuf:"bytes,15,opt,name=tuning_data_stats,json=tuningDataStats,proto3" json:"tuning_data_stats,omitempty"`
	// contains filtered or unexported fields
}

Represents a TuningJob that runs with Google owned models.

func (*TuningJob) Descriptor deprecated added in v1.67.0

func (*TuningJob) Descriptor() ([]byte, []int)

Deprecated: Use TuningJob.ProtoReflect.Descriptor instead.

func (*TuningJob) GetBaseModel added in v1.67.0

func (x *TuningJob) GetBaseModel() string

func (*TuningJob) GetCreateTime added in v1.67.0

func (x *TuningJob) GetCreateTime() *timestamppb.Timestamp

func (*TuningJob) GetDescription added in v1.67.0

func (x *TuningJob) GetDescription() string

func (*TuningJob) GetEndTime added in v1.67.0

func (x *TuningJob) GetEndTime() *timestamppb.Timestamp

func (*TuningJob) GetError added in v1.67.0

func (x *TuningJob) GetError() *status.Status

func (*TuningJob) GetExperiment added in v1.67.0

func (x *TuningJob) GetExperiment() string

func (*TuningJob) GetLabels added in v1.67.0

func (x *TuningJob) GetLabels() map[string]string

func (*TuningJob) GetName added in v1.67.0

func (x *TuningJob) GetName() string

func (*TuningJob) GetSourceModel added in v1.67.0

func (m *TuningJob) GetSourceModel() isTuningJob_SourceModel

func (*TuningJob) GetStartTime added in v1.67.0

func (x *TuningJob) GetStartTime() *timestamppb.Timestamp

func (*TuningJob) GetState added in v1.67.0

func (x *TuningJob) GetState() JobState

func (*TuningJob) GetSupervisedTuningSpec added in v1.67.0

func (x *TuningJob) GetSupervisedTuningSpec() *SupervisedTuningSpec

func (*TuningJob) GetTunedModel added in v1.67.0

func (x *TuningJob) GetTunedModel() *TunedModel

func (*TuningJob) GetTunedModelDisplayName added in v1.67.0

func (x *TuningJob) GetTunedModelDisplayName() string

func (*TuningJob) GetTuningDataStats added in v1.67.0

func (x *TuningJob) GetTuningDataStats() *TuningDataStats

func (*TuningJob) GetTuningSpec added in v1.67.0

func (m *TuningJob) GetTuningSpec() isTuningJob_TuningSpec

func (*TuningJob) GetUpdateTime added in v1.67.0

func (x *TuningJob) GetUpdateTime() *timestamppb.Timestamp

func (*TuningJob) ProtoMessage added in v1.67.0

func (*TuningJob) ProtoMessage()

func (*TuningJob) ProtoReflect added in v1.67.0

func (x *TuningJob) ProtoReflect() protoreflect.Message

func (*TuningJob) Reset added in v1.67.0

func (x *TuningJob) Reset()

func (*TuningJob) String added in v1.67.0

func (x *TuningJob) String() string

type TuningJob_BaseModel added in v1.67.0

type TuningJob_BaseModel struct {
	// Model name for tuning, e.g., "gemini-1.0-pro-002".
	BaseModel string `protobuf:"bytes,4,opt,name=base_model,json=baseModel,proto3,oneof"`
}

type TuningJob_SupervisedTuningSpec added in v1.67.0

type TuningJob_SupervisedTuningSpec struct {
	// Tuning Spec for Supervised Fine Tuning.
	SupervisedTuningSpec *SupervisedTuningSpec `protobuf:"bytes,5,opt,name=supervised_tuning_spec,json=supervisedTuningSpec,proto3,oneof"`
}

type Type added in v1.57.0

type Type int32

Type contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/

const (
	// Not specified, should not be used.
	Type_TYPE_UNSPECIFIED Type = 0
	// OpenAPI string type
	Type_STRING Type = 1
	// OpenAPI number type
	Type_NUMBER Type = 2
	// OpenAPI integer type
	Type_INTEGER Type = 3
	// OpenAPI boolean type
	Type_BOOLEAN Type = 4
	// OpenAPI array type
	Type_ARRAY Type = 5
	// OpenAPI object type
	Type_OBJECT Type = 6
)

func (Type) Descriptor added in v1.57.0

func (Type) Descriptor() protoreflect.EnumDescriptor

func (Type) Enum added in v1.57.0

func (x Type) Enum() *Type

func (Type) EnumDescriptor deprecated added in v1.57.0

func (Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Type.Descriptor instead.

func (Type) Number added in v1.57.0

func (x Type) Number() protoreflect.EnumNumber

func (Type) String added in v1.57.0

func (x Type) String() string

func (Type) Type added in v1.57.0

func (Type) Type() protoreflect.EnumType

type UndeployIndexOperationMetadata

type UndeployIndexOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].

func (*UndeployIndexOperationMetadata) Descriptor deprecated

func (*UndeployIndexOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UndeployIndexOperationMetadata.ProtoReflect.Descriptor instead.

func (*UndeployIndexOperationMetadata) GetGenericMetadata

func (*UndeployIndexOperationMetadata) ProtoMessage

func (*UndeployIndexOperationMetadata) ProtoMessage()

func (*UndeployIndexOperationMetadata) ProtoReflect

func (*UndeployIndexOperationMetadata) Reset

func (x *UndeployIndexOperationMetadata) Reset()

func (*UndeployIndexOperationMetadata) String

type UndeployIndexRequest

type UndeployIndexRequest struct {

	// Required. The name of the IndexEndpoint resource from which to undeploy an
	// Index. Format:
	// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
	IndexEndpoint string `protobuf:"bytes,1,opt,name=index_endpoint,json=indexEndpoint,proto3" json:"index_endpoint,omitempty"`
	// Required. The ID of the DeployedIndex to be undeployed from the
	// IndexEndpoint.
	DeployedIndexId string `protobuf:"bytes,2,opt,name=deployed_index_id,json=deployedIndexId,proto3" json:"deployed_index_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].

func (*UndeployIndexRequest) Descriptor deprecated

func (*UndeployIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use UndeployIndexRequest.ProtoReflect.Descriptor instead.

func (*UndeployIndexRequest) GetDeployedIndexId

func (x *UndeployIndexRequest) GetDeployedIndexId() string

func (*UndeployIndexRequest) GetIndexEndpoint

func (x *UndeployIndexRequest) GetIndexEndpoint() string

func (*UndeployIndexRequest) ProtoMessage

func (*UndeployIndexRequest) ProtoMessage()

func (*UndeployIndexRequest) ProtoReflect

func (x *UndeployIndexRequest) ProtoReflect() protoreflect.Message

func (*UndeployIndexRequest) Reset

func (x *UndeployIndexRequest) Reset()

func (*UndeployIndexRequest) String

func (x *UndeployIndexRequest) String() string

type UndeployIndexResponse

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

Response message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].

func (*UndeployIndexResponse) Descriptor deprecated

func (*UndeployIndexResponse) Descriptor() ([]byte, []int)

Deprecated: Use UndeployIndexResponse.ProtoReflect.Descriptor instead.

func (*UndeployIndexResponse) ProtoMessage

func (*UndeployIndexResponse) ProtoMessage()

func (*UndeployIndexResponse) ProtoReflect

func (x *UndeployIndexResponse) ProtoReflect() protoreflect.Message

func (*UndeployIndexResponse) Reset

func (x *UndeployIndexResponse) Reset()

func (*UndeployIndexResponse) String

func (x *UndeployIndexResponse) String() string

type UndeployModelOperationMetadata

type UndeployModelOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel].

func (*UndeployModelOperationMetadata) Descriptor deprecated

func (*UndeployModelOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UndeployModelOperationMetadata.ProtoReflect.Descriptor instead.

func (*UndeployModelOperationMetadata) GetGenericMetadata

func (*UndeployModelOperationMetadata) ProtoMessage

func (*UndeployModelOperationMetadata) ProtoMessage()

func (*UndeployModelOperationMetadata) ProtoReflect

func (*UndeployModelOperationMetadata) Reset

func (x *UndeployModelOperationMetadata) Reset()

func (*UndeployModelOperationMetadata) String

type UndeployModelRequest

type UndeployModelRequest struct {

	// Required. The name of the Endpoint resource from which to undeploy a Model.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Required. The ID of the DeployedModel to be undeployed from the Endpoint.
	DeployedModelId string `protobuf:"bytes,2,opt,name=deployed_model_id,json=deployedModelId,proto3" json:"deployed_model_id,omitempty"`
	// If this field is provided, then the Endpoint's
	// [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be
	// overwritten with it. If last DeployedModel is being undeployed from the
	// Endpoint, the [Endpoint.traffic_split] will always end up empty when this
	// call returns. A DeployedModel will be successfully undeployed only if it
	// doesn't have any traffic assigned to it when this method executes, or if
	// this field unassigns any traffic to it.
	TrafficSplit map[string]int32 `` /* 186-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel].

func (*UndeployModelRequest) Descriptor deprecated

func (*UndeployModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use UndeployModelRequest.ProtoReflect.Descriptor instead.

func (*UndeployModelRequest) GetDeployedModelId

func (x *UndeployModelRequest) GetDeployedModelId() string

func (*UndeployModelRequest) GetEndpoint

func (x *UndeployModelRequest) GetEndpoint() string

func (*UndeployModelRequest) GetTrafficSplit

func (x *UndeployModelRequest) GetTrafficSplit() map[string]int32

func (*UndeployModelRequest) ProtoMessage

func (*UndeployModelRequest) ProtoMessage()

func (*UndeployModelRequest) ProtoReflect

func (x *UndeployModelRequest) ProtoReflect() protoreflect.Message

func (*UndeployModelRequest) Reset

func (x *UndeployModelRequest) Reset()

func (*UndeployModelRequest) String

func (x *UndeployModelRequest) String() string

type UndeployModelResponse

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

Response message for [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel].

func (*UndeployModelResponse) Descriptor deprecated

func (*UndeployModelResponse) Descriptor() ([]byte, []int)

Deprecated: Use UndeployModelResponse.ProtoReflect.Descriptor instead.

func (*UndeployModelResponse) ProtoMessage

func (*UndeployModelResponse) ProtoMessage()

func (*UndeployModelResponse) ProtoReflect

func (x *UndeployModelResponse) ProtoReflect() protoreflect.Message

func (*UndeployModelResponse) Reset

func (x *UndeployModelResponse) Reset()

func (*UndeployModelResponse) String

func (x *UndeployModelResponse) String() string

type UnimplementedDatasetServiceServer

type UnimplementedDatasetServiceServer struct {
}

UnimplementedDatasetServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDatasetServiceServer) CreateDataset

func (*UnimplementedDatasetServiceServer) CreateDatasetVersion added in v1.51.0

func (*UnimplementedDatasetServiceServer) DeleteDataset

func (*UnimplementedDatasetServiceServer) DeleteDatasetVersion added in v1.51.0

func (*UnimplementedDatasetServiceServer) DeleteSavedQuery added in v1.46.0

func (*UnimplementedDatasetServiceServer) ExportData

func (*UnimplementedDatasetServiceServer) GetAnnotationSpec

func (*UnimplementedDatasetServiceServer) GetDataset

func (*UnimplementedDatasetServiceServer) GetDatasetVersion added in v1.51.0

func (*UnimplementedDatasetServiceServer) ImportData

func (*UnimplementedDatasetServiceServer) ListAnnotations

func (*UnimplementedDatasetServiceServer) ListDataItems

func (*UnimplementedDatasetServiceServer) ListDatasetVersions added in v1.51.0

func (*UnimplementedDatasetServiceServer) ListDatasets

func (*UnimplementedDatasetServiceServer) ListSavedQueries

func (*UnimplementedDatasetServiceServer) RestoreDatasetVersion added in v1.51.0

func (*UnimplementedDatasetServiceServer) SearchDataItems added in v1.29.0

func (*UnimplementedDatasetServiceServer) UpdateDataset

type UnimplementedDeploymentResourcePoolServiceServer added in v1.57.0

type UnimplementedDeploymentResourcePoolServiceServer struct {
}

UnimplementedDeploymentResourcePoolServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDeploymentResourcePoolServiceServer) CreateDeploymentResourcePool added in v1.57.0

func (*UnimplementedDeploymentResourcePoolServiceServer) DeleteDeploymentResourcePool added in v1.57.0

func (*UnimplementedDeploymentResourcePoolServiceServer) GetDeploymentResourcePool added in v1.57.0

func (*UnimplementedDeploymentResourcePoolServiceServer) ListDeploymentResourcePools added in v1.57.0

func (*UnimplementedDeploymentResourcePoolServiceServer) QueryDeployedModels added in v1.57.0

type UnimplementedEndpointServiceServer

type UnimplementedEndpointServiceServer struct {
}

UnimplementedEndpointServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedEndpointServiceServer) CreateEndpoint

func (*UnimplementedEndpointServiceServer) DeleteEndpoint

func (*UnimplementedEndpointServiceServer) DeployModel

func (*UnimplementedEndpointServiceServer) GetEndpoint

func (*UnimplementedEndpointServiceServer) ListEndpoints

func (*UnimplementedEndpointServiceServer) MutateDeployedModel added in v1.40.0

func (*UnimplementedEndpointServiceServer) UndeployModel

func (*UnimplementedEndpointServiceServer) UpdateEndpoint

type UnimplementedFeatureOnlineStoreAdminServiceServer added in v1.54.0

type UnimplementedFeatureOnlineStoreAdminServiceServer struct {
}

UnimplementedFeatureOnlineStoreAdminServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) CreateFeatureOnlineStore added in v1.54.0

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) CreateFeatureView added in v1.54.0

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) DeleteFeatureOnlineStore added in v1.54.0

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) DeleteFeatureView added in v1.54.0

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) GetFeatureOnlineStore added in v1.54.0

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) GetFeatureView added in v1.54.0

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) GetFeatureViewSync added in v1.54.0

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) ListFeatureOnlineStores added in v1.54.0

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) ListFeatureViewSyncs added in v1.54.0

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) ListFeatureViews added in v1.54.0

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) SyncFeatureView added in v1.54.0

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) UpdateFeatureOnlineStore added in v1.54.0

func (*UnimplementedFeatureOnlineStoreAdminServiceServer) UpdateFeatureView added in v1.54.0

type UnimplementedFeatureOnlineStoreServiceServer added in v1.54.0

type UnimplementedFeatureOnlineStoreServiceServer struct {
}

UnimplementedFeatureOnlineStoreServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedFeatureOnlineStoreServiceServer) FetchFeatureValues added in v1.54.0

func (*UnimplementedFeatureOnlineStoreServiceServer) SearchNearestEntities added in v1.60.0

type UnimplementedFeatureRegistryServiceServer added in v1.54.0

type UnimplementedFeatureRegistryServiceServer struct {
}

UnimplementedFeatureRegistryServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedFeatureRegistryServiceServer) CreateFeature added in v1.54.0

func (*UnimplementedFeatureRegistryServiceServer) CreateFeatureGroup added in v1.54.0

func (*UnimplementedFeatureRegistryServiceServer) DeleteFeature added in v1.54.0

func (*UnimplementedFeatureRegistryServiceServer) DeleteFeatureGroup added in v1.54.0

func (*UnimplementedFeatureRegistryServiceServer) GetFeature added in v1.54.0

func (*UnimplementedFeatureRegistryServiceServer) GetFeatureGroup added in v1.54.0

func (*UnimplementedFeatureRegistryServiceServer) ListFeatureGroups added in v1.54.0

func (*UnimplementedFeatureRegistryServiceServer) ListFeatures added in v1.54.0

func (*UnimplementedFeatureRegistryServiceServer) UpdateFeature added in v1.54.0

func (*UnimplementedFeatureRegistryServiceServer) UpdateFeatureGroup added in v1.54.0

type UnimplementedFeaturestoreOnlineServingServiceServer

type UnimplementedFeaturestoreOnlineServingServiceServer struct {
}

UnimplementedFeaturestoreOnlineServingServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedFeaturestoreOnlineServingServiceServer) ReadFeatureValues

func (*UnimplementedFeaturestoreOnlineServingServiceServer) WriteFeatureValues

type UnimplementedFeaturestoreServiceServer

type UnimplementedFeaturestoreServiceServer struct {
}

UnimplementedFeaturestoreServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedFeaturestoreServiceServer) BatchCreateFeatures

func (*UnimplementedFeaturestoreServiceServer) BatchReadFeatureValues

func (*UnimplementedFeaturestoreServiceServer) CreateEntityType

func (*UnimplementedFeaturestoreServiceServer) CreateFeature

func (*UnimplementedFeaturestoreServiceServer) CreateFeaturestore

func (*UnimplementedFeaturestoreServiceServer) DeleteEntityType

func (*UnimplementedFeaturestoreServiceServer) DeleteFeature

func (*UnimplementedFeaturestoreServiceServer) DeleteFeatureValues added in v1.36.0

func (*UnimplementedFeaturestoreServiceServer) DeleteFeaturestore

func (*UnimplementedFeaturestoreServiceServer) ExportFeatureValues

func (*UnimplementedFeaturestoreServiceServer) GetEntityType

func (*UnimplementedFeaturestoreServiceServer) GetFeature

func (*UnimplementedFeaturestoreServiceServer) GetFeaturestore

func (*UnimplementedFeaturestoreServiceServer) ImportFeatureValues

func (*UnimplementedFeaturestoreServiceServer) ListEntityTypes

func (*UnimplementedFeaturestoreServiceServer) ListFeatures

func (*UnimplementedFeaturestoreServiceServer) ListFeaturestores

func (*UnimplementedFeaturestoreServiceServer) SearchFeatures

func (*UnimplementedFeaturestoreServiceServer) UpdateEntityType

func (*UnimplementedFeaturestoreServiceServer) UpdateFeature

func (*UnimplementedFeaturestoreServiceServer) UpdateFeaturestore

type UnimplementedGenAiTuningServiceServer added in v1.67.0

type UnimplementedGenAiTuningServiceServer struct {
}

UnimplementedGenAiTuningServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedGenAiTuningServiceServer) CancelTuningJob added in v1.67.0

func (*UnimplementedGenAiTuningServiceServer) CreateTuningJob added in v1.67.0

func (*UnimplementedGenAiTuningServiceServer) GetTuningJob added in v1.67.0

func (*UnimplementedGenAiTuningServiceServer) ListTuningJobs added in v1.67.0

type UnimplementedIndexEndpointServiceServer

type UnimplementedIndexEndpointServiceServer struct {
}

UnimplementedIndexEndpointServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedIndexEndpointServiceServer) CreateIndexEndpoint

func (*UnimplementedIndexEndpointServiceServer) DeleteIndexEndpoint

func (*UnimplementedIndexEndpointServiceServer) DeployIndex

func (*UnimplementedIndexEndpointServiceServer) GetIndexEndpoint

func (*UnimplementedIndexEndpointServiceServer) ListIndexEndpoints

func (*UnimplementedIndexEndpointServiceServer) MutateDeployedIndex

func (*UnimplementedIndexEndpointServiceServer) UndeployIndex

func (*UnimplementedIndexEndpointServiceServer) UpdateIndexEndpoint

type UnimplementedIndexServiceServer

type UnimplementedIndexServiceServer struct {
}

UnimplementedIndexServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedIndexServiceServer) CreateIndex

func (*UnimplementedIndexServiceServer) DeleteIndex

func (*UnimplementedIndexServiceServer) GetIndex

func (*UnimplementedIndexServiceServer) ListIndexes

func (*UnimplementedIndexServiceServer) RemoveDatapoints

func (*UnimplementedIndexServiceServer) UpdateIndex

func (*UnimplementedIndexServiceServer) UpsertDatapoints

type UnimplementedJobServiceServer

type UnimplementedJobServiceServer struct {
}

UnimplementedJobServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedJobServiceServer) CancelBatchPredictionJob

func (*UnimplementedJobServiceServer) CancelCustomJob

func (*UnimplementedJobServiceServer) CancelDataLabelingJob

func (*UnimplementedJobServiceServer) CancelHyperparameterTuningJob

func (*UnimplementedJobServiceServer) CancelNasJob added in v1.34.0

func (*UnimplementedJobServiceServer) CreateBatchPredictionJob

func (*UnimplementedJobServiceServer) CreateCustomJob

func (*UnimplementedJobServiceServer) CreateDataLabelingJob

func (*UnimplementedJobServiceServer) CreateHyperparameterTuningJob

func (*UnimplementedJobServiceServer) CreateNasJob added in v1.34.0

func (*UnimplementedJobServiceServer) DeleteBatchPredictionJob

func (*UnimplementedJobServiceServer) DeleteCustomJob

func (*UnimplementedJobServiceServer) DeleteDataLabelingJob

func (*UnimplementedJobServiceServer) DeleteHyperparameterTuningJob

func (*UnimplementedJobServiceServer) DeleteModelDeploymentMonitoringJob

func (*UnimplementedJobServiceServer) DeleteNasJob added in v1.34.0

func (*UnimplementedJobServiceServer) GetBatchPredictionJob

func (*UnimplementedJobServiceServer) GetCustomJob

func (*UnimplementedJobServiceServer) GetDataLabelingJob

func (*UnimplementedJobServiceServer) GetHyperparameterTuningJob

func (*UnimplementedJobServiceServer) GetNasJob added in v1.34.0

func (*UnimplementedJobServiceServer) GetNasTrialDetail added in v1.34.0

func (*UnimplementedJobServiceServer) ListCustomJobs

func (*UnimplementedJobServiceServer) ListNasJobs added in v1.34.0

func (*UnimplementedJobServiceServer) ListNasTrialDetails added in v1.34.0

func (*UnimplementedJobServiceServer) PauseModelDeploymentMonitoringJob

func (*UnimplementedJobServiceServer) ResumeModelDeploymentMonitoringJob

func (*UnimplementedJobServiceServer) UpdateModelDeploymentMonitoringJob

type UnimplementedLlmUtilityServiceServer added in v1.54.0

type UnimplementedLlmUtilityServiceServer struct {
}

UnimplementedLlmUtilityServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedLlmUtilityServiceServer) ComputeTokens added in v1.54.0

func (*UnimplementedLlmUtilityServiceServer) CountTokens added in v1.54.0

type UnimplementedMatchServiceServer added in v1.43.0

type UnimplementedMatchServiceServer struct {
}

UnimplementedMatchServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedMatchServiceServer) FindNeighbors added in v1.43.0

func (*UnimplementedMatchServiceServer) ReadIndexDatapoints added in v1.43.0

type UnimplementedMetadataServiceServer

type UnimplementedMetadataServiceServer struct {
}

UnimplementedMetadataServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedMetadataServiceServer) AddContextChildren

func (*UnimplementedMetadataServiceServer) AddExecutionEvents

func (*UnimplementedMetadataServiceServer) CreateArtifact

func (*UnimplementedMetadataServiceServer) CreateContext

func (*UnimplementedMetadataServiceServer) CreateExecution

func (*UnimplementedMetadataServiceServer) CreateMetadataSchema

func (*UnimplementedMetadataServiceServer) CreateMetadataStore

func (*UnimplementedMetadataServiceServer) DeleteArtifact

func (*UnimplementedMetadataServiceServer) DeleteContext

func (*UnimplementedMetadataServiceServer) DeleteExecution

func (*UnimplementedMetadataServiceServer) DeleteMetadataStore

func (*UnimplementedMetadataServiceServer) GetArtifact

func (*UnimplementedMetadataServiceServer) GetContext

func (*UnimplementedMetadataServiceServer) GetExecution

func (*UnimplementedMetadataServiceServer) GetMetadataSchema

func (*UnimplementedMetadataServiceServer) GetMetadataStore

func (*UnimplementedMetadataServiceServer) ListArtifacts

func (*UnimplementedMetadataServiceServer) ListContexts

func (*UnimplementedMetadataServiceServer) ListExecutions

func (*UnimplementedMetadataServiceServer) ListMetadataSchemas

func (*UnimplementedMetadataServiceServer) ListMetadataStores

func (*UnimplementedMetadataServiceServer) PurgeArtifacts

func (*UnimplementedMetadataServiceServer) PurgeContexts

func (*UnimplementedMetadataServiceServer) PurgeExecutions

func (*UnimplementedMetadataServiceServer) QueryArtifactLineageSubgraph

func (*UnimplementedMetadataServiceServer) QueryContextLineageSubgraph

func (*UnimplementedMetadataServiceServer) QueryExecutionInputsAndOutputs

func (*UnimplementedMetadataServiceServer) RemoveContextChildren

func (*UnimplementedMetadataServiceServer) UpdateArtifact

func (*UnimplementedMetadataServiceServer) UpdateContext

func (*UnimplementedMetadataServiceServer) UpdateExecution

type UnimplementedMigrationServiceServer

type UnimplementedMigrationServiceServer struct {
}

UnimplementedMigrationServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedMigrationServiceServer) BatchMigrateResources

type UnimplementedModelGardenServiceServer added in v1.44.0

type UnimplementedModelGardenServiceServer struct {
}

UnimplementedModelGardenServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedModelGardenServiceServer) GetPublisherModel added in v1.44.0

type UnimplementedModelServiceServer

type UnimplementedModelServiceServer struct {
}

UnimplementedModelServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedModelServiceServer) BatchImportEvaluatedAnnotations added in v1.36.0

func (*UnimplementedModelServiceServer) CopyModel added in v1.34.0

func (*UnimplementedModelServiceServer) DeleteModel

func (*UnimplementedModelServiceServer) DeleteModelVersion

func (*UnimplementedModelServiceServer) ExportModel

func (*UnimplementedModelServiceServer) GetModel

func (*UnimplementedModelServiceServer) GetModelEvaluation

func (*UnimplementedModelServiceServer) GetModelEvaluationSlice

func (*UnimplementedModelServiceServer) ImportModelEvaluation

func (*UnimplementedModelServiceServer) ListModelEvaluations

func (*UnimplementedModelServiceServer) ListModelVersions

func (*UnimplementedModelServiceServer) ListModels

func (*UnimplementedModelServiceServer) MergeVersionAliases

func (*UnimplementedModelServiceServer) UpdateExplanationDataset added in v1.45.0

func (*UnimplementedModelServiceServer) UpdateModel

func (*UnimplementedModelServiceServer) UploadModel

type UnimplementedNotebookServiceServer added in v1.67.0

type UnimplementedNotebookServiceServer struct {
}

UnimplementedNotebookServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedNotebookServiceServer) AssignNotebookRuntime added in v1.67.0

func (*UnimplementedNotebookServiceServer) CreateNotebookRuntimeTemplate added in v1.67.0

func (*UnimplementedNotebookServiceServer) DeleteNotebookRuntime added in v1.67.0

func (*UnimplementedNotebookServiceServer) DeleteNotebookRuntimeTemplate added in v1.67.0

func (*UnimplementedNotebookServiceServer) GetNotebookRuntime added in v1.67.0

func (*UnimplementedNotebookServiceServer) GetNotebookRuntimeTemplate added in v1.67.0

func (*UnimplementedNotebookServiceServer) ListNotebookRuntimeTemplates added in v1.67.0

func (*UnimplementedNotebookServiceServer) ListNotebookRuntimes added in v1.67.0

func (*UnimplementedNotebookServiceServer) StartNotebookRuntime added in v1.67.0

func (*UnimplementedNotebookServiceServer) UpgradeNotebookRuntime added in v1.67.0

type UnimplementedPersistentResourceServiceServer added in v1.67.0

type UnimplementedPersistentResourceServiceServer struct {
}

UnimplementedPersistentResourceServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedPersistentResourceServiceServer) CreatePersistentResource added in v1.67.0

func (*UnimplementedPersistentResourceServiceServer) DeletePersistentResource added in v1.67.0

func (*UnimplementedPersistentResourceServiceServer) GetPersistentResource added in v1.67.0

func (*UnimplementedPersistentResourceServiceServer) ListPersistentResources added in v1.67.0

func (*UnimplementedPersistentResourceServiceServer) RebootPersistentResource added in v1.67.0

func (*UnimplementedPersistentResourceServiceServer) UpdatePersistentResource added in v1.67.0

type UnimplementedPipelineServiceServer

type UnimplementedPipelineServiceServer struct {
}

UnimplementedPipelineServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedPipelineServiceServer) BatchCancelPipelineJobs added in v1.63.0

func (*UnimplementedPipelineServiceServer) BatchDeletePipelineJobs added in v1.63.0

func (*UnimplementedPipelineServiceServer) CancelPipelineJob

func (*UnimplementedPipelineServiceServer) CancelTrainingPipeline

func (*UnimplementedPipelineServiceServer) CreatePipelineJob

func (*UnimplementedPipelineServiceServer) CreateTrainingPipeline

func (*UnimplementedPipelineServiceServer) DeletePipelineJob

func (*UnimplementedPipelineServiceServer) DeleteTrainingPipeline

func (*UnimplementedPipelineServiceServer) GetPipelineJob

func (*UnimplementedPipelineServiceServer) GetTrainingPipeline

func (*UnimplementedPipelineServiceServer) ListPipelineJobs

func (*UnimplementedPipelineServiceServer) ListTrainingPipelines

type UnimplementedPredictionServiceServer

type UnimplementedPredictionServiceServer struct {
}

UnimplementedPredictionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedPredictionServiceServer) DirectPredict added in v1.55.0

func (*UnimplementedPredictionServiceServer) DirectRawPredict added in v1.55.0

func (*UnimplementedPredictionServiceServer) Explain

func (*UnimplementedPredictionServiceServer) GenerateContent added in v1.59.0

func (*UnimplementedPredictionServiceServer) Predict

func (*UnimplementedPredictionServiceServer) RawPredict

func (*UnimplementedPredictionServiceServer) ServerStreamingPredict added in v1.48.0

func (*UnimplementedPredictionServiceServer) StreamDirectPredict added in v1.59.0

func (*UnimplementedPredictionServiceServer) StreamDirectRawPredict added in v1.59.0

func (*UnimplementedPredictionServiceServer) StreamGenerateContent added in v1.57.0

func (*UnimplementedPredictionServiceServer) StreamRawPredict added in v1.59.0

func (*UnimplementedPredictionServiceServer) StreamingPredict added in v1.55.0

func (*UnimplementedPredictionServiceServer) StreamingRawPredict added in v1.55.0

type UnimplementedScheduleServiceServer added in v1.47.0

type UnimplementedScheduleServiceServer struct {
}

UnimplementedScheduleServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedScheduleServiceServer) CreateSchedule added in v1.47.0

func (*UnimplementedScheduleServiceServer) DeleteSchedule added in v1.47.0

func (*UnimplementedScheduleServiceServer) GetSchedule added in v1.47.0

func (*UnimplementedScheduleServiceServer) ListSchedules added in v1.47.0

func (*UnimplementedScheduleServiceServer) PauseSchedule added in v1.47.0

func (*UnimplementedScheduleServiceServer) ResumeSchedule added in v1.47.0

func (*UnimplementedScheduleServiceServer) UpdateSchedule added in v1.47.0

type UnimplementedSpecialistPoolServiceServer

type UnimplementedSpecialistPoolServiceServer struct {
}

UnimplementedSpecialistPoolServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSpecialistPoolServiceServer) CreateSpecialistPool

func (*UnimplementedSpecialistPoolServiceServer) DeleteSpecialistPool

func (*UnimplementedSpecialistPoolServiceServer) GetSpecialistPool

func (*UnimplementedSpecialistPoolServiceServer) ListSpecialistPools

func (*UnimplementedSpecialistPoolServiceServer) UpdateSpecialistPool

type UnimplementedTensorboardServiceServer

type UnimplementedTensorboardServiceServer struct {
}

UnimplementedTensorboardServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedTensorboardServiceServer) CreateTensorboard

func (*UnimplementedTensorboardServiceServer) CreateTensorboardExperiment

func (*UnimplementedTensorboardServiceServer) CreateTensorboardRun

func (*UnimplementedTensorboardServiceServer) CreateTensorboardTimeSeries

func (*UnimplementedTensorboardServiceServer) DeleteTensorboard

func (*UnimplementedTensorboardServiceServer) DeleteTensorboardExperiment

func (*UnimplementedTensorboardServiceServer) DeleteTensorboardRun

func (*UnimplementedTensorboardServiceServer) DeleteTensorboardTimeSeries

func (*UnimplementedTensorboardServiceServer) GetTensorboard

func (*UnimplementedTensorboardServiceServer) GetTensorboardExperiment

func (*UnimplementedTensorboardServiceServer) GetTensorboardRun

func (*UnimplementedTensorboardServiceServer) GetTensorboardTimeSeries

func (*UnimplementedTensorboardServiceServer) ListTensorboardRuns

func (*UnimplementedTensorboardServiceServer) ListTensorboards

func (*UnimplementedTensorboardServiceServer) ReadTensorboardSize added in v1.49.0

func (*UnimplementedTensorboardServiceServer) ReadTensorboardUsage added in v1.30.0

func (*UnimplementedTensorboardServiceServer) UpdateTensorboard

func (*UnimplementedTensorboardServiceServer) UpdateTensorboardExperiment

func (*UnimplementedTensorboardServiceServer) UpdateTensorboardRun

func (*UnimplementedTensorboardServiceServer) UpdateTensorboardTimeSeries

type UnimplementedVizierServiceServer

type UnimplementedVizierServiceServer struct {
}

UnimplementedVizierServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedVizierServiceServer) AddTrialMeasurement

func (*UnimplementedVizierServiceServer) CheckTrialEarlyStoppingState

func (*UnimplementedVizierServiceServer) CompleteTrial

func (*UnimplementedVizierServiceServer) CreateStudy

func (*UnimplementedVizierServiceServer) CreateTrial

func (*UnimplementedVizierServiceServer) DeleteStudy

func (*UnimplementedVizierServiceServer) DeleteTrial

func (*UnimplementedVizierServiceServer) GetStudy

func (*UnimplementedVizierServiceServer) GetTrial

func (*UnimplementedVizierServiceServer) ListOptimalTrials

func (*UnimplementedVizierServiceServer) ListStudies

func (*UnimplementedVizierServiceServer) ListTrials

func (*UnimplementedVizierServiceServer) LookupStudy

func (*UnimplementedVizierServiceServer) StopTrial

func (*UnimplementedVizierServiceServer) SuggestTrials

type UnmanagedContainerModel

type UnmanagedContainerModel struct {

	// The path to the directory containing the Model artifact and any of its
	// supporting files.
	ArtifactUri string `protobuf:"bytes,1,opt,name=artifact_uri,json=artifactUri,proto3" json:"artifact_uri,omitempty"`
	// Contains the schemata used in Model's predictions and explanations
	PredictSchemata *PredictSchemata `protobuf:"bytes,2,opt,name=predict_schemata,json=predictSchemata,proto3" json:"predict_schemata,omitempty"`
	// Input only. The specification of the container that is to be used when
	// deploying this Model.
	ContainerSpec *ModelContainerSpec `protobuf:"bytes,3,opt,name=container_spec,json=containerSpec,proto3" json:"container_spec,omitempty"`
	// contains filtered or unexported fields
}

Contains model information necessary to perform batch prediction without requiring a full model import.

func (*UnmanagedContainerModel) Descriptor deprecated

func (*UnmanagedContainerModel) Descriptor() ([]byte, []int)

Deprecated: Use UnmanagedContainerModel.ProtoReflect.Descriptor instead.

func (*UnmanagedContainerModel) GetArtifactUri

func (x *UnmanagedContainerModel) GetArtifactUri() string

func (*UnmanagedContainerModel) GetContainerSpec

func (x *UnmanagedContainerModel) GetContainerSpec() *ModelContainerSpec

func (*UnmanagedContainerModel) GetPredictSchemata

func (x *UnmanagedContainerModel) GetPredictSchemata() *PredictSchemata

func (*UnmanagedContainerModel) ProtoMessage

func (*UnmanagedContainerModel) ProtoMessage()

func (*UnmanagedContainerModel) ProtoReflect

func (x *UnmanagedContainerModel) ProtoReflect() protoreflect.Message

func (*UnmanagedContainerModel) Reset

func (x *UnmanagedContainerModel) Reset()

func (*UnmanagedContainerModel) String

func (x *UnmanagedContainerModel) String() string

type UpdateArtifactRequest

type UpdateArtifactRequest struct {

	// Required. The Artifact containing updates.
	// The Artifact's [Artifact.name][google.cloud.aiplatform.v1.Artifact.name]
	// field is used to identify the Artifact to be updated. Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
	Artifact *Artifact `protobuf:"bytes,1,opt,name=artifact,proto3" json:"artifact,omitempty"`
	// Optional. A FieldMask indicating which fields should be updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// If set to true, and the [Artifact][google.cloud.aiplatform.v1.Artifact] is
	// not found, a new [Artifact][google.cloud.aiplatform.v1.Artifact] is
	// created.
	AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.UpdateArtifact][google.cloud.aiplatform.v1.MetadataService.UpdateArtifact].

func (*UpdateArtifactRequest) Descriptor deprecated

func (*UpdateArtifactRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateArtifactRequest.ProtoReflect.Descriptor instead.

func (*UpdateArtifactRequest) GetAllowMissing

func (x *UpdateArtifactRequest) GetAllowMissing() bool

func (*UpdateArtifactRequest) GetArtifact

func (x *UpdateArtifactRequest) GetArtifact() *Artifact

func (*UpdateArtifactRequest) GetUpdateMask

func (x *UpdateArtifactRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateArtifactRequest) ProtoMessage

func (*UpdateArtifactRequest) ProtoMessage()

func (*UpdateArtifactRequest) ProtoReflect

func (x *UpdateArtifactRequest) ProtoReflect() protoreflect.Message

func (*UpdateArtifactRequest) Reset

func (x *UpdateArtifactRequest) Reset()

func (*UpdateArtifactRequest) String

func (x *UpdateArtifactRequest) String() string

type UpdateContextRequest

type UpdateContextRequest struct {

	// Required. The Context containing updates.
	// The Context's [Context.name][google.cloud.aiplatform.v1.Context.name] field
	// is used to identify the Context to be updated. Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
	Context *Context `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// Optional. A FieldMask indicating which fields should be updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// If set to true, and the [Context][google.cloud.aiplatform.v1.Context] is
	// not found, a new [Context][google.cloud.aiplatform.v1.Context] is created.
	AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.UpdateContext][google.cloud.aiplatform.v1.MetadataService.UpdateContext].

func (*UpdateContextRequest) Descriptor deprecated

func (*UpdateContextRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateContextRequest.ProtoReflect.Descriptor instead.

func (*UpdateContextRequest) GetAllowMissing

func (x *UpdateContextRequest) GetAllowMissing() bool

func (*UpdateContextRequest) GetContext

func (x *UpdateContextRequest) GetContext() *Context

func (*UpdateContextRequest) GetUpdateMask

func (x *UpdateContextRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateContextRequest) ProtoMessage

func (*UpdateContextRequest) ProtoMessage()

func (*UpdateContextRequest) ProtoReflect

func (x *UpdateContextRequest) ProtoReflect() protoreflect.Message

func (*UpdateContextRequest) Reset

func (x *UpdateContextRequest) Reset()

func (*UpdateContextRequest) String

func (x *UpdateContextRequest) String() string

type UpdateDatasetRequest

type UpdateDatasetRequest struct {

	// Required. The Dataset which replaces the resource on the server.
	Dataset *Dataset `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// Required. The update mask applies to the resource.
	// For the `FieldMask` definition, see
	// [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:
	//
	//   - `display_name`
	//   - `description`
	//   - `labels`
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DatasetService.UpdateDataset][google.cloud.aiplatform.v1.DatasetService.UpdateDataset].

func (*UpdateDatasetRequest) Descriptor deprecated

func (*UpdateDatasetRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDatasetRequest.ProtoReflect.Descriptor instead.

func (*UpdateDatasetRequest) GetDataset

func (x *UpdateDatasetRequest) GetDataset() *Dataset

func (*UpdateDatasetRequest) GetUpdateMask

func (x *UpdateDatasetRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateDatasetRequest) ProtoMessage

func (*UpdateDatasetRequest) ProtoMessage()

func (*UpdateDatasetRequest) ProtoReflect

func (x *UpdateDatasetRequest) ProtoReflect() protoreflect.Message

func (*UpdateDatasetRequest) Reset

func (x *UpdateDatasetRequest) Reset()

func (*UpdateDatasetRequest) String

func (x *UpdateDatasetRequest) String() string

type UpdateDeploymentResourcePoolOperationMetadata added in v1.57.0

type UpdateDeploymentResourcePoolOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for UpdateDeploymentResourcePool method.

func (*UpdateDeploymentResourcePoolOperationMetadata) Descriptor deprecated added in v1.57.0

Deprecated: Use UpdateDeploymentResourcePoolOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdateDeploymentResourcePoolOperationMetadata) GetGenericMetadata added in v1.57.0

func (*UpdateDeploymentResourcePoolOperationMetadata) ProtoMessage added in v1.57.0

func (*UpdateDeploymentResourcePoolOperationMetadata) ProtoReflect added in v1.57.0

func (*UpdateDeploymentResourcePoolOperationMetadata) Reset added in v1.57.0

func (*UpdateDeploymentResourcePoolOperationMetadata) String added in v1.57.0

type UpdateEndpointRequest

type UpdateEndpointRequest struct {

	// Required. The Endpoint which replaces the resource on the server.
	Endpoint *Endpoint `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Required. The update mask applies to the resource. See
	// [google.protobuf.FieldMask][google.protobuf.FieldMask].
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint].

func (*UpdateEndpointRequest) Descriptor deprecated

func (*UpdateEndpointRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateEndpointRequest.ProtoReflect.Descriptor instead.

func (*UpdateEndpointRequest) GetEndpoint

func (x *UpdateEndpointRequest) GetEndpoint() *Endpoint

func (*UpdateEndpointRequest) GetUpdateMask

func (x *UpdateEndpointRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateEndpointRequest) ProtoMessage

func (*UpdateEndpointRequest) ProtoMessage()

func (*UpdateEndpointRequest) ProtoReflect

func (x *UpdateEndpointRequest) ProtoReflect() protoreflect.Message

func (*UpdateEndpointRequest) Reset

func (x *UpdateEndpointRequest) Reset()

func (*UpdateEndpointRequest) String

func (x *UpdateEndpointRequest) String() string

type UpdateEntityTypeRequest

type UpdateEntityTypeRequest struct {

	// Required. The EntityType's `name` field is used to identify the EntityType
	// to be updated. Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
	EntityType *EntityType `protobuf:"bytes,1,opt,name=entity_type,json=entityType,proto3" json:"entity_type,omitempty"`
	// Field mask is used to specify the fields to be overwritten in the
	// EntityType resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then only the non-empty fields present in the
	// request will be overwritten. Set the update_mask to `*` to override all
	// fields.
	//
	// Updatable fields:
	//
	//   - `description`
	//   - `labels`
	//   - `monitoring_config.snapshot_analysis.disabled`
	//   - `monitoring_config.snapshot_analysis.monitoring_interval_days`
	//   - `monitoring_config.snapshot_analysis.staleness_days`
	//   - `monitoring_config.import_features_analysis.state`
	//   - `monitoring_config.import_features_analysis.anomaly_detection_baseline`
	//   - `monitoring_config.numerical_threshold_config.value`
	//   - `monitoring_config.categorical_threshold_config.value`
	//   - `offline_storage_ttl_days`
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.UpdateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.UpdateEntityType].

func (*UpdateEntityTypeRequest) Descriptor deprecated

func (*UpdateEntityTypeRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateEntityTypeRequest.ProtoReflect.Descriptor instead.

func (*UpdateEntityTypeRequest) GetEntityType

func (x *UpdateEntityTypeRequest) GetEntityType() *EntityType

func (*UpdateEntityTypeRequest) GetUpdateMask

func (x *UpdateEntityTypeRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateEntityTypeRequest) ProtoMessage

func (*UpdateEntityTypeRequest) ProtoMessage()

func (*UpdateEntityTypeRequest) ProtoReflect

func (x *UpdateEntityTypeRequest) ProtoReflect() protoreflect.Message

func (*UpdateEntityTypeRequest) Reset

func (x *UpdateEntityTypeRequest) Reset()

func (*UpdateEntityTypeRequest) String

func (x *UpdateEntityTypeRequest) String() string

type UpdateExecutionRequest

type UpdateExecutionRequest struct {

	// Required. The Execution containing updates.
	// The Execution's [Execution.name][google.cloud.aiplatform.v1.Execution.name]
	// field is used to identify the Execution to be updated. Format:
	// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
	Execution *Execution `protobuf:"bytes,1,opt,name=execution,proto3" json:"execution,omitempty"`
	// Optional. A FieldMask indicating which fields should be updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// If set to true, and the [Execution][google.cloud.aiplatform.v1.Execution]
	// is not found, a new [Execution][google.cloud.aiplatform.v1.Execution] is
	// created.
	AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [MetadataService.UpdateExecution][google.cloud.aiplatform.v1.MetadataService.UpdateExecution].

func (*UpdateExecutionRequest) Descriptor deprecated

func (*UpdateExecutionRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateExecutionRequest.ProtoReflect.Descriptor instead.

func (*UpdateExecutionRequest) GetAllowMissing

func (x *UpdateExecutionRequest) GetAllowMissing() bool

func (*UpdateExecutionRequest) GetExecution

func (x *UpdateExecutionRequest) GetExecution() *Execution

func (*UpdateExecutionRequest) GetUpdateMask

func (x *UpdateExecutionRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateExecutionRequest) ProtoMessage

func (*UpdateExecutionRequest) ProtoMessage()

func (*UpdateExecutionRequest) ProtoReflect

func (x *UpdateExecutionRequest) ProtoReflect() protoreflect.Message

func (*UpdateExecutionRequest) Reset

func (x *UpdateExecutionRequest) Reset()

func (*UpdateExecutionRequest) String

func (x *UpdateExecutionRequest) String() string

type UpdateExplanationDatasetOperationMetadata added in v1.45.0

type UpdateExplanationDatasetOperationMetadata struct {

	// The common part of the operation metadata.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [ModelService.UpdateExplanationDataset][google.cloud.aiplatform.v1.ModelService.UpdateExplanationDataset].

func (*UpdateExplanationDatasetOperationMetadata) Descriptor deprecated added in v1.45.0

func (*UpdateExplanationDatasetOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateExplanationDatasetOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdateExplanationDatasetOperationMetadata) GetGenericMetadata added in v1.45.0

func (*UpdateExplanationDatasetOperationMetadata) ProtoMessage added in v1.45.0

func (*UpdateExplanationDatasetOperationMetadata) ProtoReflect added in v1.45.0

func (*UpdateExplanationDatasetOperationMetadata) Reset added in v1.45.0

func (*UpdateExplanationDatasetOperationMetadata) String added in v1.45.0

type UpdateExplanationDatasetRequest added in v1.45.0

type UpdateExplanationDatasetRequest struct {

	// Required. The resource name of the Model to update.
	// Format: `projects/{project}/locations/{location}/models/{model}`
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// The example config containing the location of the dataset.
	Examples *Examples `protobuf:"bytes,2,opt,name=examples,proto3" json:"examples,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.UpdateExplanationDataset][google.cloud.aiplatform.v1.ModelService.UpdateExplanationDataset].

func (*UpdateExplanationDatasetRequest) Descriptor deprecated added in v1.45.0

func (*UpdateExplanationDatasetRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateExplanationDatasetRequest.ProtoReflect.Descriptor instead.

func (*UpdateExplanationDatasetRequest) GetExamples added in v1.45.0

func (x *UpdateExplanationDatasetRequest) GetExamples() *Examples

func (*UpdateExplanationDatasetRequest) GetModel added in v1.45.0

func (*UpdateExplanationDatasetRequest) ProtoMessage added in v1.45.0

func (*UpdateExplanationDatasetRequest) ProtoMessage()

func (*UpdateExplanationDatasetRequest) ProtoReflect added in v1.45.0

func (*UpdateExplanationDatasetRequest) Reset added in v1.45.0

func (*UpdateExplanationDatasetRequest) String added in v1.45.0

type UpdateExplanationDatasetResponse added in v1.45.0

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

Response message of [ModelService.UpdateExplanationDataset][google.cloud.aiplatform.v1.ModelService.UpdateExplanationDataset] operation.

func (*UpdateExplanationDatasetResponse) Descriptor deprecated added in v1.45.0

func (*UpdateExplanationDatasetResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpdateExplanationDatasetResponse.ProtoReflect.Descriptor instead.

func (*UpdateExplanationDatasetResponse) ProtoMessage added in v1.45.0

func (*UpdateExplanationDatasetResponse) ProtoMessage()

func (*UpdateExplanationDatasetResponse) ProtoReflect added in v1.45.0

func (*UpdateExplanationDatasetResponse) Reset added in v1.45.0

func (*UpdateExplanationDatasetResponse) String added in v1.45.0

type UpdateFeatureGroupOperationMetadata added in v1.54.0

type UpdateFeatureGroupOperationMetadata struct {

	// Operation metadata for FeatureGroup.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform update FeatureGroup.

func (*UpdateFeatureGroupOperationMetadata) Descriptor deprecated added in v1.54.0

func (*UpdateFeatureGroupOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateFeatureGroupOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdateFeatureGroupOperationMetadata) GetGenericMetadata added in v1.54.0

func (*UpdateFeatureGroupOperationMetadata) ProtoMessage added in v1.54.0

func (*UpdateFeatureGroupOperationMetadata) ProtoMessage()

func (*UpdateFeatureGroupOperationMetadata) ProtoReflect added in v1.54.0

func (*UpdateFeatureGroupOperationMetadata) Reset added in v1.54.0

func (*UpdateFeatureGroupOperationMetadata) String added in v1.54.0

type UpdateFeatureGroupRequest added in v1.54.0

type UpdateFeatureGroupRequest struct {

	// Required. The FeatureGroup's `name` field is used to identify the
	// FeatureGroup to be updated. Format:
	// `projects/{project}/locations/{location}/featureGroups/{feature_group}`
	FeatureGroup *FeatureGroup `protobuf:"bytes,1,opt,name=feature_group,json=featureGroup,proto3" json:"feature_group,omitempty"`
	// Field mask is used to specify the fields to be overwritten in the
	// FeatureGroup resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then only the non-empty fields present in the
	// request will be overwritten. Set the update_mask to `*` to override all
	// fields.
	//
	// Updatable fields:
	//
	//   - `labels`
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureRegistryService.UpdateFeatureGroup][google.cloud.aiplatform.v1.FeatureRegistryService.UpdateFeatureGroup].

func (*UpdateFeatureGroupRequest) Descriptor deprecated added in v1.54.0

func (*UpdateFeatureGroupRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateFeatureGroupRequest.ProtoReflect.Descriptor instead.

func (*UpdateFeatureGroupRequest) GetFeatureGroup added in v1.54.0

func (x *UpdateFeatureGroupRequest) GetFeatureGroup() *FeatureGroup

func (*UpdateFeatureGroupRequest) GetUpdateMask added in v1.54.0

func (x *UpdateFeatureGroupRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateFeatureGroupRequest) ProtoMessage added in v1.54.0

func (*UpdateFeatureGroupRequest) ProtoMessage()

func (*UpdateFeatureGroupRequest) ProtoReflect added in v1.54.0

func (*UpdateFeatureGroupRequest) Reset added in v1.54.0

func (x *UpdateFeatureGroupRequest) Reset()

func (*UpdateFeatureGroupRequest) String added in v1.54.0

func (x *UpdateFeatureGroupRequest) String() string

type UpdateFeatureOnlineStoreOperationMetadata added in v1.54.0

type UpdateFeatureOnlineStoreOperationMetadata struct {

	// Operation metadata for FeatureOnlineStore.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform update FeatureOnlineStore.

func (*UpdateFeatureOnlineStoreOperationMetadata) Descriptor deprecated added in v1.54.0

func (*UpdateFeatureOnlineStoreOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateFeatureOnlineStoreOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdateFeatureOnlineStoreOperationMetadata) GetGenericMetadata added in v1.54.0

func (*UpdateFeatureOnlineStoreOperationMetadata) ProtoMessage added in v1.54.0

func (*UpdateFeatureOnlineStoreOperationMetadata) ProtoReflect added in v1.54.0

func (*UpdateFeatureOnlineStoreOperationMetadata) Reset added in v1.54.0

func (*UpdateFeatureOnlineStoreOperationMetadata) String added in v1.54.0

type UpdateFeatureOnlineStoreRequest added in v1.54.0

type UpdateFeatureOnlineStoreRequest struct {

	// Required. The FeatureOnlineStore's `name` field is used to identify the
	// FeatureOnlineStore to be updated. Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
	FeatureOnlineStore *FeatureOnlineStore `protobuf:"bytes,1,opt,name=feature_online_store,json=featureOnlineStore,proto3" json:"feature_online_store,omitempty"`
	// Field mask is used to specify the fields to be overwritten in the
	// FeatureOnlineStore resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then only the non-empty fields present in the
	// request will be overwritten. Set the update_mask to `*` to override all
	// fields.
	//
	// Updatable fields:
	//
	//   - `big_query_source`
	//   - `bigtable`
	//   - `labels`
	//   - `sync_config`
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.UpdateFeatureOnlineStore][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.UpdateFeatureOnlineStore].

func (*UpdateFeatureOnlineStoreRequest) Descriptor deprecated added in v1.54.0

func (*UpdateFeatureOnlineStoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateFeatureOnlineStoreRequest.ProtoReflect.Descriptor instead.

func (*UpdateFeatureOnlineStoreRequest) GetFeatureOnlineStore added in v1.54.0

func (x *UpdateFeatureOnlineStoreRequest) GetFeatureOnlineStore() *FeatureOnlineStore

func (*UpdateFeatureOnlineStoreRequest) GetUpdateMask added in v1.54.0

func (*UpdateFeatureOnlineStoreRequest) ProtoMessage added in v1.54.0

func (*UpdateFeatureOnlineStoreRequest) ProtoMessage()

func (*UpdateFeatureOnlineStoreRequest) ProtoReflect added in v1.54.0

func (*UpdateFeatureOnlineStoreRequest) Reset added in v1.54.0

func (*UpdateFeatureOnlineStoreRequest) String added in v1.54.0

type UpdateFeatureOperationMetadata added in v1.54.0

type UpdateFeatureOperationMetadata struct {

	// Operation metadata for Feature Update.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform update Feature.

func (*UpdateFeatureOperationMetadata) Descriptor deprecated added in v1.54.0

func (*UpdateFeatureOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateFeatureOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdateFeatureOperationMetadata) GetGenericMetadata added in v1.54.0

func (*UpdateFeatureOperationMetadata) ProtoMessage added in v1.54.0

func (*UpdateFeatureOperationMetadata) ProtoMessage()

func (*UpdateFeatureOperationMetadata) ProtoReflect added in v1.54.0

func (*UpdateFeatureOperationMetadata) Reset added in v1.54.0

func (x *UpdateFeatureOperationMetadata) Reset()

func (*UpdateFeatureOperationMetadata) String added in v1.54.0

type UpdateFeatureRequest

type UpdateFeatureRequest struct {

	// Required. The Feature's `name` field is used to identify the Feature to be
	// updated.
	// Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
	// `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
	Feature *Feature `protobuf:"bytes,1,opt,name=feature,proto3" json:"feature,omitempty"`
	// Field mask is used to specify the fields to be overwritten in the
	// Features resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then only the non-empty fields present in the
	// request will be overwritten. Set the update_mask to `*` to override all
	// fields.
	//
	// Updatable fields:
	//
	//   - `description`
	//   - `labels`
	//   - `disable_monitoring` (Not supported for FeatureRegistry Feature)
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.UpdateFeature][google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeature]. Request message for [FeatureRegistryService.UpdateFeature][google.cloud.aiplatform.v1.FeatureRegistryService.UpdateFeature].

func (*UpdateFeatureRequest) Descriptor deprecated

func (*UpdateFeatureRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateFeatureRequest.ProtoReflect.Descriptor instead.

func (*UpdateFeatureRequest) GetFeature

func (x *UpdateFeatureRequest) GetFeature() *Feature

func (*UpdateFeatureRequest) GetUpdateMask

func (x *UpdateFeatureRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateFeatureRequest) ProtoMessage

func (*UpdateFeatureRequest) ProtoMessage()

func (*UpdateFeatureRequest) ProtoReflect

func (x *UpdateFeatureRequest) ProtoReflect() protoreflect.Message

func (*UpdateFeatureRequest) Reset

func (x *UpdateFeatureRequest) Reset()

func (*UpdateFeatureRequest) String

func (x *UpdateFeatureRequest) String() string

type UpdateFeatureViewOperationMetadata added in v1.54.0

type UpdateFeatureViewOperationMetadata struct {

	// Operation metadata for FeatureView Update.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform update FeatureView.

func (*UpdateFeatureViewOperationMetadata) Descriptor deprecated added in v1.54.0

func (*UpdateFeatureViewOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateFeatureViewOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdateFeatureViewOperationMetadata) GetGenericMetadata added in v1.54.0

func (*UpdateFeatureViewOperationMetadata) ProtoMessage added in v1.54.0

func (*UpdateFeatureViewOperationMetadata) ProtoMessage()

func (*UpdateFeatureViewOperationMetadata) ProtoReflect added in v1.54.0

func (*UpdateFeatureViewOperationMetadata) Reset added in v1.54.0

func (*UpdateFeatureViewOperationMetadata) String added in v1.54.0

type UpdateFeatureViewRequest added in v1.54.0

type UpdateFeatureViewRequest struct {

	// Required. The FeatureView's `name` field is used to identify the
	// FeatureView to be updated. Format:
	// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
	FeatureView *FeatureView `protobuf:"bytes,1,opt,name=feature_view,json=featureView,proto3" json:"feature_view,omitempty"`
	// Field mask is used to specify the fields to be overwritten in the
	// FeatureView resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then only the non-empty fields present in the
	// request will be overwritten. Set the update_mask to `*` to override all
	// fields.
	//
	// Updatable fields:
	//
	//   - `labels`
	//   - `serviceAgentType`
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeatureOnlineStoreAdminService.UpdateFeatureView][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.UpdateFeatureView].

func (*UpdateFeatureViewRequest) Descriptor deprecated added in v1.54.0

func (*UpdateFeatureViewRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateFeatureViewRequest.ProtoReflect.Descriptor instead.

func (*UpdateFeatureViewRequest) GetFeatureView added in v1.54.0

func (x *UpdateFeatureViewRequest) GetFeatureView() *FeatureView

func (*UpdateFeatureViewRequest) GetUpdateMask added in v1.54.0

func (x *UpdateFeatureViewRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateFeatureViewRequest) ProtoMessage added in v1.54.0

func (*UpdateFeatureViewRequest) ProtoMessage()

func (*UpdateFeatureViewRequest) ProtoReflect added in v1.54.0

func (x *UpdateFeatureViewRequest) ProtoReflect() protoreflect.Message

func (*UpdateFeatureViewRequest) Reset added in v1.54.0

func (x *UpdateFeatureViewRequest) Reset()

func (*UpdateFeatureViewRequest) String added in v1.54.0

func (x *UpdateFeatureViewRequest) String() string

type UpdateFeaturestoreOperationMetadata

type UpdateFeaturestoreOperationMetadata struct {

	// Operation metadata for Featurestore.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform update Featurestore.

func (*UpdateFeaturestoreOperationMetadata) Descriptor deprecated

func (*UpdateFeaturestoreOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateFeaturestoreOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdateFeaturestoreOperationMetadata) GetGenericMetadata

func (*UpdateFeaturestoreOperationMetadata) ProtoMessage

func (*UpdateFeaturestoreOperationMetadata) ProtoMessage()

func (*UpdateFeaturestoreOperationMetadata) ProtoReflect

func (*UpdateFeaturestoreOperationMetadata) Reset

func (*UpdateFeaturestoreOperationMetadata) String

type UpdateFeaturestoreRequest

type UpdateFeaturestoreRequest struct {

	// Required. The Featurestore's `name` field is used to identify the
	// Featurestore to be updated. Format:
	// `projects/{project}/locations/{location}/featurestores/{featurestore}`
	Featurestore *Featurestore `protobuf:"bytes,1,opt,name=featurestore,proto3" json:"featurestore,omitempty"`
	// Field mask is used to specify the fields to be overwritten in the
	// Featurestore resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then only the non-empty fields present in the
	// request will be overwritten. Set the update_mask to `*` to override all
	// fields.
	//
	// Updatable fields:
	//
	//   - `labels`
	//   - `online_serving_config.fixed_node_count`
	//   - `online_serving_config.scaling`
	//   - `online_storage_ttl_days`
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreService.UpdateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeaturestore].

func (*UpdateFeaturestoreRequest) Descriptor deprecated

func (*UpdateFeaturestoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateFeaturestoreRequest.ProtoReflect.Descriptor instead.

func (*UpdateFeaturestoreRequest) GetFeaturestore

func (x *UpdateFeaturestoreRequest) GetFeaturestore() *Featurestore

func (*UpdateFeaturestoreRequest) GetUpdateMask

func (x *UpdateFeaturestoreRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateFeaturestoreRequest) ProtoMessage

func (*UpdateFeaturestoreRequest) ProtoMessage()

func (*UpdateFeaturestoreRequest) ProtoReflect

func (*UpdateFeaturestoreRequest) Reset

func (x *UpdateFeaturestoreRequest) Reset()

func (*UpdateFeaturestoreRequest) String

func (x *UpdateFeaturestoreRequest) String() string

type UpdateIndexEndpointRequest

type UpdateIndexEndpointRequest struct {

	// Required. The IndexEndpoint which replaces the resource on the server.
	IndexEndpoint *IndexEndpoint `protobuf:"bytes,1,opt,name=index_endpoint,json=indexEndpoint,proto3" json:"index_endpoint,omitempty"`
	// Required. The update mask applies to the resource. See
	// [google.protobuf.FieldMask][google.protobuf.FieldMask].
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpoint].

func (*UpdateIndexEndpointRequest) Descriptor deprecated

func (*UpdateIndexEndpointRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateIndexEndpointRequest.ProtoReflect.Descriptor instead.

func (*UpdateIndexEndpointRequest) GetIndexEndpoint

func (x *UpdateIndexEndpointRequest) GetIndexEndpoint() *IndexEndpoint

func (*UpdateIndexEndpointRequest) GetUpdateMask

func (x *UpdateIndexEndpointRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateIndexEndpointRequest) ProtoMessage

func (*UpdateIndexEndpointRequest) ProtoMessage()

func (*UpdateIndexEndpointRequest) ProtoReflect

func (*UpdateIndexEndpointRequest) Reset

func (x *UpdateIndexEndpointRequest) Reset()

func (*UpdateIndexEndpointRequest) String

func (x *UpdateIndexEndpointRequest) String() string

type UpdateIndexOperationMetadata

type UpdateIndexOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// The operation metadata with regard to Matching Engine Index operation.
	NearestNeighborSearchOperationMetadata *NearestNeighborSearchOperationMetadata `` /* 181-byte string literal not displayed */
	// contains filtered or unexported fields
}

Runtime operation information for [IndexService.UpdateIndex][google.cloud.aiplatform.v1.IndexService.UpdateIndex].

func (*UpdateIndexOperationMetadata) Descriptor deprecated

func (*UpdateIndexOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateIndexOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdateIndexOperationMetadata) GetGenericMetadata

func (x *UpdateIndexOperationMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*UpdateIndexOperationMetadata) GetNearestNeighborSearchOperationMetadata

func (x *UpdateIndexOperationMetadata) GetNearestNeighborSearchOperationMetadata() *NearestNeighborSearchOperationMetadata

func (*UpdateIndexOperationMetadata) ProtoMessage

func (*UpdateIndexOperationMetadata) ProtoMessage()

func (*UpdateIndexOperationMetadata) ProtoReflect

func (*UpdateIndexOperationMetadata) Reset

func (x *UpdateIndexOperationMetadata) Reset()

func (*UpdateIndexOperationMetadata) String

type UpdateIndexRequest

type UpdateIndexRequest struct {

	// Required. The Index which updates the resource on the server.
	Index *Index `protobuf:"bytes,1,opt,name=index,proto3" json:"index,omitempty"`
	// The update mask applies to the resource.
	// For the `FieldMask` definition, see
	// [google.protobuf.FieldMask][google.protobuf.FieldMask].
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexService.UpdateIndex][google.cloud.aiplatform.v1.IndexService.UpdateIndex].

func (*UpdateIndexRequest) Descriptor deprecated

func (*UpdateIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateIndexRequest.ProtoReflect.Descriptor instead.

func (*UpdateIndexRequest) GetIndex

func (x *UpdateIndexRequest) GetIndex() *Index

func (*UpdateIndexRequest) GetUpdateMask

func (x *UpdateIndexRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateIndexRequest) ProtoMessage

func (*UpdateIndexRequest) ProtoMessage()

func (*UpdateIndexRequest) ProtoReflect

func (x *UpdateIndexRequest) ProtoReflect() protoreflect.Message

func (*UpdateIndexRequest) Reset

func (x *UpdateIndexRequest) Reset()

func (*UpdateIndexRequest) String

func (x *UpdateIndexRequest) String() string

type UpdateModelDeploymentMonitoringJobOperationMetadata

type UpdateModelDeploymentMonitoringJobOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation information for [JobService.UpdateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.UpdateModelDeploymentMonitoringJob].

func (*UpdateModelDeploymentMonitoringJobOperationMetadata) Descriptor deprecated

Deprecated: Use UpdateModelDeploymentMonitoringJobOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdateModelDeploymentMonitoringJobOperationMetadata) GetGenericMetadata

func (*UpdateModelDeploymentMonitoringJobOperationMetadata) ProtoMessage

func (*UpdateModelDeploymentMonitoringJobOperationMetadata) ProtoReflect

func (*UpdateModelDeploymentMonitoringJobOperationMetadata) Reset

func (*UpdateModelDeploymentMonitoringJobOperationMetadata) String

type UpdateModelDeploymentMonitoringJobRequest

type UpdateModelDeploymentMonitoringJobRequest struct {

	// Required. The model monitoring configuration which replaces the resource on
	// the server.
	ModelDeploymentMonitoringJob *ModelDeploymentMonitoringJob `` /* 149-byte string literal not displayed */
	// Required. The update mask is used to specify the fields to be overwritten
	// in the ModelDeploymentMonitoringJob resource by the update. The fields
	// specified in the update_mask are relative to the resource, not the full
	// request. A field will be overwritten if it is in the mask. If the user does
	// not provide a mask then only the non-empty fields present in the request
	// will be overwritten. Set the update_mask to `*` to override all fields. For
	// the objective config, the user can either provide the update mask for
	// model_deployment_monitoring_objective_configs or any combination of its
	// nested fields, such as:
	// model_deployment_monitoring_objective_configs.objective_config.training_dataset.
	//
	// Updatable fields:
	//
	//   - `display_name`
	//   - `model_deployment_monitoring_schedule_config`
	//   - `model_monitoring_alert_config`
	//   - `logging_sampling_strategy`
	//   - `labels`
	//   - `log_ttl`
	//   - `enable_monitoring_pipeline_logs`
	//
	// .  and
	//   - `model_deployment_monitoring_objective_configs`
	//
	// .  or
	//   - `model_deployment_monitoring_objective_configs.objective_config.training_dataset`
	//   - `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config`
	//   - `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [JobService.UpdateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.UpdateModelDeploymentMonitoringJob].

func (*UpdateModelDeploymentMonitoringJobRequest) Descriptor deprecated

func (*UpdateModelDeploymentMonitoringJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateModelDeploymentMonitoringJobRequest.ProtoReflect.Descriptor instead.

func (*UpdateModelDeploymentMonitoringJobRequest) GetModelDeploymentMonitoringJob

func (x *UpdateModelDeploymentMonitoringJobRequest) GetModelDeploymentMonitoringJob() *ModelDeploymentMonitoringJob

func (*UpdateModelDeploymentMonitoringJobRequest) GetUpdateMask

func (*UpdateModelDeploymentMonitoringJobRequest) ProtoMessage

func (*UpdateModelDeploymentMonitoringJobRequest) ProtoReflect

func (*UpdateModelDeploymentMonitoringJobRequest) Reset

func (*UpdateModelDeploymentMonitoringJobRequest) String

type UpdateModelRequest

type UpdateModelRequest struct {

	// Required. The Model which replaces the resource on the server.
	// When Model Versioning is enabled, the model.name will be used to determine
	// whether to update the model or model version.
	// 1. model.name with the @ value, e.g. models/123@1, refers to a version
	// specific update.
	// 2. model.name without the @ value, e.g. models/123, refers to a model
	// update.
	// 3. model.name with @-, e.g. models/123@-, refers to a model update.
	// 4. Supported model fields: display_name, description; supported
	// version-specific fields: version_description. Labels are supported in both
	// scenarios. Both the model labels and the version labels are merged when a
	// model is returned. When updating labels, if the request is for
	// model-specific update, model label gets updated. Otherwise, version labels
	// get updated.
	// 5. A model name or model version name fields update mismatch will cause a
	// precondition error.
	// 6. One request cannot update both the model and the version fields. You
	// must update them separately.
	Model *Model `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Required. The update mask applies to the resource.
	// For the `FieldMask` definition, see
	// [google.protobuf.FieldMask][google.protobuf.FieldMask].
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.UpdateModel][google.cloud.aiplatform.v1.ModelService.UpdateModel].

func (*UpdateModelRequest) Descriptor deprecated

func (*UpdateModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateModelRequest.ProtoReflect.Descriptor instead.

func (*UpdateModelRequest) GetModel

func (x *UpdateModelRequest) GetModel() *Model

func (*UpdateModelRequest) GetUpdateMask

func (x *UpdateModelRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateModelRequest) ProtoMessage

func (*UpdateModelRequest) ProtoMessage()

func (*UpdateModelRequest) ProtoReflect

func (x *UpdateModelRequest) ProtoReflect() protoreflect.Message

func (*UpdateModelRequest) Reset

func (x *UpdateModelRequest) Reset()

func (*UpdateModelRequest) String

func (x *UpdateModelRequest) String() string

type UpdatePersistentResourceOperationMetadata added in v1.67.0

type UpdatePersistentResourceOperationMetadata struct {

	// Operation metadata for PersistentResource.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// Progress Message for Update LRO
	ProgressMessage string `protobuf:"bytes,2,opt,name=progress_message,json=progressMessage,proto3" json:"progress_message,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform update PersistentResource.

func (*UpdatePersistentResourceOperationMetadata) Descriptor deprecated added in v1.67.0

func (*UpdatePersistentResourceOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdatePersistentResourceOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdatePersistentResourceOperationMetadata) GetGenericMetadata added in v1.67.0

func (*UpdatePersistentResourceOperationMetadata) GetProgressMessage added in v1.67.0

func (x *UpdatePersistentResourceOperationMetadata) GetProgressMessage() string

func (*UpdatePersistentResourceOperationMetadata) ProtoMessage added in v1.67.0

func (*UpdatePersistentResourceOperationMetadata) ProtoReflect added in v1.67.0

func (*UpdatePersistentResourceOperationMetadata) Reset added in v1.67.0

func (*UpdatePersistentResourceOperationMetadata) String added in v1.67.0

type UpdatePersistentResourceRequest added in v1.67.0

type UpdatePersistentResourceRequest struct {

	// Required. The PersistentResource to update.
	//
	// The PersistentResource's `name` field is used to identify the
	// PersistentResource to update. Format:
	// `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
	PersistentResource *PersistentResource `protobuf:"bytes,1,opt,name=persistent_resource,json=persistentResource,proto3" json:"persistent_resource,omitempty"`
	// Required. Specify the fields to be overwritten in the PersistentResource by
	// the update method.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for UpdatePersistentResource method.

func (*UpdatePersistentResourceRequest) Descriptor deprecated added in v1.67.0

func (*UpdatePersistentResourceRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdatePersistentResourceRequest.ProtoReflect.Descriptor instead.

func (*UpdatePersistentResourceRequest) GetPersistentResource added in v1.67.0

func (x *UpdatePersistentResourceRequest) GetPersistentResource() *PersistentResource

func (*UpdatePersistentResourceRequest) GetUpdateMask added in v1.67.0

func (*UpdatePersistentResourceRequest) ProtoMessage added in v1.67.0

func (*UpdatePersistentResourceRequest) ProtoMessage()

func (*UpdatePersistentResourceRequest) ProtoReflect added in v1.67.0

func (*UpdatePersistentResourceRequest) Reset added in v1.67.0

func (*UpdatePersistentResourceRequest) String added in v1.67.0

type UpdateScheduleRequest added in v1.47.0

type UpdateScheduleRequest struct {

	// Required. The Schedule which replaces the resource on the server.
	// The following restrictions will be applied:
	//
	//   - The scheduled request type cannot be changed.
	//   - The non-empty fields cannot be unset.
	//   - The output_only fields will be ignored if specified.
	Schedule *Schedule `protobuf:"bytes,1,opt,name=schedule,proto3" json:"schedule,omitempty"`
	// Required. The update mask applies to the resource. See
	// [google.protobuf.FieldMask][google.protobuf.FieldMask].
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ScheduleService.UpdateSchedule][google.cloud.aiplatform.v1.ScheduleService.UpdateSchedule].

func (*UpdateScheduleRequest) Descriptor deprecated added in v1.47.0

func (*UpdateScheduleRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateScheduleRequest.ProtoReflect.Descriptor instead.

func (*UpdateScheduleRequest) GetSchedule added in v1.47.0

func (x *UpdateScheduleRequest) GetSchedule() *Schedule

func (*UpdateScheduleRequest) GetUpdateMask added in v1.47.0

func (x *UpdateScheduleRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateScheduleRequest) ProtoMessage added in v1.47.0

func (*UpdateScheduleRequest) ProtoMessage()

func (*UpdateScheduleRequest) ProtoReflect added in v1.47.0

func (x *UpdateScheduleRequest) ProtoReflect() protoreflect.Message

func (*UpdateScheduleRequest) Reset added in v1.47.0

func (x *UpdateScheduleRequest) Reset()

func (*UpdateScheduleRequest) String added in v1.47.0

func (x *UpdateScheduleRequest) String() string

type UpdateSpecialistPoolOperationMetadata

type UpdateSpecialistPoolOperationMetadata struct {

	// Output only. The name of the SpecialistPool to which the specialists are
	// being added. Format:
	// `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}`
	SpecialistPool string `protobuf:"bytes,1,opt,name=specialist_pool,json=specialistPool,proto3" json:"specialist_pool,omitempty"`
	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,2,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Runtime operation metadata for [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool].

func (*UpdateSpecialistPoolOperationMetadata) Descriptor deprecated

func (*UpdateSpecialistPoolOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSpecialistPoolOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdateSpecialistPoolOperationMetadata) GetGenericMetadata

func (*UpdateSpecialistPoolOperationMetadata) GetSpecialistPool

func (x *UpdateSpecialistPoolOperationMetadata) GetSpecialistPool() string

func (*UpdateSpecialistPoolOperationMetadata) ProtoMessage

func (*UpdateSpecialistPoolOperationMetadata) ProtoMessage()

func (*UpdateSpecialistPoolOperationMetadata) ProtoReflect

func (*UpdateSpecialistPoolOperationMetadata) Reset

func (*UpdateSpecialistPoolOperationMetadata) String

type UpdateSpecialistPoolRequest

type UpdateSpecialistPoolRequest struct {

	// Required. The SpecialistPool which replaces the resource on the server.
	SpecialistPool *SpecialistPool `protobuf:"bytes,1,opt,name=specialist_pool,json=specialistPool,proto3" json:"specialist_pool,omitempty"`
	// Required. The update mask applies to the resource.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool].

func (*UpdateSpecialistPoolRequest) Descriptor deprecated

func (*UpdateSpecialistPoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSpecialistPoolRequest.ProtoReflect.Descriptor instead.

func (*UpdateSpecialistPoolRequest) GetSpecialistPool

func (x *UpdateSpecialistPoolRequest) GetSpecialistPool() *SpecialistPool

func (*UpdateSpecialistPoolRequest) GetUpdateMask

func (*UpdateSpecialistPoolRequest) ProtoMessage

func (*UpdateSpecialistPoolRequest) ProtoMessage()

func (*UpdateSpecialistPoolRequest) ProtoReflect

func (*UpdateSpecialistPoolRequest) Reset

func (x *UpdateSpecialistPoolRequest) Reset()

func (*UpdateSpecialistPoolRequest) String

func (x *UpdateSpecialistPoolRequest) String() string

type UpdateTensorboardExperimentRequest

type UpdateTensorboardExperimentRequest struct {

	// Required. Field mask is used to specify the fields to be overwritten in the
	// TensorboardExperiment resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field is overwritten if it's in the mask. If the
	// user does not provide a mask then all fields are overwritten if new
	// values are specified.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The TensorboardExperiment's `name` field is used to identify the
	// TensorboardExperiment to be updated. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
	TensorboardExperiment *TensorboardExperiment `protobuf:"bytes,2,opt,name=tensorboard_experiment,json=tensorboardExperiment,proto3" json:"tensorboard_experiment,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.UpdateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardExperiment].

func (*UpdateTensorboardExperimentRequest) Descriptor deprecated

func (*UpdateTensorboardExperimentRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateTensorboardExperimentRequest.ProtoReflect.Descriptor instead.

func (*UpdateTensorboardExperimentRequest) GetTensorboardExperiment

func (x *UpdateTensorboardExperimentRequest) GetTensorboardExperiment() *TensorboardExperiment

func (*UpdateTensorboardExperimentRequest) GetUpdateMask

func (*UpdateTensorboardExperimentRequest) ProtoMessage

func (*UpdateTensorboardExperimentRequest) ProtoMessage()

func (*UpdateTensorboardExperimentRequest) ProtoReflect

func (*UpdateTensorboardExperimentRequest) Reset

func (*UpdateTensorboardExperimentRequest) String

type UpdateTensorboardOperationMetadata

type UpdateTensorboardOperationMetadata struct {

	// Operation metadata for Tensorboard.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform update Tensorboard.

func (*UpdateTensorboardOperationMetadata) Descriptor deprecated

func (*UpdateTensorboardOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateTensorboardOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdateTensorboardOperationMetadata) GetGenericMetadata

func (*UpdateTensorboardOperationMetadata) ProtoMessage

func (*UpdateTensorboardOperationMetadata) ProtoMessage()

func (*UpdateTensorboardOperationMetadata) ProtoReflect

func (*UpdateTensorboardOperationMetadata) Reset

func (*UpdateTensorboardOperationMetadata) String

type UpdateTensorboardRequest

type UpdateTensorboardRequest struct {

	// Required. Field mask is used to specify the fields to be overwritten in the
	// Tensorboard resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field is overwritten if it's in the mask. If the
	// user does not provide a mask then all fields are overwritten if new
	// values are specified.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The Tensorboard's `name` field is used to identify the
	// Tensorboard to be updated. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
	Tensorboard *Tensorboard `protobuf:"bytes,2,opt,name=tensorboard,proto3" json:"tensorboard,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.UpdateTensorboard][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboard].

func (*UpdateTensorboardRequest) Descriptor deprecated

func (*UpdateTensorboardRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateTensorboardRequest.ProtoReflect.Descriptor instead.

func (*UpdateTensorboardRequest) GetTensorboard

func (x *UpdateTensorboardRequest) GetTensorboard() *Tensorboard

func (*UpdateTensorboardRequest) GetUpdateMask

func (x *UpdateTensorboardRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateTensorboardRequest) ProtoMessage

func (*UpdateTensorboardRequest) ProtoMessage()

func (*UpdateTensorboardRequest) ProtoReflect

func (x *UpdateTensorboardRequest) ProtoReflect() protoreflect.Message

func (*UpdateTensorboardRequest) Reset

func (x *UpdateTensorboardRequest) Reset()

func (*UpdateTensorboardRequest) String

func (x *UpdateTensorboardRequest) String() string

type UpdateTensorboardRunRequest

type UpdateTensorboardRunRequest struct {

	// Required. Field mask is used to specify the fields to be overwritten in the
	// TensorboardRun resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field is overwritten if it's in the mask. If the
	// user does not provide a mask then all fields are overwritten if new
	// values are specified.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The TensorboardRun's `name` field is used to identify the
	// TensorboardRun to be updated. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
	TensorboardRun *TensorboardRun `protobuf:"bytes,2,opt,name=tensorboard_run,json=tensorboardRun,proto3" json:"tensorboard_run,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.UpdateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardRun].

func (*UpdateTensorboardRunRequest) Descriptor deprecated

func (*UpdateTensorboardRunRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateTensorboardRunRequest.ProtoReflect.Descriptor instead.

func (*UpdateTensorboardRunRequest) GetTensorboardRun

func (x *UpdateTensorboardRunRequest) GetTensorboardRun() *TensorboardRun

func (*UpdateTensorboardRunRequest) GetUpdateMask

func (*UpdateTensorboardRunRequest) ProtoMessage

func (*UpdateTensorboardRunRequest) ProtoMessage()

func (*UpdateTensorboardRunRequest) ProtoReflect

func (*UpdateTensorboardRunRequest) Reset

func (x *UpdateTensorboardRunRequest) Reset()

func (*UpdateTensorboardRunRequest) String

func (x *UpdateTensorboardRunRequest) String() string

type UpdateTensorboardTimeSeriesRequest

type UpdateTensorboardTimeSeriesRequest struct {

	// Required. Field mask is used to specify the fields to be overwritten in the
	// TensorboardTimeSeries resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field is overwritten if it's in the mask. If the
	// user does not provide a mask then all fields are overwritten if new
	// values are specified.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The TensorboardTimeSeries' `name` field is used to identify the
	// TensorboardTimeSeries to be updated.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
	TensorboardTimeSeries *TensorboardTimeSeries `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [TensorboardService.UpdateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardTimeSeries].

func (*UpdateTensorboardTimeSeriesRequest) Descriptor deprecated

func (*UpdateTensorboardTimeSeriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateTensorboardTimeSeriesRequest.ProtoReflect.Descriptor instead.

func (*UpdateTensorboardTimeSeriesRequest) GetTensorboardTimeSeries

func (x *UpdateTensorboardTimeSeriesRequest) GetTensorboardTimeSeries() *TensorboardTimeSeries

func (*UpdateTensorboardTimeSeriesRequest) GetUpdateMask

func (*UpdateTensorboardTimeSeriesRequest) ProtoMessage

func (*UpdateTensorboardTimeSeriesRequest) ProtoMessage()

func (*UpdateTensorboardTimeSeriesRequest) ProtoReflect

func (*UpdateTensorboardTimeSeriesRequest) Reset

func (*UpdateTensorboardTimeSeriesRequest) String

type UpgradeNotebookRuntimeOperationMetadata added in v1.67.0

type UpgradeNotebookRuntimeOperationMetadata struct {

	// The operation generic information.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// A human-readable message that shows the intermediate progress details of
	// NotebookRuntime.
	ProgressMessage string `protobuf:"bytes,2,opt,name=progress_message,json=progressMessage,proto3" json:"progress_message,omitempty"`
	// contains filtered or unexported fields
}

Metadata information for [NotebookService.UpgradeNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.UpgradeNotebookRuntime].

func (*UpgradeNotebookRuntimeOperationMetadata) Descriptor deprecated added in v1.67.0

func (*UpgradeNotebookRuntimeOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpgradeNotebookRuntimeOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpgradeNotebookRuntimeOperationMetadata) GetGenericMetadata added in v1.67.0

func (*UpgradeNotebookRuntimeOperationMetadata) GetProgressMessage added in v1.67.0

func (x *UpgradeNotebookRuntimeOperationMetadata) GetProgressMessage() string

func (*UpgradeNotebookRuntimeOperationMetadata) ProtoMessage added in v1.67.0

func (*UpgradeNotebookRuntimeOperationMetadata) ProtoReflect added in v1.67.0

func (*UpgradeNotebookRuntimeOperationMetadata) Reset added in v1.67.0

func (*UpgradeNotebookRuntimeOperationMetadata) String added in v1.67.0

type UpgradeNotebookRuntimeRequest added in v1.67.0

type UpgradeNotebookRuntimeRequest struct {

	// Required. The name of the NotebookRuntime resource to be upgrade.
	// Instead of checking whether the name is in valid NotebookRuntime resource
	// name format, directly throw NotFound exception if there is no such
	// NotebookRuntime in spanner.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [NotebookService.UpgradeNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.UpgradeNotebookRuntime].

func (*UpgradeNotebookRuntimeRequest) Descriptor deprecated added in v1.67.0

func (*UpgradeNotebookRuntimeRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpgradeNotebookRuntimeRequest.ProtoReflect.Descriptor instead.

func (*UpgradeNotebookRuntimeRequest) GetName added in v1.67.0

func (*UpgradeNotebookRuntimeRequest) ProtoMessage added in v1.67.0

func (*UpgradeNotebookRuntimeRequest) ProtoMessage()

func (*UpgradeNotebookRuntimeRequest) ProtoReflect added in v1.67.0

func (*UpgradeNotebookRuntimeRequest) Reset added in v1.67.0

func (x *UpgradeNotebookRuntimeRequest) Reset()

func (*UpgradeNotebookRuntimeRequest) String added in v1.67.0

type UpgradeNotebookRuntimeResponse added in v1.67.0

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

Response message for [NotebookService.UpgradeNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.UpgradeNotebookRuntime].

func (*UpgradeNotebookRuntimeResponse) Descriptor deprecated added in v1.67.0

func (*UpgradeNotebookRuntimeResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpgradeNotebookRuntimeResponse.ProtoReflect.Descriptor instead.

func (*UpgradeNotebookRuntimeResponse) ProtoMessage added in v1.67.0

func (*UpgradeNotebookRuntimeResponse) ProtoMessage()

func (*UpgradeNotebookRuntimeResponse) ProtoReflect added in v1.67.0

func (*UpgradeNotebookRuntimeResponse) Reset added in v1.67.0

func (x *UpgradeNotebookRuntimeResponse) Reset()

func (*UpgradeNotebookRuntimeResponse) String added in v1.67.0

type UploadModelOperationMetadata

type UploadModelOperationMetadata struct {

	// The common part of the operation metadata.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel] operation.

func (*UploadModelOperationMetadata) Descriptor deprecated

func (*UploadModelOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UploadModelOperationMetadata.ProtoReflect.Descriptor instead.

func (*UploadModelOperationMetadata) GetGenericMetadata

func (x *UploadModelOperationMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*UploadModelOperationMetadata) ProtoMessage

func (*UploadModelOperationMetadata) ProtoMessage()

func (*UploadModelOperationMetadata) ProtoReflect

func (*UploadModelOperationMetadata) Reset

func (x *UploadModelOperationMetadata) Reset()

func (*UploadModelOperationMetadata) String

type UploadModelRequest

type UploadModelRequest struct {

	// Required. The resource name of the Location into which to upload the Model.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The resource name of the model into which to upload the version.
	// Only specify this field when uploading a new version.
	ParentModel string `protobuf:"bytes,4,opt,name=parent_model,json=parentModel,proto3" json:"parent_model,omitempty"`
	// Optional. The ID to use for the uploaded Model, which will become the final
	// component of the model resource name.
	//
	// This value may be up to 63 characters, and valid characters are
	// `[a-z0-9_-]`. The first character cannot be a number or hyphen.
	ModelId string `protobuf:"bytes,5,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
	// Required. The Model to create.
	Model *Model `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"`
	// Optional. The user-provided custom service account to use to do the model
	// upload. If empty, [Vertex AI Service
	// Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
	// will be used to access resources needed to upload the model. This account
	// must belong to the target project where the model is uploaded to, i.e., the
	// project specified in the `parent` field of this request and have necessary
	// read permissions (to Google Cloud Storage, Artifact Registry, etc.).
	ServiceAccount string `protobuf:"bytes,6,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel].

func (*UploadModelRequest) Descriptor deprecated

func (*UploadModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use UploadModelRequest.ProtoReflect.Descriptor instead.

func (*UploadModelRequest) GetModel

func (x *UploadModelRequest) GetModel() *Model

func (*UploadModelRequest) GetModelId

func (x *UploadModelRequest) GetModelId() string

func (*UploadModelRequest) GetParent

func (x *UploadModelRequest) GetParent() string

func (*UploadModelRequest) GetParentModel

func (x *UploadModelRequest) GetParentModel() string

func (*UploadModelRequest) GetServiceAccount added in v1.29.0

func (x *UploadModelRequest) GetServiceAccount() string

func (*UploadModelRequest) ProtoMessage

func (*UploadModelRequest) ProtoMessage()

func (*UploadModelRequest) ProtoReflect

func (x *UploadModelRequest) ProtoReflect() protoreflect.Message

func (*UploadModelRequest) Reset

func (x *UploadModelRequest) Reset()

func (*UploadModelRequest) String

func (x *UploadModelRequest) String() string

type UploadModelResponse

type UploadModelResponse struct {

	// The name of the uploaded Model resource.
	// Format: `projects/{project}/locations/{location}/models/{model}`
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Output only. The version ID of the model that is uploaded.
	ModelVersionId string `protobuf:"bytes,2,opt,name=model_version_id,json=modelVersionId,proto3" json:"model_version_id,omitempty"`
	// contains filtered or unexported fields
}

Response message of [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel] operation.

func (*UploadModelResponse) Descriptor deprecated

func (*UploadModelResponse) Descriptor() ([]byte, []int)

Deprecated: Use UploadModelResponse.ProtoReflect.Descriptor instead.

func (*UploadModelResponse) GetModel

func (x *UploadModelResponse) GetModel() string

func (*UploadModelResponse) GetModelVersionId

func (x *UploadModelResponse) GetModelVersionId() string

func (*UploadModelResponse) ProtoMessage

func (*UploadModelResponse) ProtoMessage()

func (*UploadModelResponse) ProtoReflect

func (x *UploadModelResponse) ProtoReflect() protoreflect.Message

func (*UploadModelResponse) Reset

func (x *UploadModelResponse) Reset()

func (*UploadModelResponse) String

func (x *UploadModelResponse) String() string

type UpsertDatapointsRequest

type UpsertDatapointsRequest struct {

	// Required. The name of the Index resource to be updated.
	// Format:
	// `projects/{project}/locations/{location}/indexes/{index}`
	Index string `protobuf:"bytes,1,opt,name=index,proto3" json:"index,omitempty"`
	// A list of datapoints to be created/updated.
	Datapoints []*IndexDatapoint `protobuf:"bytes,2,rep,name=datapoints,proto3" json:"datapoints,omitempty"`
	// Optional. Update mask is used to specify the fields to be overwritten in
	// the datapoints by the update. The fields specified in the update_mask are
	// relative to each IndexDatapoint inside datapoints, not the full request.
	//
	// Updatable fields:
	//
	//   - Use `all_restricts` to update both restricts and numeric_restricts.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1.IndexService.UpsertDatapoints]

func (*UpsertDatapointsRequest) Descriptor deprecated

func (*UpsertDatapointsRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpsertDatapointsRequest.ProtoReflect.Descriptor instead.

func (*UpsertDatapointsRequest) GetDatapoints

func (x *UpsertDatapointsRequest) GetDatapoints() []*IndexDatapoint

func (*UpsertDatapointsRequest) GetIndex

func (x *UpsertDatapointsRequest) GetIndex() string

func (*UpsertDatapointsRequest) GetUpdateMask added in v1.60.0

func (x *UpsertDatapointsRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpsertDatapointsRequest) ProtoMessage

func (*UpsertDatapointsRequest) ProtoMessage()

func (*UpsertDatapointsRequest) ProtoReflect

func (x *UpsertDatapointsRequest) ProtoReflect() protoreflect.Message

func (*UpsertDatapointsRequest) Reset

func (x *UpsertDatapointsRequest) Reset()

func (*UpsertDatapointsRequest) String

func (x *UpsertDatapointsRequest) String() string

type UpsertDatapointsResponse

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

Response message for [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1.IndexService.UpsertDatapoints]

func (*UpsertDatapointsResponse) Descriptor deprecated

func (*UpsertDatapointsResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpsertDatapointsResponse.ProtoReflect.Descriptor instead.

func (*UpsertDatapointsResponse) ProtoMessage

func (*UpsertDatapointsResponse) ProtoMessage()

func (*UpsertDatapointsResponse) ProtoReflect

func (x *UpsertDatapointsResponse) ProtoReflect() protoreflect.Message

func (*UpsertDatapointsResponse) Reset

func (x *UpsertDatapointsResponse) Reset()

func (*UpsertDatapointsResponse) String

func (x *UpsertDatapointsResponse) String() string

type UserActionReference

type UserActionReference struct {

	// Types that are assignable to Reference:
	//
	//	*UserActionReference_Operation
	//	*UserActionReference_DataLabelingJob
	Reference isUserActionReference_Reference `protobuf_oneof:"reference"`
	// The method name of the API RPC call. For example,
	// "/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset"
	Method string `protobuf:"bytes,3,opt,name=method,proto3" json:"method,omitempty"`
	// contains filtered or unexported fields
}

References an API call. It contains more information about long running operation and Jobs that are triggered by the API call.

func (*UserActionReference) Descriptor deprecated

func (*UserActionReference) Descriptor() ([]byte, []int)

Deprecated: Use UserActionReference.ProtoReflect.Descriptor instead.

func (*UserActionReference) GetDataLabelingJob

func (x *UserActionReference) GetDataLabelingJob() string

func (*UserActionReference) GetMethod

func (x *UserActionReference) GetMethod() string

func (*UserActionReference) GetOperation

func (x *UserActionReference) GetOperation() string

func (*UserActionReference) GetReference

func (m *UserActionReference) GetReference() isUserActionReference_Reference

func (*UserActionReference) ProtoMessage

func (*UserActionReference) ProtoMessage()

func (*UserActionReference) ProtoReflect

func (x *UserActionReference) ProtoReflect() protoreflect.Message

func (*UserActionReference) Reset

func (x *UserActionReference) Reset()

func (*UserActionReference) String

func (x *UserActionReference) String() string

type UserActionReference_DataLabelingJob

type UserActionReference_DataLabelingJob struct {
	// For API calls that start a LabelingJob.
	// Resource name of the LabelingJob.
	// Format:
	// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
	DataLabelingJob string `protobuf:"bytes,2,opt,name=data_labeling_job,json=dataLabelingJob,proto3,oneof"`
}

type UserActionReference_Operation

type UserActionReference_Operation struct {
	// For API calls that return a long running operation.
	// Resource name of the long running operation.
	// Format:
	// `projects/{project}/locations/{location}/operations/{operation}`
	Operation string `protobuf:"bytes,1,opt,name=operation,proto3,oneof"`
}

type Value

type Value struct {

	// Types that are assignable to Value:
	//
	//	*Value_IntValue
	//	*Value_DoubleValue
	//	*Value_StringValue
	Value isValue_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

Value is the value of the field.

func (*Value) Descriptor deprecated

func (*Value) Descriptor() ([]byte, []int)

Deprecated: Use Value.ProtoReflect.Descriptor instead.

func (*Value) GetDoubleValue

func (x *Value) GetDoubleValue() float64

func (*Value) GetIntValue

func (x *Value) GetIntValue() int64

func (*Value) GetStringValue

func (x *Value) GetStringValue() string

func (*Value) GetValue

func (m *Value) GetValue() isValue_Value

func (*Value) ProtoMessage

func (*Value) ProtoMessage()

func (*Value) ProtoReflect

func (x *Value) ProtoReflect() protoreflect.Message

func (*Value) Reset

func (x *Value) Reset()

func (*Value) String

func (x *Value) String() string

type Value_DoubleValue

type Value_DoubleValue struct {
	// A double value.
	DoubleValue float64 `protobuf:"fixed64,2,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type Value_IntValue

type Value_IntValue struct {
	// An integer value.
	IntValue int64 `protobuf:"varint,1,opt,name=int_value,json=intValue,proto3,oneof"`
}

type Value_StringValue

type Value_StringValue struct {
	// A string value.
	StringValue string `protobuf:"bytes,3,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type VertexAISearch added in v1.63.0

type VertexAISearch struct {

	// Required. Fully-qualified Vertex AI Search's datastore resource ID.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
	Datastore string `protobuf:"bytes,1,opt,name=datastore,proto3" json:"datastore,omitempty"`
	// contains filtered or unexported fields
}

Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation

func (*VertexAISearch) Descriptor deprecated added in v1.63.0

func (*VertexAISearch) Descriptor() ([]byte, []int)

Deprecated: Use VertexAISearch.ProtoReflect.Descriptor instead.

func (*VertexAISearch) GetDatastore added in v1.63.0

func (x *VertexAISearch) GetDatastore() string

func (*VertexAISearch) ProtoMessage added in v1.63.0

func (*VertexAISearch) ProtoMessage()

func (*VertexAISearch) ProtoReflect added in v1.63.0

func (x *VertexAISearch) ProtoReflect() protoreflect.Message

func (*VertexAISearch) Reset added in v1.63.0

func (x *VertexAISearch) Reset()

func (*VertexAISearch) String added in v1.63.0

func (x *VertexAISearch) String() string

type VideoMetadata added in v1.57.0

type VideoMetadata struct {

	// Optional. The start offset of the video.
	StartOffset *durationpb.Duration `protobuf:"bytes,1,opt,name=start_offset,json=startOffset,proto3" json:"start_offset,omitempty"`
	// Optional. The end offset of the video.
	EndOffset *durationpb.Duration `protobuf:"bytes,2,opt,name=end_offset,json=endOffset,proto3" json:"end_offset,omitempty"`
	// contains filtered or unexported fields
}

Metadata describes the input video content.

func (*VideoMetadata) Descriptor deprecated added in v1.57.0

func (*VideoMetadata) Descriptor() ([]byte, []int)

Deprecated: Use VideoMetadata.ProtoReflect.Descriptor instead.

func (*VideoMetadata) GetEndOffset added in v1.57.0

func (x *VideoMetadata) GetEndOffset() *durationpb.Duration

func (*VideoMetadata) GetStartOffset added in v1.57.0

func (x *VideoMetadata) GetStartOffset() *durationpb.Duration

func (*VideoMetadata) ProtoMessage added in v1.57.0

func (*VideoMetadata) ProtoMessage()

func (*VideoMetadata) ProtoReflect added in v1.57.0

func (x *VideoMetadata) ProtoReflect() protoreflect.Message

func (*VideoMetadata) Reset added in v1.57.0

func (x *VideoMetadata) Reset()

func (*VideoMetadata) String added in v1.57.0

func (x *VideoMetadata) String() string

type VizierServiceClient

type VizierServiceClient interface {
	// Creates a Study. A resource name will be generated after creation of the
	// Study.
	CreateStudy(ctx context.Context, in *CreateStudyRequest, opts ...grpc.CallOption) (*Study, error)
	// Gets a Study by name.
	GetStudy(ctx context.Context, in *GetStudyRequest, opts ...grpc.CallOption) (*Study, error)
	// Lists all the studies in a region for an associated project.
	ListStudies(ctx context.Context, in *ListStudiesRequest, opts ...grpc.CallOption) (*ListStudiesResponse, error)
	// Deletes a Study.
	DeleteStudy(ctx context.Context, in *DeleteStudyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Looks a study up using the user-defined display_name field instead of the
	// fully qualified resource name.
	LookupStudy(ctx context.Context, in *LookupStudyRequest, opts ...grpc.CallOption) (*Study, error)
	// Adds one or more Trials to a Study, with parameter values
	// suggested by Vertex AI Vizier. Returns a long-running
	// operation associated with the generation of Trial suggestions.
	// When this long-running operation succeeds, it will contain
	// a
	// [SuggestTrialsResponse][google.cloud.aiplatform.v1.SuggestTrialsResponse].
	SuggestTrials(ctx context.Context, in *SuggestTrialsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Adds a user provided Trial to a Study.
	CreateTrial(ctx context.Context, in *CreateTrialRequest, opts ...grpc.CallOption) (*Trial, error)
	// Gets a Trial.
	GetTrial(ctx context.Context, in *GetTrialRequest, opts ...grpc.CallOption) (*Trial, error)
	// Lists the Trials associated with a Study.
	ListTrials(ctx context.Context, in *ListTrialsRequest, opts ...grpc.CallOption) (*ListTrialsResponse, error)
	// Adds a measurement of the objective metrics to a Trial. This measurement
	// is assumed to have been taken before the Trial is complete.
	AddTrialMeasurement(ctx context.Context, in *AddTrialMeasurementRequest, opts ...grpc.CallOption) (*Trial, error)
	// Marks a Trial as complete.
	CompleteTrial(ctx context.Context, in *CompleteTrialRequest, opts ...grpc.CallOption) (*Trial, error)
	// Deletes a Trial.
	DeleteTrial(ctx context.Context, in *DeleteTrialRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Checks  whether a Trial should stop or not. Returns a
	// long-running operation. When the operation is successful,
	// it will contain a
	// [CheckTrialEarlyStoppingStateResponse][google.cloud.aiplatform.v1.CheckTrialEarlyStoppingStateResponse].
	CheckTrialEarlyStoppingState(ctx context.Context, in *CheckTrialEarlyStoppingStateRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Stops a Trial.
	StopTrial(ctx context.Context, in *StopTrialRequest, opts ...grpc.CallOption) (*Trial, error)
	// Lists the pareto-optimal Trials for multi-objective Study or the
	// optimal Trials for single-objective Study. The definition of
	// pareto-optimal can be checked in wiki page.
	// https://en.wikipedia.org/wiki/Pareto_efficiency
	ListOptimalTrials(ctx context.Context, in *ListOptimalTrialsRequest, opts ...grpc.CallOption) (*ListOptimalTrialsResponse, error)
}

VizierServiceClient is the client API for VizierService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type VizierServiceServer

type VizierServiceServer interface {
	// Creates a Study. A resource name will be generated after creation of the
	// Study.
	CreateStudy(context.Context, *CreateStudyRequest) (*Study, error)
	// Gets a Study by name.
	GetStudy(context.Context, *GetStudyRequest) (*Study, error)
	// Lists all the studies in a region for an associated project.
	ListStudies(context.Context, *ListStudiesRequest) (*ListStudiesResponse, error)
	// Deletes a Study.
	DeleteStudy(context.Context, *DeleteStudyRequest) (*emptypb.Empty, error)
	// Looks a study up using the user-defined display_name field instead of the
	// fully qualified resource name.
	LookupStudy(context.Context, *LookupStudyRequest) (*Study, error)
	// Adds one or more Trials to a Study, with parameter values
	// suggested by Vertex AI Vizier. Returns a long-running
	// operation associated with the generation of Trial suggestions.
	// When this long-running operation succeeds, it will contain
	// a
	// [SuggestTrialsResponse][google.cloud.aiplatform.v1.SuggestTrialsResponse].
	SuggestTrials(context.Context, *SuggestTrialsRequest) (*longrunningpb.Operation, error)
	// Adds a user provided Trial to a Study.
	CreateTrial(context.Context, *CreateTrialRequest) (*Trial, error)
	// Gets a Trial.
	GetTrial(context.Context, *GetTrialRequest) (*Trial, error)
	// Lists the Trials associated with a Study.
	ListTrials(context.Context, *ListTrialsRequest) (*ListTrialsResponse, error)
	// Adds a measurement of the objective metrics to a Trial. This measurement
	// is assumed to have been taken before the Trial is complete.
	AddTrialMeasurement(context.Context, *AddTrialMeasurementRequest) (*Trial, error)
	// Marks a Trial as complete.
	CompleteTrial(context.Context, *CompleteTrialRequest) (*Trial, error)
	// Deletes a Trial.
	DeleteTrial(context.Context, *DeleteTrialRequest) (*emptypb.Empty, error)
	// Checks  whether a Trial should stop or not. Returns a
	// long-running operation. When the operation is successful,
	// it will contain a
	// [CheckTrialEarlyStoppingStateResponse][google.cloud.aiplatform.v1.CheckTrialEarlyStoppingStateResponse].
	CheckTrialEarlyStoppingState(context.Context, *CheckTrialEarlyStoppingStateRequest) (*longrunningpb.Operation, error)
	// Stops a Trial.
	StopTrial(context.Context, *StopTrialRequest) (*Trial, error)
	// Lists the pareto-optimal Trials for multi-objective Study or the
	// optimal Trials for single-objective Study. The definition of
	// pareto-optimal can be checked in wiki page.
	// https://en.wikipedia.org/wiki/Pareto_efficiency
	ListOptimalTrials(context.Context, *ListOptimalTrialsRequest) (*ListOptimalTrialsResponse, error)
}

VizierServiceServer is the server API for VizierService service.

type WorkerPoolSpec

type WorkerPoolSpec struct {

	// The custom task to be executed in this worker pool.
	//
	// Types that are assignable to Task:
	//
	//	*WorkerPoolSpec_ContainerSpec
	//	*WorkerPoolSpec_PythonPackageSpec
	Task isWorkerPoolSpec_Task `protobuf_oneof:"task"`
	// Optional. Immutable. The specification of a single machine.
	MachineSpec *MachineSpec `protobuf:"bytes,1,opt,name=machine_spec,json=machineSpec,proto3" json:"machine_spec,omitempty"`
	// Optional. The number of worker replicas to use for this worker pool.
	ReplicaCount int64 `protobuf:"varint,2,opt,name=replica_count,json=replicaCount,proto3" json:"replica_count,omitempty"`
	// Optional. List of NFS mount spec.
	NfsMounts []*NfsMount `protobuf:"bytes,4,rep,name=nfs_mounts,json=nfsMounts,proto3" json:"nfs_mounts,omitempty"`
	// Disk spec.
	DiskSpec *DiskSpec `protobuf:"bytes,5,opt,name=disk_spec,json=diskSpec,proto3" json:"disk_spec,omitempty"`
	// contains filtered or unexported fields
}

Represents the spec of a worker pool in a job.

func (*WorkerPoolSpec) Descriptor deprecated

func (*WorkerPoolSpec) Descriptor() ([]byte, []int)

Deprecated: Use WorkerPoolSpec.ProtoReflect.Descriptor instead.

func (*WorkerPoolSpec) GetContainerSpec

func (x *WorkerPoolSpec) GetContainerSpec() *ContainerSpec

func (*WorkerPoolSpec) GetDiskSpec

func (x *WorkerPoolSpec) GetDiskSpec() *DiskSpec

func (*WorkerPoolSpec) GetMachineSpec

func (x *WorkerPoolSpec) GetMachineSpec() *MachineSpec

func (*WorkerPoolSpec) GetNfsMounts

func (x *WorkerPoolSpec) GetNfsMounts() []*NfsMount

func (*WorkerPoolSpec) GetPythonPackageSpec

func (x *WorkerPoolSpec) GetPythonPackageSpec() *PythonPackageSpec

func (*WorkerPoolSpec) GetReplicaCount

func (x *WorkerPoolSpec) GetReplicaCount() int64

func (*WorkerPoolSpec) GetTask

func (m *WorkerPoolSpec) GetTask() isWorkerPoolSpec_Task

func (*WorkerPoolSpec) ProtoMessage

func (*WorkerPoolSpec) ProtoMessage()

func (*WorkerPoolSpec) ProtoReflect

func (x *WorkerPoolSpec) ProtoReflect() protoreflect.Message

func (*WorkerPoolSpec) Reset

func (x *WorkerPoolSpec) Reset()

func (*WorkerPoolSpec) String

func (x *WorkerPoolSpec) String() string

type WorkerPoolSpec_ContainerSpec

type WorkerPoolSpec_ContainerSpec struct {
	// The custom container task.
	ContainerSpec *ContainerSpec `protobuf:"bytes,6,opt,name=container_spec,json=containerSpec,proto3,oneof"`
}

type WorkerPoolSpec_PythonPackageSpec

type WorkerPoolSpec_PythonPackageSpec struct {
	// The Python packaged task.
	PythonPackageSpec *PythonPackageSpec `protobuf:"bytes,7,opt,name=python_package_spec,json=pythonPackageSpec,proto3,oneof"`
}

type WriteFeatureValuesPayload

type WriteFeatureValuesPayload struct {

	// Required. The ID of the entity.
	EntityId string `protobuf:"bytes,1,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
	// Required. Feature values to be written, mapping from Feature ID to value.
	// Up to 100,000 `feature_values` entries may be written across all payloads.
	// The feature generation time, aligned by days, must be no older than five
	// years (1825 days) and no later than one year (366 days) in the future.
	FeatureValues map[string]*FeatureValue `` /* 188-byte string literal not displayed */
	// contains filtered or unexported fields
}

Contains Feature values to be written for a specific entity.

func (*WriteFeatureValuesPayload) Descriptor deprecated

func (*WriteFeatureValuesPayload) Descriptor() ([]byte, []int)

Deprecated: Use WriteFeatureValuesPayload.ProtoReflect.Descriptor instead.

func (*WriteFeatureValuesPayload) GetEntityId

func (x *WriteFeatureValuesPayload) GetEntityId() string

func (*WriteFeatureValuesPayload) GetFeatureValues

func (x *WriteFeatureValuesPayload) GetFeatureValues() map[string]*FeatureValue

func (*WriteFeatureValuesPayload) ProtoMessage

func (*WriteFeatureValuesPayload) ProtoMessage()

func (*WriteFeatureValuesPayload) ProtoReflect

func (*WriteFeatureValuesPayload) Reset

func (x *WriteFeatureValuesPayload) Reset()

func (*WriteFeatureValuesPayload) String

func (x *WriteFeatureValuesPayload) String() string

type WriteFeatureValuesRequest

type WriteFeatureValuesRequest struct {

	// Required. The resource name of the EntityType for the entities being
	// written. Value format:
	// `projects/{project}/locations/{location}/featurestores/
	// {featurestore}/entityTypes/{entityType}`. For example,
	// for a machine learning model predicting user clicks on a website, an
	// EntityType ID could be `user`.
	EntityType string `protobuf:"bytes,1,opt,name=entity_type,json=entityType,proto3" json:"entity_type,omitempty"`
	// Required. The entities to be written. Up to 100,000 feature values can be
	// written across all `payloads`.
	Payloads []*WriteFeatureValuesPayload `protobuf:"bytes,2,rep,name=payloads,proto3" json:"payloads,omitempty"`
	// contains filtered or unexported fields
}

Request message for [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues].

func (*WriteFeatureValuesRequest) Descriptor deprecated

func (*WriteFeatureValuesRequest) Descriptor() ([]byte, []int)

Deprecated: Use WriteFeatureValuesRequest.ProtoReflect.Descriptor instead.

func (*WriteFeatureValuesRequest) GetEntityType

func (x *WriteFeatureValuesRequest) GetEntityType() string

func (*WriteFeatureValuesRequest) GetPayloads

func (*WriteFeatureValuesRequest) ProtoMessage

func (*WriteFeatureValuesRequest) ProtoMessage()

func (*WriteFeatureValuesRequest) ProtoReflect

func (*WriteFeatureValuesRequest) Reset

func (x *WriteFeatureValuesRequest) Reset()

func (*WriteFeatureValuesRequest) String

func (x *WriteFeatureValuesRequest) String() string

type WriteFeatureValuesResponse

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

Response message for [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues].

func (*WriteFeatureValuesResponse) Descriptor deprecated

func (*WriteFeatureValuesResponse) Descriptor() ([]byte, []int)

Deprecated: Use WriteFeatureValuesResponse.ProtoReflect.Descriptor instead.

func (*WriteFeatureValuesResponse) ProtoMessage

func (*WriteFeatureValuesResponse) ProtoMessage()

func (*WriteFeatureValuesResponse) ProtoReflect

func (*WriteFeatureValuesResponse) Reset

func (x *WriteFeatureValuesResponse) Reset()

func (*WriteFeatureValuesResponse) String

func (x *WriteFeatureValuesResponse) String() string

type WriteTensorboardExperimentDataRequest

type WriteTensorboardExperimentDataRequest struct {

	// Required. The resource name of the TensorboardExperiment to write data to.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
	TensorboardExperiment string `protobuf:"bytes,1,opt,name=tensorboard_experiment,json=tensorboardExperiment,proto3" json:"tensorboard_experiment,omitempty"`
	// Required. Requests containing per-run TensorboardTimeSeries data to write.
	WriteRunDataRequests []*WriteTensorboardRunDataRequest `protobuf:"bytes,2,rep,name=write_run_data_requests,json=writeRunDataRequests,proto3" json:"write_run_data_requests,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData].

func (*WriteTensorboardExperimentDataRequest) Descriptor deprecated

func (*WriteTensorboardExperimentDataRequest) Descriptor() ([]byte, []int)

Deprecated: Use WriteTensorboardExperimentDataRequest.ProtoReflect.Descriptor instead.

func (*WriteTensorboardExperimentDataRequest) GetTensorboardExperiment

func (x *WriteTensorboardExperimentDataRequest) GetTensorboardExperiment() string

func (*WriteTensorboardExperimentDataRequest) GetWriteRunDataRequests

func (*WriteTensorboardExperimentDataRequest) ProtoMessage

func (*WriteTensorboardExperimentDataRequest) ProtoMessage()

func (*WriteTensorboardExperimentDataRequest) ProtoReflect

func (*WriteTensorboardExperimentDataRequest) Reset

func (*WriteTensorboardExperimentDataRequest) String

type WriteTensorboardExperimentDataResponse

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

Response message for [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData].

func (*WriteTensorboardExperimentDataResponse) Descriptor deprecated

func (*WriteTensorboardExperimentDataResponse) Descriptor() ([]byte, []int)

Deprecated: Use WriteTensorboardExperimentDataResponse.ProtoReflect.Descriptor instead.

func (*WriteTensorboardExperimentDataResponse) ProtoMessage

func (*WriteTensorboardExperimentDataResponse) ProtoReflect

func (*WriteTensorboardExperimentDataResponse) Reset

func (*WriteTensorboardExperimentDataResponse) String

type WriteTensorboardRunDataRequest

type WriteTensorboardRunDataRequest struct {

	// Required. The resource name of the TensorboardRun to write data to.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
	TensorboardRun string `protobuf:"bytes,1,opt,name=tensorboard_run,json=tensorboardRun,proto3" json:"tensorboard_run,omitempty"`
	// Required. The TensorboardTimeSeries data to write.
	// Values with in a time series are indexed by their step value.
	// Repeated writes to the same step will overwrite the existing value for that
	// step.
	// The upper limit of data points per write request is 5000.
	TimeSeriesData []*TimeSeriesData `protobuf:"bytes,2,rep,name=time_series_data,json=timeSeriesData,proto3" json:"time_series_data,omitempty"`
	// contains filtered or unexported fields
}

Request message for [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData].

func (*WriteTensorboardRunDataRequest) Descriptor deprecated

func (*WriteTensorboardRunDataRequest) Descriptor() ([]byte, []int)

Deprecated: Use WriteTensorboardRunDataRequest.ProtoReflect.Descriptor instead.

func (*WriteTensorboardRunDataRequest) GetTensorboardRun

func (x *WriteTensorboardRunDataRequest) GetTensorboardRun() string

func (*WriteTensorboardRunDataRequest) GetTimeSeriesData

func (x *WriteTensorboardRunDataRequest) GetTimeSeriesData() []*TimeSeriesData

func (*WriteTensorboardRunDataRequest) ProtoMessage

func (*WriteTensorboardRunDataRequest) ProtoMessage()

func (*WriteTensorboardRunDataRequest) ProtoReflect

func (*WriteTensorboardRunDataRequest) Reset

func (x *WriteTensorboardRunDataRequest) Reset()

func (*WriteTensorboardRunDataRequest) String

type WriteTensorboardRunDataResponse

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

Response message for [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData].

func (*WriteTensorboardRunDataResponse) Descriptor deprecated

func (*WriteTensorboardRunDataResponse) Descriptor() ([]byte, []int)

Deprecated: Use WriteTensorboardRunDataResponse.ProtoReflect.Descriptor instead.

func (*WriteTensorboardRunDataResponse) ProtoMessage

func (*WriteTensorboardRunDataResponse) ProtoMessage()

func (*WriteTensorboardRunDataResponse) ProtoReflect

func (*WriteTensorboardRunDataResponse) Reset

func (*WriteTensorboardRunDataResponse) String

type XraiAttribution

type XraiAttribution struct {

	// Required. The number of steps for approximating the path integral.
	// A good value to start is 50 and gradually increase until the
	// sum to diff property is met within the desired error range.
	//
	// Valid range of its value is [1, 100], inclusively.
	StepCount int32 `protobuf:"varint,1,opt,name=step_count,json=stepCount,proto3" json:"step_count,omitempty"`
	// Config for SmoothGrad approximation of gradients.
	//
	// When enabled, the gradients are approximated by averaging the gradients
	// from noisy samples in the vicinity of the inputs. Adding
	// noise can help improve the computed gradients. Refer to this paper for more
	// details: https://arxiv.org/pdf/1706.03825.pdf
	SmoothGradConfig *SmoothGradConfig `protobuf:"bytes,2,opt,name=smooth_grad_config,json=smoothGradConfig,proto3" json:"smooth_grad_config,omitempty"`
	// Config for XRAI with blur baseline.
	//
	// When enabled, a linear path from the maximally blurred image to the input
	// image is created. Using a blurred baseline instead of zero (black image) is
	// motivated by the BlurIG approach explained here:
	// https://arxiv.org/abs/2004.03383
	BlurBaselineConfig *BlurBaselineConfig `protobuf:"bytes,3,opt,name=blur_baseline_config,json=blurBaselineConfig,proto3" json:"blur_baseline_config,omitempty"`
	// contains filtered or unexported fields
}

An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825

Supported only by image Models.

func (*XraiAttribution) Descriptor deprecated

func (*XraiAttribution) Descriptor() ([]byte, []int)

Deprecated: Use XraiAttribution.ProtoReflect.Descriptor instead.

func (*XraiAttribution) GetBlurBaselineConfig

func (x *XraiAttribution) GetBlurBaselineConfig() *BlurBaselineConfig

func (*XraiAttribution) GetSmoothGradConfig

func (x *XraiAttribution) GetSmoothGradConfig() *SmoothGradConfig

func (*XraiAttribution) GetStepCount

func (x *XraiAttribution) GetStepCount() int32

func (*XraiAttribution) ProtoMessage

func (*XraiAttribution) ProtoMessage()

func (*XraiAttribution) ProtoReflect

func (x *XraiAttribution) ProtoReflect() protoreflect.Message

func (*XraiAttribution) Reset

func (x *XraiAttribution) Reset()

func (*XraiAttribution) String

func (x *XraiAttribution) String() string

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL