prod/accountsettingsmobile-pa-
dictionary_item_added
  • root['schemas']['CardsAlternative']['properties']['widescreenDeckKey']
values_changed
root['revision']
new_value20250724
old_value20250720
root['schemas']['CardsAlternative']['description']
new_valueA screen with tabs and cards. Used for Home, Personal info, etc. Next Id: 23
old_valueA screen with tabs and cards. Used for Home, Personal info, etc. Next Id: 22
prod/accountsettingsmobile-pa-v1
dictionary_item_added
  • root['schemas']['CardsAlternative']['properties']['widescreenDeckKey']
values_changed
root['revision']
new_value20250724
old_value20250720
root['schemas']['CardsAlternative']['description']
new_valueA screen with tabs and cards. Used for Home, Personal info, etc. Next Id: 23
old_valueA screen with tabs and cards. Used for Home, Personal info, etc. Next Id: 22
prod/aerialview-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/aerialview-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/aerialview-v1beta
values_changed
root['revision']
new_value20250723
old_value20250721
prod/aida-
values_changed
root['revision']
new_value20250724
old_value20250720
iterable_item_added
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][786]GEMINI_V4_GEMWEB_GA_DOCJOINS_TARZAN_CODE_V1
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][787]GEMINI_V4_GEMWEB_GA_DOCJOINS_LEETCODE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][788]GEMINI_V4_GITHUB_3_2_0_EVALED_LANGUAGES_HISTORY_REPOPATH_DEDUP
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][789]GEMINI_V4_GITHUB_3_2_0_HIGH_PRI_LANGUAGES_HISTORY_REPOPATH_DEDUP
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][790]GEMINI_V4_GITHUB_4_1_MULTI_FILE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][791]GEMINI_V4_GITHUB_MULTI_FILE_DIFFS_V1P3_EMBEDDING_DECONTAMINATED
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][792]GEMINI_V4_COMBINED_DEEPCRAWL_CODE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][793]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_10B_CUR_HIGH_QUALITY
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][794]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_10B_CUR_NORMAL_QUALITY
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][795]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_10B_RESIDUAL
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][796]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_20B_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][797]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_20B_NON_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][798]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_100B_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][799]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_100B_NON_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][800]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_130B_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][801]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_DEEPCRAWL_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][802]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_DEEPCRAWL_NON_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][803]GEMINI_V4_GEMWEB_GA_DOCJOINS_FORUM
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][804]GEMINI_V4_NOPUB_BOOKS_240615_EN_OCR_CONF_HIGH_YEAR_AFTER_1970
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][805]GEMINI_V4_NOPUB_BOOKS_240615_EN_OCR_CONF_HIGH_YEAR_BEFORE_1970_OR_MISSING
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][806]GEMINI_V4_NOPUB_BOOKS_240615_EN_OCR_CONF_MID_YEAR_AFTER_1970
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][807]GEMINI_V4_NOPUB_BOOKS_240615_EN_OCR_CONF_MID_YEAR_BEFORE_1970_OR_MISSING
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][808]GEMINI_V4_TAYLOR_FRANCIS
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][809]GEMINI_V4_REDDIT_TEXT_ONLY_2024_09_30
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][810]GEMINI_V4_SEARCH_QA_AUGMENTATION_MODE_QUERY_ONLY_EN
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][811]GEMINI_V4_PDF_DJ_ENG_NONSCI_TEXT
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][812]GEMINI_V4_GEMWEB_GA_DOCJOINS_STACKEXCHANGE_EN
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][813]GEMINI_V4_GEMWEB_GA_DOCJOINS_STACKEXCHANGE_I18N
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][814]GEMINI_V4_GEMWEB_GA_DOCJOINS_MATH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][815]GEMINI_V4_GEMWEB_GA_DOCJOINS_SCIENCE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][816]GEMINI_V4_STEM_BOOKS_318K_TEXT
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][817]GEMINI_V4_ARXIV_202404_V4P1P7
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][818]GEMINI_V4_YOUTUBE_CAPTION_SCIENCE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][819]GEMINI_V4_TARGETED_QUIZLET_0818
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][820]GEMINI_V4_CHESS_V5P1
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][821]GEMINI_V4_CHESS_UNDERSTANDING_V0
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][822]GEMINI_V4_PMC_OA_TEXT_ONLY
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][823]GEMINI_V4_TARGETED_DATA_MATH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][824]GEMINI_V4_TARGETED_DATA_MMLU
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][825]GEMINI_V4_TARGETED_DATA_FACTUALITYPLUSMMLU
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][826]GEMINI_V4_MAXALL_V3_COMPLIANT_GROUP_LAVC_MATH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][827]GEMINI_V4_MAXALL_V3_COMPLIANT_GROUP_LAVC_MMLU
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][828]GEMINI_V4_TARGETED_QA_REFRESH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][829]GEMINI_V4_PDF_DJ_ENG_SCI_TEXT
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][830]GEMINI_V4_PDF_FT_SCI_10K_TEXT
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][831]GEMINI_V4_PDF_FT_SCI_100K_TEXT
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][832]GEMINI_V4_PDF_DEEPCRAWL_SCI_TEXT
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][833]GEMINI_V4_TARGETED_DATA_BOOKS_AND_EPUBS_RESCUE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][834]GEMINI_V4_GEMWEB_GA_DOCJOINS_NONEN_10B_CUR_HIGH_QUALITY
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][835]GEMINI_V4_GEMWEB_GA_DOCJOINS_NONEN_10B_CUR_NORMAL_QUALITY
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][836]GEMINI_V4_I18N_TOP10B_RESIDUAL
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][837]GEMINI_V4_TARZAN_MULTILINGUAL_EDU_20B_100B_500B
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][838]GEMINI_V4_TARZAN_MULTILINGUAL_EDU_130B
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][839]GEMINI_V4_I18N_TOP20B_FILTERED
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][840]GEMINI_V4_18N_TOP100B_FILTERED
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][841]GEMINI_V4_WIKIPEDIA_DATA
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][842]GEMINI_V4_GIN_INDIC_DOCJOINS_ALLOWLIST_10B
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][843]GEMINI_V4_GIN_INDIC_DOCJOINS_ALLOWLIST_20B
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][844]GEMINI_V4_SANGRAHA_V2
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][845]GEMINI_V4_SEARCH_QA_AUGMENTATION_MODE_QUERY
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][846]GEMINI_V4_TRANSLATE_WEB_DOC_MW_AND_ADDITIONS
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][847]GEMINI_V4_TAGGED_PARALLEL_GECKO
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][848]GEMINI_V4_NTL_NTLV4A_MONO_V3S
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][849]GEMINI_V4_YOUTUBE_ACADEMIC_LEARNING
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][850]GEMINI_V4_YOUTUBE_CAPTION_QUALITY_TIER_HIGH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][851]GEMINI_V4_YOUTUBE_CAPTION_QUALITY_TIER_MEDIUM
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][852]GEMINI_V4_GEMVIS_GEMTUBE3
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][853]GEMINI_V4_GEMVIS_YT_SCIENCE_AUDIO
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][854]GEMINI_V4_GEMVIS_YT_ACADEMIC_QUALITY_HIGH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][855]GEMINI_V4_GEMVIS_YT_ACADEMIC_QUALITY_MEDIUM
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][856]GEMINI_V4_GEMVIS_INFORMATIVE_QUALITY_HIGH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][857]GEMINI_V4_GEMVIS_CREATOR_CHAPTERS
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][858]GEMINI_V4_GEMVIS_AUTO_CHAPTERS
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][859]GEMINI_V4_GEMVIS_PMC_OA_MM
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][860]GEMINI_V4_GEMVIS_GEMTUBE3_KNOWLEDGE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][861]GEMINI_V4_GEMVIS_GEMTUBE3_HOWTO
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][862]GEMINI_V4_GEMVIS_GEMTUBE3_SCIENCE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][863]GEMINI_V4_GEMVIS_TEXT_IMAGE_UNDERSTANDING
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][864]GEMINI_V4_GEMVIS_YT_METADATA
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][865]GEMINI_V4_GEMVIS_ACTION_MOMENTS
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][866]GEMINI_V4_TOKENV8P4_DIALOGUE_SEGMENT_SPEAKER
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][867]GEMINI_V4_GEMVIS_YT_SCI_TAB_DIALOGUE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][868]GEMINI_V4_GITHUB_3_4_0_NOTEBOOKS_DECONTAMINATED
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enumDescriptions'][786]Gemini V4 datasets.
prod/aida-v1
values_changed
root['revision']
new_value20250724
old_value20250720
iterable_item_added
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][786]GEMINI_V4_GEMWEB_GA_DOCJOINS_TARZAN_CODE_V1
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][787]GEMINI_V4_GEMWEB_GA_DOCJOINS_LEETCODE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][788]GEMINI_V4_GITHUB_3_2_0_EVALED_LANGUAGES_HISTORY_REPOPATH_DEDUP
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][789]GEMINI_V4_GITHUB_3_2_0_HIGH_PRI_LANGUAGES_HISTORY_REPOPATH_DEDUP
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][790]GEMINI_V4_GITHUB_4_1_MULTI_FILE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][791]GEMINI_V4_GITHUB_MULTI_FILE_DIFFS_V1P3_EMBEDDING_DECONTAMINATED
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][792]GEMINI_V4_COMBINED_DEEPCRAWL_CODE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][793]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_10B_CUR_HIGH_QUALITY
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][794]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_10B_CUR_NORMAL_QUALITY
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][795]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_10B_RESIDUAL
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][796]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_20B_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][797]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_20B_NON_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][798]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_100B_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][799]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_100B_NON_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][800]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_130B_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][801]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_DEEPCRAWL_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][802]GEMINI_V4_GEMWEB_GA_DOCJOINS_EN_DEEPCRAWL_NON_ARTICLE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][803]GEMINI_V4_GEMWEB_GA_DOCJOINS_FORUM
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][804]GEMINI_V4_NOPUB_BOOKS_240615_EN_OCR_CONF_HIGH_YEAR_AFTER_1970
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][805]GEMINI_V4_NOPUB_BOOKS_240615_EN_OCR_CONF_HIGH_YEAR_BEFORE_1970_OR_MISSING
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][806]GEMINI_V4_NOPUB_BOOKS_240615_EN_OCR_CONF_MID_YEAR_AFTER_1970
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][807]GEMINI_V4_NOPUB_BOOKS_240615_EN_OCR_CONF_MID_YEAR_BEFORE_1970_OR_MISSING
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][808]GEMINI_V4_TAYLOR_FRANCIS
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][809]GEMINI_V4_REDDIT_TEXT_ONLY_2024_09_30
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][810]GEMINI_V4_SEARCH_QA_AUGMENTATION_MODE_QUERY_ONLY_EN
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][811]GEMINI_V4_PDF_DJ_ENG_NONSCI_TEXT
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][812]GEMINI_V4_GEMWEB_GA_DOCJOINS_STACKEXCHANGE_EN
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][813]GEMINI_V4_GEMWEB_GA_DOCJOINS_STACKEXCHANGE_I18N
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][814]GEMINI_V4_GEMWEB_GA_DOCJOINS_MATH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][815]GEMINI_V4_GEMWEB_GA_DOCJOINS_SCIENCE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][816]GEMINI_V4_STEM_BOOKS_318K_TEXT
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][817]GEMINI_V4_ARXIV_202404_V4P1P7
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][818]GEMINI_V4_YOUTUBE_CAPTION_SCIENCE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][819]GEMINI_V4_TARGETED_QUIZLET_0818
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][820]GEMINI_V4_CHESS_V5P1
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][821]GEMINI_V4_CHESS_UNDERSTANDING_V0
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][822]GEMINI_V4_PMC_OA_TEXT_ONLY
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][823]GEMINI_V4_TARGETED_DATA_MATH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][824]GEMINI_V4_TARGETED_DATA_MMLU
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][825]GEMINI_V4_TARGETED_DATA_FACTUALITYPLUSMMLU
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][826]GEMINI_V4_MAXALL_V3_COMPLIANT_GROUP_LAVC_MATH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][827]GEMINI_V4_MAXALL_V3_COMPLIANT_GROUP_LAVC_MMLU
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][828]GEMINI_V4_TARGETED_QA_REFRESH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][829]GEMINI_V4_PDF_DJ_ENG_SCI_TEXT
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][830]GEMINI_V4_PDF_FT_SCI_10K_TEXT
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][831]GEMINI_V4_PDF_FT_SCI_100K_TEXT
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][832]GEMINI_V4_PDF_DEEPCRAWL_SCI_TEXT
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][833]GEMINI_V4_TARGETED_DATA_BOOKS_AND_EPUBS_RESCUE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][834]GEMINI_V4_GEMWEB_GA_DOCJOINS_NONEN_10B_CUR_HIGH_QUALITY
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][835]GEMINI_V4_GEMWEB_GA_DOCJOINS_NONEN_10B_CUR_NORMAL_QUALITY
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][836]GEMINI_V4_I18N_TOP10B_RESIDUAL
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][837]GEMINI_V4_TARZAN_MULTILINGUAL_EDU_20B_100B_500B
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][838]GEMINI_V4_TARZAN_MULTILINGUAL_EDU_130B
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][839]GEMINI_V4_I18N_TOP20B_FILTERED
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][840]GEMINI_V4_18N_TOP100B_FILTERED
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][841]GEMINI_V4_WIKIPEDIA_DATA
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][842]GEMINI_V4_GIN_INDIC_DOCJOINS_ALLOWLIST_10B
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][843]GEMINI_V4_GIN_INDIC_DOCJOINS_ALLOWLIST_20B
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][844]GEMINI_V4_SANGRAHA_V2
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][845]GEMINI_V4_SEARCH_QA_AUGMENTATION_MODE_QUERY
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][846]GEMINI_V4_TRANSLATE_WEB_DOC_MW_AND_ADDITIONS
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][847]GEMINI_V4_TAGGED_PARALLEL_GECKO
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][848]GEMINI_V4_NTL_NTLV4A_MONO_V3S
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][849]GEMINI_V4_YOUTUBE_ACADEMIC_LEARNING
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][850]GEMINI_V4_YOUTUBE_CAPTION_QUALITY_TIER_HIGH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][851]GEMINI_V4_YOUTUBE_CAPTION_QUALITY_TIER_MEDIUM
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][852]GEMINI_V4_GEMVIS_GEMTUBE3
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][853]GEMINI_V4_GEMVIS_YT_SCIENCE_AUDIO
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][854]GEMINI_V4_GEMVIS_YT_ACADEMIC_QUALITY_HIGH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][855]GEMINI_V4_GEMVIS_YT_ACADEMIC_QUALITY_MEDIUM
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][856]GEMINI_V4_GEMVIS_INFORMATIVE_QUALITY_HIGH
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][857]GEMINI_V4_GEMVIS_CREATOR_CHAPTERS
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][858]GEMINI_V4_GEMVIS_AUTO_CHAPTERS
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][859]GEMINI_V4_GEMVIS_PMC_OA_MM
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][860]GEMINI_V4_GEMVIS_GEMTUBE3_KNOWLEDGE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][861]GEMINI_V4_GEMVIS_GEMTUBE3_HOWTO
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][862]GEMINI_V4_GEMVIS_GEMTUBE3_SCIENCE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][863]GEMINI_V4_GEMVIS_TEXT_IMAGE_UNDERSTANDING
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][864]GEMINI_V4_GEMVIS_YT_METADATA
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][865]GEMINI_V4_GEMVIS_ACTION_MOMENTS
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][866]GEMINI_V4_TOKENV8P4_DIALOGUE_SEGMENT_SPEAKER
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][867]GEMINI_V4_GEMVIS_YT_SCI_TAB_DIALOGUE
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enum'][868]GEMINI_V4_GITHUB_3_4_0_NOTEBOOKS_DECONTAMINATED
root['schemas']['GoogleXPitchforkAidaV1GenerationSampleMetadataAttributionMetadataCitation']['properties']['dataset']['enumDescriptions'][786]Gemini V4 datasets.
prod/aiui-
values_changed
root['revision']
new_value20250724
old_value20250721
prod/aiui-v1
values_changed
root['revision']
new_value20250724
old_value20250721
prod/alpha-ml-
values_changed
root['revision']
new_value20250724
old_value20250717
prod/alpha-ml-v1
values_changed
root['revision']
new_value20250724
old_value20250717
prod/alpha-mlengine-pa-
values_changed
root['revision']
new_value20250724
old_value20250717
prod/alpha-mlengine-pa-v1
values_changed
root['revision']
new_value20250724
old_value20250717
prod/alpha-vision-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/alpha-vision-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/alpha-vision-v1p1beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/alpha-vision-v1p2beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/alpha-vision-v1p3beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/alpha-vision-v1p4beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/analyticssuitefrontend-pa-
values_changed
root['revision']
new_value20250724
old_value20250722
iterable_item_added
root['schemas']['NodeAccess']['properties']['callerAccessActions']['items']['enum'][62]READ_DATA_SOURCE_ASSOCIATIONS
root['schemas']['NodeAccess']['properties']['callerAccessActions']['items']['enum'][63]UPDATE_DATA_SOURCE_ASSOCIATIONS
root['schemas']['NodeAccess']['properties']['callerAccessActions']['items']['enumDescriptions'][62]Allows reading data source associations data This is an action because the data is stored outside of GACS entities go/ga-shadow-customer-auth
root['schemas']['NodeAccess']['properties']['callerAccessActions']['items']['enumDescriptions'][63]Allows updating data source associations data This is an action because the data is stored outside of GACS entities go/ga-shadow-customer-auth
root['schemas']['Permission']['properties']['entityAction']['enum'][62]READ_DATA_SOURCE_ASSOCIATIONS
root['schemas']['Permission']['properties']['entityAction']['enum'][63]UPDATE_DATA_SOURCE_ASSOCIATIONS
root['schemas']['Permission']['properties']['entityAction']['enumDescriptions'][62]Allows reading data source associations data This is an action because the data is stored outside of GACS entities go/ga-shadow-customer-auth
root['schemas']['Permission']['properties']['entityAction']['enumDescriptions'][63]Allows updating data source associations data This is an action because the data is stored outside of GACS entities go/ga-shadow-customer-auth
prod/analyticssuitefrontend-pa-v1
values_changed
root['revision']
new_value20250724
old_value20250722
iterable_item_added
root['schemas']['NodeAccess']['properties']['callerAccessActions']['items']['enum'][62]READ_DATA_SOURCE_ASSOCIATIONS
root['schemas']['NodeAccess']['properties']['callerAccessActions']['items']['enum'][63]UPDATE_DATA_SOURCE_ASSOCIATIONS
root['schemas']['NodeAccess']['properties']['callerAccessActions']['items']['enumDescriptions'][62]Allows reading data source associations data This is an action because the data is stored outside of GACS entities go/ga-shadow-customer-auth
root['schemas']['NodeAccess']['properties']['callerAccessActions']['items']['enumDescriptions'][63]Allows updating data source associations data This is an action because the data is stored outside of GACS entities go/ga-shadow-customer-auth
root['schemas']['Permission']['properties']['entityAction']['enum'][62]READ_DATA_SOURCE_ASSOCIATIONS
root['schemas']['Permission']['properties']['entityAction']['enum'][63]UPDATE_DATA_SOURCE_ASSOCIATIONS
root['schemas']['Permission']['properties']['entityAction']['enumDescriptions'][62]Allows reading data source associations data This is an action because the data is stored outside of GACS entities go/ga-shadow-customer-auth
root['schemas']['Permission']['properties']['entityAction']['enumDescriptions'][63]Allows updating data source associations data This is an action because the data is stored outside of GACS entities go/ga-shadow-customer-auth
prod/ap-rbmopenmaap-
values_changed
root['revision']
new_value20250724
old_value20250721
prod/ap-rbmopenmaap-v1
values_changed
root['revision']
new_value20250724
old_value20250721
prod/appoptimize-
values_changed
root['revision']
new_value20250716
old_value20250709
prod/appoptimize-v1alpha
values_changed
root['revision']
new_value20250716
old_value20250709
prod/appsbackup-pa-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/appsbackup-pa-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/arcore-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/arcore-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/arcore-v1beta2
values_changed
root['revision']
new_value20250723
old_value20250721
prod/arcorecloudanchor-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/arcorecloudanchor-v1beta2
values_changed
root['revision']
new_value20250723
old_value20250721
prod/asia-east1-connectgateway-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/asia-east1-connectgateway-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/asia-east1-connectgateway-v1beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/asia-east1-containerfilesystem-
values_changed
root['revision']
new_value20250719
old_value20250714
prod/asia-east1-containerfilesystem-v1
values_changed
root['revision']
new_value20250719
old_value20250714
prod/asia-south1-containerfilesystem-
values_changed
root['revision']
new_value20250719
old_value20250714
prod/asia-south1-containerfilesystem-v1
values_changed
root['revision']
new_value20250719
old_value20250714
prod/asia-southeast1-connectgateway-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/asia-southeast1-connectgateway-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/asia-southeast1-connectgateway-v1beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/asia-southeast1-containerfilesystem-
values_changed
root['revision']
new_value20250719
old_value20250714
prod/asia-southeast1-containerfilesystem-v1
values_changed
root['revision']
new_value20250719
old_value20250714
prod/assistant-s3-pa-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/assistant-s3-pa-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/assistant-s3-pa-v1alpha2
values_changed
root['revision']
new_value20250723
old_value20250721
prod/assistant-s3-pa-v1beta1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/assistantfrontend-pa-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/assistantfrontend-pa-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/assistantfrontend-pa-v1alpha2
values_changed
root['revision']
new_value20250723
old_value20250721
prod/assistantfrontend-pa-v1beta1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/autofill-
values_changed
root['revision']
new_value20250723
old_value20250721
iterable_item_added
root['schemas']['FieldPrediction']['properties']['source']['enum'][11]SOURCE_STRUCTURAL_FORM_SIGNATURE
root['schemas']['FieldPrediction']['properties']['source']['enum'][12]SOURCE_STRUCTURAL_FORM_SIGNATURE_WITH_FIELD_RANKS
root['schemas']['FieldPrediction']['properties']['source']['enumDescriptions'][11]The prediction came from the experiment which aggregates votes by the structural form signature (go/autofill-stable-form-signature).
root['schemas']['FieldPrediction']['properties']['source']['enumDescriptions'][12]The prediction came from the experiment which aggregates votes by the structural form signature (same as above) + ranks.
prod/autofill-v1
values_changed
root['revision']
new_value20250723
old_value20250721
iterable_item_added
root['schemas']['FieldPrediction']['properties']['source']['enum'][11]SOURCE_STRUCTURAL_FORM_SIGNATURE
root['schemas']['FieldPrediction']['properties']['source']['enum'][12]SOURCE_STRUCTURAL_FORM_SIGNATURE_WITH_FIELD_RANKS
root['schemas']['FieldPrediction']['properties']['source']['enumDescriptions'][11]The prediction came from the experiment which aggregates votes by the structural form signature (go/autofill-stable-form-signature).
root['schemas']['FieldPrediction']['properties']['source']['enumDescriptions'][12]The prediction came from the experiment which aggregates votes by the structural form signature (same as above) + ranks.
prod/autopush-notifications-pa.sandbox-
dictionary_item_added
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__IntraAccountSharingEventData']
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['intraAccountSharingEventData']
values_changed
root['revision']
new_value20250725
old_value20250723
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['description']
new_valueEvent sent by google native flows. Next id: 5
old_valueEvent sent by google native flows. Next id: 4
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][35]
new_valueStudio looks relighting effect adjusted by a GLDM diffusion model.
old_valueStudio looks relighting effect adjusted by a GLDM diffusion model. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][24]PIX_CLIPBOARD_DETECTION
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][36]CHANGE_CLOTHES
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][36]Change the clothes of the subject to a new clothes described by the text. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enum'][5]NATIVE_EVENT_TYPE_INTRA_ACCOUNT_SHARING
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enumDescriptions'][5]Intra-account sharing event.
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][18]NAME_ACCENTRA
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][19]NAME_PANASONIC
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][20]NAME_SAFETRUST
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][21]NAME_SPINTLY
iterable_item_removed
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][4]NAME_GOOGLE_FAKE
prod/autopush-notifications-pa.sandbox-v1
dictionary_item_added
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__IntraAccountSharingEventData']
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['intraAccountSharingEventData']
values_changed
root['revision']
new_value20250725
old_value20250723
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['description']
new_valueEvent sent by google native flows. Next id: 5
old_valueEvent sent by google native flows. Next id: 4
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][35]
new_valueStudio looks relighting effect adjusted by a GLDM diffusion model.
old_valueStudio looks relighting effect adjusted by a GLDM diffusion model. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][24]PIX_CLIPBOARD_DETECTION
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][36]CHANGE_CLOTHES
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][36]Change the clothes of the subject to a new clothes described by the text. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enum'][5]NATIVE_EVENT_TYPE_INTRA_ACCOUNT_SHARING
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enumDescriptions'][5]Intra-account sharing event.
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][18]NAME_ACCENTRA
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][19]NAME_PANASONIC
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][20]NAME_SAFETRUST
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][21]NAME_SPINTLY
iterable_item_removed
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][4]NAME_GOOGLE_FAKE
prod/autopush-proddata-notifications-pa.sandbox-
dictionary_item_added
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__IntraAccountSharingEventData']
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['intraAccountSharingEventData']
values_changed
root['revision']
new_value20250725
old_value20250723
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['description']
new_valueEvent sent by google native flows. Next id: 5
old_valueEvent sent by google native flows. Next id: 4
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][35]
new_valueStudio looks relighting effect adjusted by a GLDM diffusion model.
old_valueStudio looks relighting effect adjusted by a GLDM diffusion model. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][24]PIX_CLIPBOARD_DETECTION
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][36]CHANGE_CLOTHES
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][36]Change the clothes of the subject to a new clothes described by the text. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enum'][5]NATIVE_EVENT_TYPE_INTRA_ACCOUNT_SHARING
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enumDescriptions'][5]Intra-account sharing event.
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][18]NAME_ACCENTRA
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][19]NAME_PANASONIC
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][20]NAME_SAFETRUST
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][21]NAME_SPINTLY
iterable_item_removed
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][4]NAME_GOOGLE_FAKE
prod/autopush-proddata-notifications-pa.sandbox-v1
dictionary_item_added
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__IntraAccountSharingEventData']
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['intraAccountSharingEventData']
values_changed
root['revision']
new_value20250725
old_value20250723
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['description']
new_valueEvent sent by google native flows. Next id: 5
old_valueEvent sent by google native flows. Next id: 4
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][35]
new_valueStudio looks relighting effect adjusted by a GLDM diffusion model.
old_valueStudio looks relighting effect adjusted by a GLDM diffusion model. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][24]PIX_CLIPBOARD_DETECTION
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][36]CHANGE_CLOTHES
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][36]Change the clothes of the subject to a new clothes described by the text. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enum'][5]NATIVE_EVENT_TYPE_INTRA_ACCOUNT_SHARING
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enumDescriptions'][5]Intra-account sharing event.
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][18]NAME_ACCENTRA
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][19]NAME_PANASONIC
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][20]NAME_SAFETRUST
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][21]NAME_SPINTLY
iterable_item_removed
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][4]NAME_GOOGLE_FAKE
prod/autopush-qual-playground-notifications-pa.sandbox-
dictionary_item_added
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__IntraAccountSharingEventData']
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['intraAccountSharingEventData']
values_changed
root['revision']
new_value20250725
old_value20250723
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['description']
new_valueEvent sent by google native flows. Next id: 5
old_valueEvent sent by google native flows. Next id: 4
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][35]
new_valueStudio looks relighting effect adjusted by a GLDM diffusion model.
old_valueStudio looks relighting effect adjusted by a GLDM diffusion model. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][24]PIX_CLIPBOARD_DETECTION
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][36]CHANGE_CLOTHES
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][36]Change the clothes of the subject to a new clothes described by the text. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enum'][5]NATIVE_EVENT_TYPE_INTRA_ACCOUNT_SHARING
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enumDescriptions'][5]Intra-account sharing event.
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][18]NAME_ACCENTRA
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][19]NAME_PANASONIC
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][20]NAME_SAFETRUST
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][21]NAME_SPINTLY
iterable_item_removed
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][4]NAME_GOOGLE_FAKE
prod/autopush-qual-playground-notifications-pa.sandbox-v1
dictionary_item_added
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__IntraAccountSharingEventData']
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['intraAccountSharingEventData']
values_changed
root['revision']
new_value20250725
old_value20250723
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['description']
new_valueEvent sent by google native flows. Next id: 5
old_valueEvent sent by google native flows. Next id: 4
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][35]
new_valueStudio looks relighting effect adjusted by a GLDM diffusion model.
old_valueStudio looks relighting effect adjusted by a GLDM diffusion model. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][24]PIX_CLIPBOARD_DETECTION
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][36]CHANGE_CLOTHES
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][36]Change the clothes of the subject to a new clothes described by the text. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enum'][5]NATIVE_EVENT_TYPE_INTRA_ACCOUNT_SHARING
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enumDescriptions'][5]Intra-account sharing event.
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][18]NAME_ACCENTRA
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][19]NAME_PANASONIC
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][20]NAME_SAFETRUST
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][21]NAME_SPINTLY
iterable_item_removed
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][4]NAME_GOOGLE_FAKE
prod/blobcomments-pa-
values_changed
root['revision']
new_value20250717
old_value20250709
prod/blobcomments-pa-v1
values_changed
root['revision']
new_value20250717
old_value20250709
prod/capacityplanner-
values_changed
root['revision']
new_value20250720
old_value20250711
prod/capacityplanner-v1alpha
values_changed
root['revision']
new_value20250720
old_value20250711
prod/carddav-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/carddav-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/chromedevicetoken-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/chromedevicetoken-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/cloud-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/cloud-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/cloudaicompanion-
values_changed
root['revision']
new_value20250720
old_value20250713
prod/cloudaicompanion-v1
values_changed
root['revision']
new_value20250720
old_value20250713
prod/cloudaicompanion-v1alpha
values_changed
root['revision']
new_value20250720
old_value20250713
prod/cloudaicompanion-v1beta
values_changed
root['revision']
new_value20250720
old_value20250713
prod/cloudcommerceconsumerprocurement-
values_changed
root['revision']
new_value20250722
old_value20250713
prod/cloudcommerceconsumerprocurement-v1
values_changed
root['revision']
new_value20250722
old_value20250713
prod/cloudcommerceconsumerprocurement-v1alpha1
values_changed
root['revision']
new_value20250722
old_value20250713
prod/cloudcommerceproducer-
dictionary_item_added
  • root['schemas']['GoogleCloudCommerceProducerV1alpha1TerraformKubernetesAppTerraformKubernetesAppVersionIamRequirements']
  • root['schemas']['GoogleCloudCommerceProducerV1alpha1TerraformKubernetesAppTerraformKubernetesAppVersion']['properties']['iamRequirements']
values_changed
root['revision']
new_value20250720
old_value20250713
prod/cloudcommerceproducer-v1alpha1
dictionary_item_added
  • root['schemas']['GoogleCloudCommerceProducerV1alpha1TerraformKubernetesAppTerraformKubernetesAppVersionIamRequirements']
  • root['schemas']['GoogleCloudCommerceProducerV1alpha1TerraformKubernetesAppTerraformKubernetesAppVersion']['properties']['iamRequirements']
values_changed
root['revision']
new_value20250720
old_value20250713
prod/cloudmarketplace-
dictionary_item_added
  • root['schemas']['GooglePayWebPlaidLinkingConsentChangeTextDetails']
  • root['schemas']['LabsFoundryTextDetails']
  • root['schemas']['DataAccessReason']['properties']['ottTaskId']
  • root['schemas']['TextDetails']['properties']['googlePayWebPlaidLinkingConsentChangeTextDetails']
  • root['schemas']['TextDetails']['properties']['labsFoundryTextDetails']
values_changed
root['revision']
new_value20250719
old_value20250607
root['schemas']['TextDetails']['description']
new_valueNext Id: 83
old_valueNext Id: 81
iterable_item_added
root['schemas']['UiContext']['properties']['contextId']['enum'][489]GOOGLE_LEVEL_VOICE_MATCH_ANDROID
root['schemas']['UiContext']['properties']['contextId']['enum'][490]GOOGLE_LEVEL_VOICE_MATCH_IOS
root['schemas']['UiContext']['properties']['contextId']['enum'][586]GOOGLE_PAY_WEB_PLAID_LINKING_CONSENT_DIALOG
root['schemas']['UiContext']['properties']['contextId']['enum'][592]LABS_FOUNDRY_WEB_TOS_ACCEPTED
root['schemas']['UiContext']['properties']['contextId']['enum'][672]MOBILE_CONSENT_FLOWS_ANDROID_SI_TRANSIT_SETUP
root['schemas']['UiContext']['properties']['contextId']['enum'][940]TEASPOON_ANDROID_ONBOARDING_FLOW
root['schemas']['UiContext']['properties']['contextId']['enum'][941]TEASPOON_ANDROID_EDITOR_FLOW
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][489]User is interacting with the Google Level Voice Match settings on Android.
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][490]User is interacting with the Google Level Voice Match settings on iOS.
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][586]Google Pay UI shown when acknowledging the plaid linking terms and conditions.
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][592]User has accepted the Foundry Terms of Service.
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][672]Location history consent screen during transit settings onboarding.
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][940]User is shown the consent during onboarding flow for Teaspoon.
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][941]User is shown the consent during editor flow for Teaspoon.
iterable_item_removed
root['schemas']['UiContext']['properties']['contextId']['enum'][668]MOBILE_CONSENT_FLOWS_ANDROID_SI_MYCOMMUTE_SETUP
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][668]Location history consent screen during mycommute settings onboarding.
prod/cloudmarketplace-v1test
dictionary_item_added
  • root['schemas']['GooglePayWebPlaidLinkingConsentChangeTextDetails']
  • root['schemas']['LabsFoundryTextDetails']
  • root['schemas']['DataAccessReason']['properties']['ottTaskId']
  • root['schemas']['TextDetails']['properties']['googlePayWebPlaidLinkingConsentChangeTextDetails']
  • root['schemas']['TextDetails']['properties']['labsFoundryTextDetails']
values_changed
root['revision']
new_value20250719
old_value20250607
root['schemas']['TextDetails']['description']
new_valueNext Id: 83
old_valueNext Id: 81
iterable_item_added
root['schemas']['UiContext']['properties']['contextId']['enum'][489]GOOGLE_LEVEL_VOICE_MATCH_ANDROID
root['schemas']['UiContext']['properties']['contextId']['enum'][490]GOOGLE_LEVEL_VOICE_MATCH_IOS
root['schemas']['UiContext']['properties']['contextId']['enum'][586]GOOGLE_PAY_WEB_PLAID_LINKING_CONSENT_DIALOG
root['schemas']['UiContext']['properties']['contextId']['enum'][592]LABS_FOUNDRY_WEB_TOS_ACCEPTED
root['schemas']['UiContext']['properties']['contextId']['enum'][672]MOBILE_CONSENT_FLOWS_ANDROID_SI_TRANSIT_SETUP
root['schemas']['UiContext']['properties']['contextId']['enum'][940]TEASPOON_ANDROID_ONBOARDING_FLOW
root['schemas']['UiContext']['properties']['contextId']['enum'][941]TEASPOON_ANDROID_EDITOR_FLOW
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][489]User is interacting with the Google Level Voice Match settings on Android.
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][490]User is interacting with the Google Level Voice Match settings on iOS.
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][586]Google Pay UI shown when acknowledging the plaid linking terms and conditions.
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][592]User has accepted the Foundry Terms of Service.
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][672]Location history consent screen during transit settings onboarding.
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][940]User is shown the consent during onboarding flow for Teaspoon.
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][941]User is shown the consent during editor flow for Teaspoon.
iterable_item_removed
root['schemas']['UiContext']['properties']['contextId']['enum'][668]MOBILE_CONSENT_FLOWS_ANDROID_SI_MYCOMMUTE_SETUP
root['schemas']['UiContext']['properties']['contextId']['enumDescriptions'][668]Location history consent screen during mycommute settings onboarding.
prod/cloudmarketplaceadmin-
values_changed
root['revision']
new_value20250719
old_value20250607
prod/cloudmarketplaceadmin-v1test
values_changed
root['revision']
new_value20250719
old_value20250607
prod/cloudmarketplacepartner-
values_changed
root['revision']
new_value20250719
old_value20250607
prod/cloudmarketplacepartner-v2test
values_changed
root['revision']
new_value20250719
old_value20250607
prod/cloudsupportinfra-
values_changed
root['revision']
new_value20250723
old_value20250708
prod/cloudsupportinfra-v1
values_changed
root['revision']
new_value20250723
old_value20250708
prod/cloudsupportinfra-v1alpha1
values_changed
root['revision']
new_value20250723
old_value20250708
prod/cloudusersettings-pa-
dictionary_item_added
  • root['schemas']['CloudusersettingsPaVisitedPage']
  • root['schemas']['CloudusersettingsPaVisitedPages']
values_changed
root['revision']
new_value20250717
old_value20250710
prod/cloudusersettings-pa-v1alpha1
dictionary_item_added
  • root['schemas']['CloudusersettingsPaVisitedPage']
  • root['schemas']['CloudusersettingsPaVisitedPages']
values_changed
root['revision']
new_value20250717
old_value20250710
prod/cloudvideosearch-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/cloudvideosearch-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/commerceorggovernance-
values_changed
root['revision']
new_value20250720
old_value20250427
prod/commerceorggovernance-v1alpha1
values_changed
root['revision']
new_value20250720
old_value20250427
prod/confidentialcomputing-
values_changed
root['revision']
new_value20250716
old_value20250708
prod/confidentialcomputing-v1
values_changed
root['revision']
new_value20250716
old_value20250708
prod/confidentialcomputing-v1alpha1
values_changed
root['revision']
new_value20250716
old_value20250708
prod/confidentialcomputing-v1main
values_changed
root['revision']
new_value20250716
old_value20250708
prod/content-autofill-
values_changed
root['revision']
new_value20250723
old_value20250721
iterable_item_added
root['schemas']['FieldPrediction']['properties']['source']['enum'][11]SOURCE_STRUCTURAL_FORM_SIGNATURE
root['schemas']['FieldPrediction']['properties']['source']['enum'][12]SOURCE_STRUCTURAL_FORM_SIGNATURE_WITH_FIELD_RANKS
root['schemas']['FieldPrediction']['properties']['source']['enumDescriptions'][11]The prediction came from the experiment which aggregates votes by the structural form signature (go/autofill-stable-form-signature).
root['schemas']['FieldPrediction']['properties']['source']['enumDescriptions'][12]The prediction came from the experiment which aggregates votes by the structural form signature (same as above) + ranks.
prod/content-autofill-v1
values_changed
root['revision']
new_value20250723
old_value20250721
iterable_item_added
root['schemas']['FieldPrediction']['properties']['source']['enum'][11]SOURCE_STRUCTURAL_FORM_SIGNATURE
root['schemas']['FieldPrediction']['properties']['source']['enum'][12]SOURCE_STRUCTURAL_FORM_SIGNATURE_WITH_FIELD_RANKS
root['schemas']['FieldPrediction']['properties']['source']['enumDescriptions'][11]The prediction came from the experiment which aggregates votes by the structural form signature (go/autofill-stable-form-signature).
root['schemas']['FieldPrediction']['properties']['source']['enumDescriptions'][12]The prediction came from the experiment which aggregates votes by the structural form signature (same as above) + ranks.
prod/content-cloud-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/content-cloud-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/content-cloudusersettings-pa-
dictionary_item_added
  • root['schemas']['CloudusersettingsPaVisitedPage']
  • root['schemas']['CloudusersettingsPaVisitedPages']
values_changed
root['revision']
new_value20250717
old_value20250710
prod/content-cloudusersettings-pa-v1alpha1
dictionary_item_added
  • root['schemas']['CloudusersettingsPaVisitedPage']
  • root['schemas']['CloudusersettingsPaVisitedPages']
values_changed
root['revision']
new_value20250717
old_value20250710
prod/content-daily-cloudsearch-
values_changed
root['revision']
new_value20250725
old_value20250722
prod/content-daily-cloudsearch-v1
values_changed
root['revision']
new_value20250725
old_value20250722
prod/content-fit-
values_changed
root['revision']
new_value20250723
old_value20250720
prod/content-fit-v2beta1
values_changed
root['revision']
new_value20250724
old_value20250720
prod/content-quantum-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/content-quantum-v1alpha1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/contentmanager-
values_changed
root['revision']
new_value20250723
old_value20250720
iterable_item_added
root['schemas']['FieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['FieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['FieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['FieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['FieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['FieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][1159]b/425764480
root['schemas']['FieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['FieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['FieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['FieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['FieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['FieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][1159]b/425764480
root['schemas']['FrdDisabled']['properties']['disabledFrdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['FrdDisabled']['properties']['disabledFrdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['FrdDisabled']['properties']['disabledFrdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['FrdDisabled']['properties']['disabledFrdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['FrdDisabled']['properties']['disabledFrdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['FrdDisabled']['properties']['disabledFrdIdentifier']['enumDescriptions'][1159]b/425764480
root['schemas']['FrdSemanticTypeUndefined']['properties']['undefinedSemanticType']['enum'][65]SEMANTIC_TYPE_ADS_TARGET_AUDIENCE
root['schemas']['FrdSemanticTypeUndefined']['properties']['undefinedSemanticType']['enum'][512]SEMANTIC_TYPE_INACCURATE_IMAGERY_ISSUE
root['schemas']['FrdSemanticTypeUndefined']['properties']['undefinedSemanticType']['enum'][914]SEMANTIC_TYPE_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['FrdSemanticTypeUndefined']['properties']['undefinedSemanticType']['enumDescriptions'][65]b/427800806
root['schemas']['FrdSemanticTypeUndefined']['properties']['undefinedSemanticType']['enumDescriptions'][512]b/430034055
root['schemas']['FrdSemanticTypeUndefined']['properties']['undefinedSemanticType']['enumDescriptions'][914]b/425764480
root['schemas']['FrdUndefined']['properties']['undefinedFrdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['FrdUndefined']['properties']['undefinedFrdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['FrdUndefined']['properties']['undefinedFrdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['FrdUndefined']['properties']['undefinedFrdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['FrdUndefined']['properties']['undefinedFrdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['FrdUndefined']['properties']['undefinedFrdIdentifier']['enumDescriptions'][1159]b/425764480
root['schemas']['GetAvailableFrdValuesRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['GetAvailableFrdValuesRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['GetAvailableFrdValuesRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['GetAvailableFrdValuesRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][86]b/427800806
root['schemas']['GetAvailableFrdValuesRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][663]b/430034055
root['schemas']['GetAvailableFrdValuesRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][1159]b/425764480
root['schemas']['WorkflowClassValueTypeDescriptor']['properties']['sourceFrd']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['WorkflowClassValueTypeDescriptor']['properties']['sourceFrd']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['WorkflowClassValueTypeDescriptor']['properties']['sourceFrd']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['WorkflowClassValueTypeDescriptor']['properties']['sourceFrd']['enumDescriptions'][86]b/427800806
root['schemas']['WorkflowClassValueTypeDescriptor']['properties']['sourceFrd']['enumDescriptions'][663]b/430034055
root['schemas']['WorkflowClassValueTypeDescriptor']['properties']['sourceFrd']['enumDescriptions'][1159]b/425764480
prod/contentmanager-v1
values_changed
root['revision']
new_value20250723
old_value20250720
iterable_item_added
root['schemas']['FieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['FieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['FieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['FieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['FieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['FieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][1159]b/425764480
root['schemas']['FieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['FieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['FieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['FieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['FieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['FieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][1159]b/425764480
root['schemas']['FrdDisabled']['properties']['disabledFrdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['FrdDisabled']['properties']['disabledFrdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['FrdDisabled']['properties']['disabledFrdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['FrdDisabled']['properties']['disabledFrdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['FrdDisabled']['properties']['disabledFrdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['FrdDisabled']['properties']['disabledFrdIdentifier']['enumDescriptions'][1159]b/425764480
root['schemas']['FrdSemanticTypeUndefined']['properties']['undefinedSemanticType']['enum'][65]SEMANTIC_TYPE_ADS_TARGET_AUDIENCE
root['schemas']['FrdSemanticTypeUndefined']['properties']['undefinedSemanticType']['enum'][512]SEMANTIC_TYPE_INACCURATE_IMAGERY_ISSUE
root['schemas']['FrdSemanticTypeUndefined']['properties']['undefinedSemanticType']['enum'][914]SEMANTIC_TYPE_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['FrdSemanticTypeUndefined']['properties']['undefinedSemanticType']['enumDescriptions'][65]b/427800806
root['schemas']['FrdSemanticTypeUndefined']['properties']['undefinedSemanticType']['enumDescriptions'][512]b/430034055
root['schemas']['FrdSemanticTypeUndefined']['properties']['undefinedSemanticType']['enumDescriptions'][914]b/425764480
root['schemas']['FrdUndefined']['properties']['undefinedFrdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['FrdUndefined']['properties']['undefinedFrdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['FrdUndefined']['properties']['undefinedFrdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['FrdUndefined']['properties']['undefinedFrdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['FrdUndefined']['properties']['undefinedFrdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['FrdUndefined']['properties']['undefinedFrdIdentifier']['enumDescriptions'][1159]b/425764480
root['schemas']['GetAvailableFrdValuesRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['GetAvailableFrdValuesRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['GetAvailableFrdValuesRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['GetAvailableFrdValuesRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][86]b/427800806
root['schemas']['GetAvailableFrdValuesRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][663]b/430034055
root['schemas']['GetAvailableFrdValuesRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][1159]b/425764480
root['schemas']['WorkflowClassValueTypeDescriptor']['properties']['sourceFrd']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['WorkflowClassValueTypeDescriptor']['properties']['sourceFrd']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['WorkflowClassValueTypeDescriptor']['properties']['sourceFrd']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['WorkflowClassValueTypeDescriptor']['properties']['sourceFrd']['enumDescriptions'][86]b/427800806
root['schemas']['WorkflowClassValueTypeDescriptor']['properties']['sourceFrd']['enumDescriptions'][663]b/430034055
root['schemas']['WorkflowClassValueTypeDescriptor']['properties']['sourceFrd']['enumDescriptions'][1159]b/425764480
prod/contrails-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/contrails-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/contrails-v2
values_changed
root['revision']
new_value20250723
old_value20250721
prod/corplearning-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/corplearning-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/cryptauthdevicesync-
values_changed
root['revision']
new_value20250720
old_value20250706
prod/cryptauthdevicesync-v1
values_changed
root['revision']
new_value20250720
old_value20250706
prod/daily-cloudsearch-
values_changed
root['revision']
new_value20250725
old_value20250722
prod/daily-cloudsearch-v1
values_changed
root['revision']
new_value20250725
old_value20250722
prod/daily-dynamicmail-pa.sandbox-
values_changed
root['revision']
new_value20250724
old_value20250722
prod/daily-dynamicmail-pa.sandbox-v2
values_changed
root['revision']
new_value20250724
old_value20250722
prod/dataaccessauditlogging-pa-
values_changed
root['revision']
new_value20250717
old_value20250710
prod/dataaccessauditlogging-pa-v1
values_changed
root['revision']
new_value20250717
old_value20250710
prod/databaseinsights-
values_changed
root['revision']
new_value20250722
old_value20250708
prod/databaseinsights-v1
values_changed
root['revision']
new_value20250722
old_value20250708
prod/dataconnectors-
values_changed
root['revision']
new_value20250116
old_value20250109
prod/dataprocgdc-v1alpha1
values_changed
root['revision']
new_value20250716
old_value20250709
prod/directions-pa-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/directions-pa-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/directions-pa-v1alpha
values_changed
root['revision']
new_value20250723
old_value20250721
prod/edgenetwork-
values_changed
root['revision']
new_value20250717
old_value20250701
prod/edgenetwork-v1
values_changed
root['revision']
new_value20250717
old_value20250701
prod/edgenetwork-v1alpha1
values_changed
root['revision']
new_value20250717
old_value20250701
prod/embeddedassistant-
values_changed
root['revision']
new_value20250724
old_value20250722
prod/embeddedassistant-frontend-
values_changed
root['revision']
new_value20250724
old_value20250722
prod/embeddedassistant-frontend-v1
values_changed
root['revision']
new_value20250724
old_value20250722
prod/embeddedassistant-frontend-v1alpha2
values_changed
root['revision']
new_value20250724
old_value20250722
prod/embeddedassistant-frontend-v1beta1
values_changed
root['revision']
new_value20250724
old_value20250722
prod/embeddedassistant-frontend-webchannel-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/embeddedassistant-frontend-webchannel-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/embeddedassistant-frontend-webchannel-v1alpha2
values_changed
root['revision']
new_value20250723
old_value20250721
prod/embeddedassistant-frontend-webchannel-v1beta1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/embeddedassistant-v1
values_changed
root['revision']
new_value20250724
old_value20250722
prod/embeddedassistant-v1alpha2
values_changed
root['revision']
new_value20250724
old_value20250722
prod/embeddedassistant-v1beta1
values_changed
root['revision']
new_value20250724
old_value20250722
prod/embeddedassistant-webchannel-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/embeddedassistant-webchannel-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/embeddedassistant-webchannel-v1alpha2
values_changed
root['revision']
new_value20250723
old_value20250721
prod/embeddedassistant-webchannel-v1beta1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/eu-alpha-vision-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/eu-alpha-vision-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/eu-alpha-vision-v1p1beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/eu-alpha-vision-v1p2beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/eu-alpha-vision-v1p3beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/eu-alpha-vision-v1p4beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/eu-chronicle-
values_changed
root['revision']
new_value20250717
old_value20250710
iterable_item_added
root['schemas']['Metric']['properties']['dimensions']['items']['enum'][36]LOG_TYPE
root['schemas']['Metric']['properties']['dimensions']['items']['enumDescriptions'][36]Log type.
root['schemas']['Metric']['properties']['metricName']['enum'][39]UDM_DATA_PRESENCE_SUMMARY
root['schemas']['Metric']['properties']['metricName']['enumDescriptions'][39]UDM data summary tracking unique values of dimensions.
root['schemas']['UserError']['properties']['reason']['enum'][25]UNIQUE_FIELD_CONFLICT
root['schemas']['UserError']['properties']['reason']['enumDescriptions'][25]The resource that the user is trying to create already exists. Example ErrorInfo: { "reason": "UNIQUE_FIELD_CONFLICT", "metadata": { "conflicting_fields": "[{\"field_name\": \"display_name\", \"value\": \"display_name\"}]" } }
prod/eu-chronicle-v1
values_changed
root['revision']
new_value20250717
old_value20250710
iterable_item_added
root['schemas']['Metric']['properties']['dimensions']['items']['enum'][36]LOG_TYPE
root['schemas']['Metric']['properties']['dimensions']['items']['enumDescriptions'][36]Log type.
root['schemas']['Metric']['properties']['metricName']['enum'][39]UDM_DATA_PRESENCE_SUMMARY
root['schemas']['Metric']['properties']['metricName']['enumDescriptions'][39]UDM data summary tracking unique values of dimensions.
root['schemas']['UserError']['properties']['reason']['enum'][25]UNIQUE_FIELD_CONFLICT
root['schemas']['UserError']['properties']['reason']['enumDescriptions'][25]The resource that the user is trying to create already exists. Example ErrorInfo: { "reason": "UNIQUE_FIELD_CONFLICT", "metadata": { "conflicting_fields": "[{\"field_name\": \"display_name\", \"value\": \"display_name\"}]" } }
prod/eu-chronicle-v1alpha
dictionary_item_added
  • root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['cases']['methods']['getCaseOverviewData']
  • root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['cases']['resources']['caseAlerts']['methods']['getAlertOverviewData']
  • root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetDebugStepCaseData']
  • root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetOverviewTemplates']
  • root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetOverviewTemplate']['parameters']['templateIdentifier']
  • root['schemas']['AdvancedConfig']
  • root['schemas']['ApiActionParameter']
  • root['schemas']['ApiPlaybookCard']
  • root['schemas']['ApiSlaExpiration']
  • root['schemas']['ApiWorkflowInstanceCardDataModel']
  • root['schemas']['CaseInsightData']
  • root['schemas']['CertificateProvenance']
  • root['schemas']['ClientProvenance']
  • root['schemas']['Configuration']
  • root['schemas']['CustomFieldFormData']
  • root['schemas']['DailyScheduleDetails']
  • root['schemas']['DataDistributionSetting']
  • root['schemas']['EventData']
  • root['schemas']['HighlightFieldConfig']
  • root['schemas']['HtmlViewPreset']
  • root['schemas']['LegacyPlaybookActionWidgetTemplateResponse']
  • root['schemas']['LegacyPlaybookGetDebugStepCaseDataRequest']
  • root['schemas']['LegacyPlaybookGetDebugStepCaseDataResponse']
  • root['schemas']['LegacyPlaybookGetOverviewTemplateResponse']
  • root['schemas']['LegacyPlaybookGetPendingStepsUserRelatedResponse']
  • root['schemas']['MonthlyScheduleDetails']
  • root['schemas']['OneTimeScheduleDetails']
  • root['schemas']['OptionProvenance']
  • root['schemas']['OverviewData']
  • root['schemas']['OverviewWidgetMetadataResult']
  • root['schemas']['QuestionProvenance']
  • root['schemas']['QuickActionDataModel']
  • root['schemas']['ResourceRecordProvenance']
  • root['schemas']['ServerProvenance']
  • root['schemas']['TimeOfDay']
  • root['schemas']['UserAgentProtoProvenance']
  • root['schemas']['WeeklyScheduleDetails']
  • root['schemas']['WidgetApiActionDefinitionDataModel']
  • root['schemas']['WidgetApiDynamicResultMetadata']
  • root['schemas']['WidgetApiIntegrationInstanceDataModel']
  • root['schemas']['WidgetApiPendingStepInstanceDataModel']
  • root['schemas']['WidgetApiSecurityEntityDataModel']
  • root['schemas']['WidgetApiWorkflowStepInstanceDataModel']
  • root['schemas']['WidgetApiWorkflowStepParameterDataModel']
  • root['schemas']['WidgetCondition']
  • root['schemas']['WidgetConditionsGroup']
  • root['schemas']['WidgetPropertyValue']
  • root['schemas']['WorkflowInstance']
  • root['schemas']['WorkflowVersionLog']
  • root['schemas']['AccessPermissionProfileInfoOption']['properties']['role']['enum']
  • root['schemas']['AccessPermissionProfileInfoOption']['properties']['role']['enumDescriptions']
  • root['schemas']['AccessPermissionProfileInfoOption']['properties']['userType']['enum']
  • root['schemas']['AccessPermissionProfileInfoOption']['properties']['userType']['enumDescriptions']
  • root['schemas']['ApiPendingStepInstanceDataModel']['properties']['alertPriority']['enum']
  • root['schemas']['ApiPendingStepInstanceDataModel']['properties']['alertPriority']['enumDescriptions']
  • root['schemas']['ApiPendingStepInstanceDataModel']['properties']['casePriority']['enum']
  • root['schemas']['ApiPendingStepInstanceDataModel']['properties']['casePriority']['enumDescriptions']
  • root['schemas']['ApiWorkflowCategoryDataModel']['properties']['type']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['creationSource']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['defaultAccessLevel']['enum']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['defaultAccessLevel']['enumDescriptions']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['entityAccessLevel']['enum']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['entityAccessLevel']['enumDescriptions']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['playbookType']['enum']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['playbookType']['enumDescriptions']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['defaultAccessLevel']['enum']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['defaultAccessLevel']['enumDescriptions']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['entityAccessLevel']['enum']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['entityAccessLevel']['enumDescriptions']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['playbookType']['enum']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['playbookType']['enumDescriptions']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['status']['enum']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['status']['enumDescriptions']
  • root['schemas']['ApiWorkflowInstanceSummary']['properties']['retryPendingSteps']
  • root['schemas']['ApiWorkflowMenuCardDefinitionDataModel']['properties']['playbookType']['enum']
  • root['schemas']['ApiWorkflowMenuCardDefinitionDataModel']['properties']['playbookType']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepCardDataModel']['properties']['status']['enum']
  • root['schemas']['ApiWorkflowStepCardDataModel']['properties']['status']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepCardDataModel']['properties']['type']['enum']
  • root['schemas']['ApiWorkflowStepCardDataModel']['properties']['type']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepDataModel']['properties']['type']['enum']
  • root['schemas']['ApiWorkflowStepDataModel']['properties']['type']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepInstanceDataModel']['properties']['status']['enum']
  • root['schemas']['ApiWorkflowStepInstanceDataModel']['properties']['status']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepInstanceDataModel']['properties']['type']['enum']
  • root['schemas']['ApiWorkflowStepInstanceDataModel']['properties']['type']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepParameterDataModel']['properties']['type']['enum']
  • root['schemas']['ApiWorkflowStepParameterDataModel']['properties']['type']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepRelationDataModel']['properties']['destinationActionStatus']['enum']
  • root['schemas']['ApiWorkflowStepRelationDataModel']['properties']['destinationActionStatus']['enumDescriptions']
  • root['schemas']['ApiWorkflowTriggerDataModel']['properties']['logicalOperator']['enum']
  • root['schemas']['ApiWorkflowTriggerDataModel']['properties']['logicalOperator']['enumDescriptions']
  • root['schemas']['ApiWorkflowTriggerDataModel']['properties']['type']['enum']
  • root['schemas']['ApiWorkflowTriggerDataModel']['properties']['type']['enumDescriptions']
  • root['schemas']['CaseSummaryFeedbackMetadata']['properties']['version']
  • root['schemas']['CaseWallRecord']['properties']['activityDataJson']
  • root['schemas']['CaseWallRecord']['properties']['activityKind']
  • root['schemas']['CaseWallRecord']['properties']['alertIdentifier']
  • root['schemas']['CaseWallRecord']['properties']['creatorFullName']
  • root['schemas']['ConnectorInstance']['properties']['integration']
  • root['schemas']['ContextGroupDataModel']['properties']['key']
  • root['schemas']['ContextGroupDataModel']['properties']['value']
  • root['schemas']['FavoriteRequest']['properties']['favorite']
  • root['schemas']['FtpProvenance']['properties']['command']
  • root['schemas']['IntegrationInstance']['properties']['identifier']
  • root['schemas']['IntegrationJobInstance']['properties']['advanced']
  • root['schemas']['IntegrationJobInstance']['properties']['advancedConfig']
  • root['schemas']['IntegrationJobInstance']['properties']['nextScheduledRunTime']
  • root['schemas']['LegacyFetchUdmSearchCsvRequest']['properties']['queryType']
  • root['schemas']['LegacyPlaybookAddOrUpdatePlaybookCategoryRequest']['properties']['type']
  • root['schemas']['LegacyPlaybookApiActionParameter']['properties']['type']['enum']
  • root['schemas']['LegacyPlaybookApiActionParameter']['properties']['type']['enumDescriptions']
  • root['schemas']['LegacyPlaybookApiSlaExpiration']['properties']['expirationStatus']['enum']
  • root['schemas']['LegacyPlaybookApiSlaExpiration']['properties']['expirationStatus']['enumDescriptions']
  • root['schemas']['LegacyPlaybookApiTriggerCondition']['properties']['matchType']['enum']
  • root['schemas']['LegacyPlaybookApiTriggerCondition']['properties']['matchType']['enumDescriptions']
  • root['schemas']['LegacyPlaybookApprovalLinkResult']['properties']['approvalLinkActionType']['enum']
  • root['schemas']['LegacyPlaybookApprovalLinkResult']['properties']['approvalLinkActionType']['enumDescriptions']
  • root['schemas']['LegacyPlaybookApprovalLinkResult']['properties']['status']['enum']
  • root['schemas']['LegacyPlaybookApprovalLinkResult']['properties']['status']['enumDescriptions']
  • root['schemas']['LegacyPlaybookCondition']['properties']['matchType']['enum']
  • root['schemas']['LegacyPlaybookCondition']['properties']['matchType']['enumDescriptions']
  • root['schemas']['LegacyPlaybookConditionsGroup']['properties']['logicalOperator']['enum']
  • root['schemas']['LegacyPlaybookConditionsGroup']['properties']['logicalOperator']['enumDescriptions']
  • root['schemas']['LegacyPlaybookGetWorkflowMenuCardsRequest']['properties']['legacyPayload']['items']['enum']
  • root['schemas']['LegacyPlaybookGetWorkflowMenuCardsRequest']['properties']['legacyPayload']['items']['enumDescriptions']
  • root['schemas']['LegacyPlaybookGetWorkflowMenuCardsWithEnvFilterRequest']['properties']['legacyPayload']['items']['enum']
  • root['schemas']['LegacyPlaybookGetWorkflowMenuCardsWithEnvFilterRequest']['properties']['legacyPayload']['items']['enumDescriptions']
  • root['schemas']['LegacyPlaybookGetWorkflowStepInstanceRequest']['properties']['parentWorkflowLoopIteration']
  • root['schemas']['LegacyPlaybookOverviewTemplateData']['properties']['type']['enum']
  • root['schemas']['LegacyPlaybookOverviewTemplateData']['properties']['type']['enumDescriptions']
  • root['schemas']['LegacyPlaybookPermissionsRequest']['properties']['defaultAccessLevel']['enum']
  • root['schemas']['LegacyPlaybookPermissionsRequest']['properties']['defaultAccessLevel']['enumDescriptions']
  • root['schemas']['LegacyPlaybookTemplateWidgetMetadata']['properties']['type']['enum']
  • root['schemas']['LegacyPlaybookTemplateWidgetMetadata']['properties']['type']['enumDescriptions']
  • root['schemas']['LegacyPlaybookTemplateWidgetMetadata']['properties']['width']['enum']
  • root['schemas']['LegacyPlaybookTemplateWidgetMetadata']['properties']['width']['enumDescriptions']
  • root['schemas']['LegacyPlaybookWorkflowAccessPermissions']['properties']['accessLevel']['enum']
  • root['schemas']['LegacyPlaybookWorkflowAccessPermissions']['properties']['accessLevel']['enumDescriptions']
  • root['schemas']['MalachiteFinding']['properties']['producerDetectionIds']
  • root['schemas']['QuickActionInstanceConfiguration']['properties']['isDynamicMode']
  • root['schemas']['SecurityEntityCard']['properties']['direction']['enum']
  • root['schemas']['SecurityEntityCard']['properties']['direction']['enumDescriptions']
  • root['schemas']['WorkbookAccessPermissionsItem']['properties']['accessLevel']['enum']
  • root['schemas']['WorkbookAccessPermissionsItem']['properties']['accessLevel']['enumDescriptions']
dictionary_item_removed
  • root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetOverviewTemplate']['request']
  • root['schemas']['CaseWallRecord']['properties']['activityData']
  • root['schemas']['CaseWallRecord']['properties']['alertId']
  • root['schemas']['InvestigationStep']['properties']['query']
  • root['schemas']['QuickActionButton']['properties']['buttonColor']['readOnly']
  • root['schemas']['QuickActionButton']['properties']['buttonName']['readOnly']
  • root['schemas']['QuickActionInstanceConfiguration']['properties']['isDynamicModel']
  • root['schemas']['QuickActionParameterValue']['properties']['actionParameterId']['readOnly']
  • root['schemas']['QuickActionParameterValue']['properties']['value']['readOnly']
  • root['schemas']['S3AuthV2']['properties']['awsIamRoleArn']
  • root['schemas']['SQSAuthV2']['properties']['awsIamRoleArn']
values_changed
root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['contentHub']['resources']['featuredContentRules']['methods']['list']['parameters']['filter']['description']
new_valueOptional. Only the following filters are allowed: Under HAS operator: Filtering through category names: - Singular: `category_name:""` - Multiple: `category_name:"" OR category_name:""` -- You can only use OR operator between multiple category_name filters. Filtering through policy names: - Singular: `policy_name:""` - Multiple: `policy_name:"" OR policy_name:""` -- You can only use OR operator between multiple policy_name filters. Filtering through rule IDs: - Singular: `rule_id:"ur_"` - Multiple: `rule_id:"ur_" OR rule_id:"ur_"` -- You can only use OR operator between multiple rule_id filters. Filtering through rule precision: `rule_precision:""` -- Rule precision values can be "Precise" or "Broad". If something else is passed, the rule precision will default to "Unknown". You can only filter by one rule precision value. Under MATCHES_REGEXP operator: Search through rule name or description (behaves like a string contains): This search is case-insensitive and filters through the rule metadata, specifically the rule_name and description keys. `search_rule_name_or_description=~" or "`. You can only filter by one rule name or description value. Multiple filters can also be used together: Ex 1: `category_name:"" AND policy_name:""` Ex 2: Since category_name and policy_name are repeated fields, we can also use multiple values for each: `(category_name:"" OR category_name:"") AND policy_name:""` -- Note that the AND operator has higher precedence than the OR operator. Additionally, parentheses must be used to create a valid filter. Requests using filter comparators other than HAS(:) or MATCHES_REGEXP(=~) will result in an InvalidArgument error.
old_valueOptional. Only the following filters are allowed: Under HAS operator: Filtering through category names: - Singular: `category_name:""` - Multiple: `category_name:"" OR category_name:""` -- You can only use OR operator between multiple category_name filters. Filtering through policy names: - Singular: `policy_name:""` - Multiple: `policy_name:"" OR policy_name:""` -- You can only use OR operator between multiple policy_name filters. Filtering through rule precision: `rule_precision:""` -- Rule precision values can be "Precise" or "Broad". If something else is passed, the rule precision will default to "Unknown". You can only filter by one rule precision value. Filtering through rule ID: `rule_id:"ur_"` -- You can only filter by one rule ID value. Under MATCHES_REGEXP operator: Search through rule name or description (behaves like a string contains): This search is case-insensitive and filters through the rule metadata, specifically the rule_name and description keys. `search_rule_name_or_description=~" or "`. You can only filter by one rule name or description value. Multiple filters can also be used together: Ex 1: `category_name:"" AND policy_name:""` Ex 2: Since category_name and policy_name are repeated fields, we can also use multiple values for each: `(category_name:"" OR category_name:"") AND policy_name:""` -- Note that the AND operator has higher precedence than the OR operator. Additionally, parentheses must be used to create a valid filter. Requests using filter comparators other than HAS(:) or MATCHES_REGEXP(=~) will result in an InvalidArgument error.
root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyActionWidgetTemplate']['response']['$ref']
new_valueLegacyPlaybookActionWidgetTemplateResponse
old_valueLegacyPlaybookTemplateWidgetDefinition
root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetOverviewTemplate']['description']
new_valueLegacyPlaybookGetOverviewTemplate returns the overview template by template identifier.
old_valueLegacyPlaybookGetOverviewTemplateByPlaybookIdentifier returns the overview template by playbook identifier.
root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetOverviewTemplate']['httpMethod']
new_valueGET
old_valuePOST
root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetPendingStepsUserRelated']['parameters']['sortBy']['description']
new_valueOptional. Possible options for sorting the pending steps: - TimeAscending - TimeDescending - PriorityAscending - PriorityDescending - TimeToResponseAscending - TimeToResponseDescending - SlaAscending - SlaDescending - Sort by field.
old_valueOptional. Sort by field. Possible values: TimeAscending = 0, TimeDescending = 1, PriorityAscending = 2, PriorityDescending = 3, TimeToResponseAscending = 4, TimeToResponseDescending = 5, SlaAscending = 6, SlaDescending = 7
root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetPendingStepsUserRelated']['response']['$ref']
new_valueLegacyPlaybookGetPendingStepsUserRelatedResponse
old_valueApiWorkflowStepInstanceDataModel
root['revision']
new_value20250717
old_value20250710
root['schemas']['AccessPermissionProfileInfoOption']['properties']['role']['description']
new_valueRequired. Role is the role of the user.
old_valueRequired. Role is the role of the user. Analyst role. ANALYST = 0; Administrator role. ADMIN = 1;
root['schemas']['AccessPermissionProfileInfoOption']['properties']['userType']['description']
new_valueRequired. UserType is the type of the user.
old_valueRequired. UserType is the type of the user. Windows user type. WINDOWS = 0; Internal user type. INTERNAL = 1; External user type. EXTERNAL = 2; Support user type. SUPPORT = 3; Incident manager user type. INCIDENT_MANAGER = 4;
root['schemas']['ApiPendingStepInstanceDataModel']['properties']['alertPriority']['description']
new_valueOptional. AlertPriority is the priority of the alert.
old_valueOptional. AlertPriority is the priority of the alert. Possible values: INFORMATAIVE = -1; UNCHANGED = 0; LOW = 40; MEDIUM = 60; HIGH = 80; CRITICAL = 100;
root['schemas']['ApiPendingStepInstanceDataModel']['properties']['casePriority']['description']
new_valueOptional. CasePriority is the priority of the case.
old_valueOptional. CasePriority is the priority of the case. Possible values: INFORMATAIVE = -1; UNCHANGED = 0; LOW = 40; MEDIUM = 60; HIGH = 80; CRITICAL = 100;
root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['defaultAccessLevel']['description']
new_valueRequired. DefaultAccessLevel is the default access level for the workflow.
old_valueRequired. DefaultAccessLevel is the default access level for the workflow. Possible values: WORKFLOW_ACCESS_UNSPECIFIED = 0; VIEW = 1; EDIT = 2; EXECUTE = 3;
root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['entityAccessLevel']['description']
new_valueRequired. EntityAccessLevel is the access level for entities.
old_valueRequired. EntityAccessLevel is the access level for entities. Possible values: WORKFLOW_ACCESS_UNSPECIFIED = 0; VIEW = 1; EDIT = 2; EXECUTE = 3;
root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['playbookType']['description']
new_valueRequired. PlaybookType is the type of playbook.
old_valueRequired. PlaybookType is the type of playbook. Possible values: Regular playbook type. REGULAR = 0; Nested playbook type. NESTED = 1;
root['schemas']['ApiWorkflowInstanceDataModel']['properties']['defaultAccessLevel']['description']
new_valueRequired. DefaultAccessLevel is the default access level for the workflow.
old_valueRequired. DefaultAccessLevel is the default access level for the workflow. Possible values: WORKFLOW_ACCESS_UNSPECIFIED = 0; VIEW = 1; EDIT = 2; EXECUTE = 3;
root['schemas']['ApiWorkflowInstanceDataModel']['properties']['entityAccessLevel']['description']
new_valueRequired. EntityAccessLevel is the access level for entities.
old_valueRequired. EntityAccessLevel is the access level for entities. Possible values: WORKFLOW_ACCESS_UNSPECIFIED = 0; VIEW = 1; EDIT = 2; EXECUTE = 3;
root['schemas']['ApiWorkflowInstanceDataModel']['properties']['playbookType']['description']
new_valueRequired. PlaybookType is the type of playbook.
old_valueRequired. PlaybookType is the type of playbook. Possible values: Regular playbook type. REGULAR = 0; Nested playbook type. NESTED = 1;
root['schemas']['ApiWorkflowInstanceDataModel']['properties']['status']['description']
new_valueRequired. Status is the status of the workflow instance.
old_valueRequired. Status is the status of the workflow instance. Possible values: None = 0, InProgress = 1, Completed = 2, Failed = 3, Terminated = 4, PendingInQueue = 5, PendingForUser = 6
root['schemas']['ApiWorkflowMenuCardDefinitionDataModel']['properties']['playbookType']['description']
new_valueRequired. PlaybookType is the type of playbook.
old_valueRequired. PlaybookType is the type of playbook. Possible values: Regular playbook type. REGULAR = 0; Nested playbook type. NESTED = 1;
root['schemas']['ApiWorkflowStepCardDataModel']['properties']['status']['description']
new_valueRequired. Status is the status of the action.
old_valueRequired. Status is the status of the action. Possible values: NoStatus = -1, Faulted = 0, InProgress = 1, Completed = 2, PendingUserInput = 3, PendingPreviousSteps = 4, Started = 5, FaultedAndSkipped = 6, HandledTimedout = 7, UnhandledTimedout = 8, Terminated = 9, NotRunAndSkipped = 10, PendingActionTimeout = 11, PendingActionTimeoutAndSkipped = 12, PendingRetry = 13
root['schemas']['ApiWorkflowStepCardDataModel']['properties']['type']['description']
new_valueRequired. Type is the type of the step.
old_valueRequired. Type is the type of the step. Possible values: Action = 0, MultiChoiceQuestion = 1, PreviousAction = 2, CaseDataCondition = 3, Condition = 4, Block = 5, Output = 6, ParallelActionsContainer = 7, ForEachStartLoop = 8, ForEachEndLoop = 9
root['schemas']['ApiWorkflowStepDataModel']['properties']['type']['description']
new_valueRequired. Type is the type of the step.
old_valueRequired. Type is the type of the step. Possible values: ACTION = 0; MULTI_CHOICE_QUESTION = 1; PREVIOUS_ACTION = 2; CASE_DATA_CONDITION = 3; CONDITION = 4; BLOCK = 5; OUTPUT = 6; PARALLEL_ACTIONS_CONTAINER = 7; FOR_EACH_START_LOOP = 8; FOR_EACH_END_LOOP = 9;
root['schemas']['ApiWorkflowStepInstanceDataModel']['properties']['status']['description']
new_valueRequired. Status is the status of the step.
old_valueRequired. Status is the status of the step. Possible values: NO_STATUS = 0; RUNNING = 1; SUCCESS = 2; FAILED = 3; PENDING = 4; SKIPPED = 5; CANCELED = 6; QUEUED = 7;
root['schemas']['ApiWorkflowStepInstanceDataModel']['properties']['type']['description']
new_valueRequired. Type is the type of the step.
old_valueRequired. Type is the type of the step. Possible values: STEP_TYPE_UNSPECIFIED = 0; ACTION = 1; FLOW = 2; CONDITION = 3; BLOCK = 4;
root['schemas']['ApiWorkflowStepParameterDataModel']['properties']['type']['description']
new_valueOptional. Type is the type of the parameter.
old_valueOptional. Type is the type of the parameter. Possible values: STRING = 0; BOOLEAN = 1; WFS_REPOSITORY = 2; USER_REPOSITORY = 3; STAGES_REPOSITORY = 4; CLOSECASE_REASON_REPOSITORY = 5; CLOSECASE_ROOTCAUSE_REPOSITORY = 6; PRIORITIES_REPOSITORY = 7; EMAILCONTENT = 10; CONTENT = 11; PASSWORD = 12; ENTITY_TYPE = 13; MULTIVALUES = 14; LIST = 15; CODE = 16; TIMESPANSECONDS = 17; MULTIPLECHOICEPARAMETER = 21;
root['schemas']['ApiWorkflowStepRelationDataModel']['properties']['destinationActionStatus']['description']
new_valueRequired. DestinationActionStatus is the status of the destination action.
old_valueRequired. DestinationActionStatus is the status of the destination action. Possible values: NO_STATUS = -1; FAULTED = 0; IN_PROGRESS = 1; COMPLETED = 2; PENDING_USER_INPUT = 3; PENDING_PREVIOUS_STEPS = 4; STARTED = 5; FAULTED_AND_SKIPPED = 6; HANDLED_TIMEDOUT = 7; UNHANDLED_TIMEDOUT = 8; TERMINATED = 9; NOT_RUN_AND_SKIPPED = 10; PENDING_ACTION_TIMEOUT = 11; PENDING_ACTION_TIMEOUT_AND_SKIPPED = 12; PENDING_RETRY = 13;
root['schemas']['ApiWorkflowTriggerDataModel']['properties']['logicalOperator']['description']
new_valueRequired. LogicalOperator is the logical operator for the conditions.
old_valueRequired. LogicalOperator is the logical operator for the conditions. Possible values: AND = 0; OR = 1;
root['schemas']['ApiWorkflowTriggerDataModel']['properties']['type']['description']
new_valueRequired. Type is the type of the trigger.
old_valueRequired. Type is the type of the trigger. Possible values: VENDOR_NAME = 0; TAG_NAME = 1; RULE_NAME = 2; PRODUCT_NAME = 3; NETWORK_NAME = 4; ENTITY_DETAILS = 5; RELATION_DETAILS = 6; TRACKING_LIST = 7; ALL = 8; ALERT_TRIGGER_VALUE = 9; CASE_DATA = 10; GET_INPUTS = 11;
root['schemas']['ArtifactClientProvenance']['properties']
new_value
behaviors
items
$refFieldProvenance
typearray
proxies
items
$refFieldProvenance
typearray
old_value
root['schemas']['AzureV2WorkloadIdentityFederation']['properties']['subjectId']['description']
new_valueRequired. Subject ID of the Azure subscription.
old_valueSubject ID of the Azure subscription.
root['schemas']['CaseWallRecord']['properties']['createTime']['format']
new_valueint64
old_valuegoogle-datetime
root['schemas']['CaseWallRecord']['properties']['updateTime']['format']
new_valueint64
old_valuegoogle-datetime
root['schemas']['DhcpProvenance']['properties']
new_value
chaddr
$refFieldProvenance
ciaddr
$refFieldProvenance
clientHostname
$refFieldProvenance
clientIdentifier
$refFieldProvenance
clientIdentifierString
$refFieldProvenance
file
$refFieldProvenance
flags
$refFieldProvenance
giaddr
$refFieldProvenance
hlen
$refFieldProvenance
hops
$refFieldProvenance
htype
$refFieldProvenance
leaseTimeSeconds
$refFieldProvenance
opcode
$refFieldProvenance
options
items
$refOptionProvenance
typearray
requestedAddress
$refFieldProvenance
seconds
$refFieldProvenance
siaddr
$refFieldProvenance
sname
$refFieldProvenance
transactionId
$refFieldProvenance
type
$refFieldProvenance
yiaddr
$refFieldProvenance
old_value
root['schemas']['DnsProvenance']['properties']
new_value
additional
items
$refResourceRecordProvenance
typearray
answers
items
$refResourceRecordProvenance
typearray
authoritative
$refFieldProvenance
authority
items
$refResourceRecordProvenance
typearray
id
$refFieldProvenance
opcode
$refFieldProvenance
questions
items
$refQuestionProvenance
typearray
recursionAvailable
$refFieldProvenance
recursionDesired
$refFieldProvenance
response
$refFieldProvenance
responseCode
$refFieldProvenance
truncated
$refFieldProvenance
old_value
root['schemas']['EmailProvenance']['properties']
new_value
bcc
items
$refFieldProvenance
typearray
bounceAddress
$refFieldProvenance
cc
items
$refFieldProvenance
typearray
from
$refFieldProvenance
mailId
$refFieldProvenance
replyTo
$refFieldProvenance
subject
items
$refFieldProvenance
typearray
to
items
$refFieldProvenance
typearray
old_value
root['schemas']['HttpProvenance']['properties']
new_value
method
$refFieldProvenance
parsedUserAgent
$refUserAgentProtoProvenance
referralUrl
$refFieldProvenance
responseCode
$refFieldProvenance
userAgent
$refFieldProvenance
old_value
root['schemas']['LegacyPlaybookApiActionParameter']['properties']['type']['description']
new_valueRequired. Type is the type of the parameter.
old_valueRequired. Type is the type of the parameter. Possible values: STRING = 0; BOOLEAN = 1; WFS_REPOSITORY = 2; USER_REPOSITORY = 3; STAGES_REPOSITORY = 4; CLOSECASE_REASON_REPOSITORY = 5; CLOSECASE_ROOTCAUSE_REPOSITORY = 6; PRIORITIES_REPOSITORY = 7; EMAILCONTENT = 10; CONTENT = 11; PASSWORD = 12; ENTITY_TYPE = 13; MULTIVALUES = 14; LIST = 15; CODE = 16; TIMESPANSECONDS = 17; MULTIPLECHOICEPARAMETER = 21;
root['schemas']['LegacyPlaybookApiSlaExpiration']['properties']['expirationStatus']['description']
new_valueRequired. ExpirationStatus is the expiration status.
old_valueRequired. ExpirationStatus is the expiration status. Possible values: PASSED_DUE = 0; OPEN_SLA = 1; NO_SLA = 2; CRITICAL_EXPIRED = 3; PAUSED = 4;
root['schemas']['LegacyPlaybookApiTriggerCondition']['properties']['matchType']['description']
new_valueRequired. MatchType is the operator to use for comparison.
old_valueRequired. MatchType is the operator to use for comparison. Possible values: EQUAL = 0; CONTAINS = 1; STARTS_WITH = 2; GREATER_THAN = 3; LESSER_THAN = 4; NOT_EQUAL = 5; NOT_CONTAINS = 6; IS_EMPTY = 7; IS_NOT_EMPTY = 8;
root['schemas']['LegacyPlaybookApprovalLinkResult']['properties']['approvalLinkActionType']['description']
new_valueRequired. The type of the approval link action.
old_valueRequired. The type of the approval link action. Approve. APPROVE = 0; Decline. DECLINE = 1; MultiChoiceAnswer. MULTI_CHOICE_ANSWER = 2;
root['schemas']['LegacyPlaybookApprovalLinkResult']['properties']['status']['description']
new_valueRequired. The status of the approval link.
old_valueRequired. The status of the approval link. Approval link skip/execute successfully completed. SUCCESS = 0; Approval link step not found. STEP_NOT_FOUND = 1; The approval link step already excepted. STEP_ALREADY_EXECUTED = 2; The approval link step to response expired. STEP_TIME_TO_RESPONSE_EXPIRED = 3; The approval link step is not pending yet. STEP_NOT_PENDING = 4; Approval link execution requires another click from the user. CLICK_REQUIRED = 5;
root['schemas']['LegacyPlaybookCondition']['properties']['matchType']['description']
new_valueRequired. MatchType is the operator to use for comparison.
old_valueRequired. MatchType is the operator to use for comparison. Possible values: EQUAL = 0; CONTAINS = 1; STARTS_WITH = 2; GREATER_THAN = 3; LESSER_THAN = 4; NOT_EQUAL = 5; NOT_CONTAINS = 6; IS_EMPTY = 7; IS_NOT_EMPTY = 8;
root['schemas']['LegacyPlaybookConditionsGroup']['properties']['logicalOperator']['description']
new_valueRequired. LogicalOperator is the logical operator for the conditions.
old_valueRequired. LogicalOperator is the logical operator for the conditions. Possible values: AND = 0; OR = 1;
root['schemas']['LegacyPlaybookDuplicateNestedWorkflowsResponse']['properties']['payload']['items']
new_value
$refApiWorkflowDefinitionDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookDuplicateWorkflowsResponse']['properties']['payload']['items']
new_value
$refApiWorkflowDefinitionDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetEnabledWFCardsResponse']['properties']['payload']['items']
new_value
$refApiPlaybookCard
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetHtmlViewPresetsResponse']['properties']['payload']['items']
new_value
$refHtmlViewPreset
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetNestedPlaybooksAsStepsResponse']['properties']['payload']['items']
new_value
$refApiWorkflowStepDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetNestedPlaybooksByEnvironmentsAsStepsResponse']['properties']['payload']['items']
new_value
$refApiWorkflowStepDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetNestedWorkflowDefaultInputsResponse']['properties']
new_value
payload
descriptionOptional. The payload is a list of trigger conditions.
items
$refLegacyPlaybookApiTriggerCondition
typearray
old_value
fieldName
descriptionRequired. FieldName is the name of the field to check.
typestring
matchType
descriptionRequired. MatchType is the operator to use for comparison. Equals operator. EQUAL = 0; Contains operator. CONTAINS = 1; Starts With operator. STARTS_WITH = 2; Greater Than operator. GREATER_THAN = 3; Lesser Than operator. LESSER_THAN = 4; Not Equals operator. NOT_EQUAL = 5; Not Contains operator. NOT_CONTAINS = 6; Is Empty operator. IS_EMPTY = 7; Is Not Empty operator. IS_NOT_EMPTY = 8;
typestring
value
descriptionRequired. Value is the value to compare against.
typestring
root['schemas']['LegacyPlaybookGetPlaybookSimulationEnrichmentResponse']['properties']['payload']['items']
new_value
$refContextGroupDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetWorkFlowVersionLogsResponse']['properties']['payload']['description']
new_valueOptional. The workflow version logs.
old_valueOptional. The workflow version logs. The Struct will contain the following fields: work_flow_identifier: Guid workflow_name: string creation_time_unix_time_in_ms: long version_creator: string version_comment: string
root['schemas']['LegacyPlaybookGetWorkFlowVersionLogsResponse']['properties']['payload']['items']
new_value
$refWorkflowVersionLog
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetWorkflowCategoriesResponse']['properties']['payload']['items']
new_value
$refApiWorkflowCategoryDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetWorkflowInstancesCardsResponse']['properties']['payload']['description']
new_valueOptional. The workflow instances cards.
old_valueOptional. The workflow instances cards. The Struct will contain the following fields: status: WorkflowInstanceStatusEnum name: string definition_identifier: Guid original_workflow_definition_identifier: Guid description: string position_in_queue: int is_debug_mode: bool run_count: long
root['schemas']['LegacyPlaybookGetWorkflowInstancesCardsResponse']['properties']['payload']['items']
new_value
$refApiWorkflowInstanceCardDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetWorkflowMenuCardsRequest']['properties']['legacyPayload']['description']
new_valueRequired. Playbook types to filter the workflow menu cards by.
old_valueRequired. Playbook types to filter the workflow menu cards by. Possible values: Regular playbook type. REGULAR = 0; Nested playbook type. NESTED = 1;
root['schemas']['LegacyPlaybookGetWorkflowMenuCardsResponse']['properties']['payload']['items']
new_value
$refApiWorkflowMenuCardDefinitionDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetWorkflowMenuCardsWithEnvFilterRequest']['properties']['legacyPayload']['description']
new_valueRequired. Playbook types to filter the workflow menu cards by.
old_valueRequired. Playbook types to filter the workflow menu cards by. Possible values: Regular playbook type. REGULAR = 0; Nested playbook type. NESTED = 1;
root['schemas']['LegacyPlaybookGetWorkflowMenuCardsWithEnvFilterResponse']['properties']['payload']['items']
new_value
$refApiWorkflowMenuCardDefinitionDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookOverviewTemplateData']['properties']['type']['description']
new_valueRequired. Type is the type of the overview template.
old_valueRequired. Type is the type of the overview template. Possible values: PLAYBOOK_DEFAULT = 0; REGULAR = 1; SYSTEM_ALERT = 2; SYSTEM_CASE = 3; ALERT_TYPE = 4;
root['schemas']['LegacyPlaybookPermissionsRequest']['properties']['defaultAccessLevel']['description']
new_valueOptional. The default access level.
old_valueOptional. The default access level. No access. NO_ACCESS = 0; View access. VIEW = 1; Edit access. EDIT = 2;
root['schemas']['LegacyPlaybookRerunBlockResponse']['properties']['payload']
new_value
$refWorkflowInstance
descriptionOptional. The response is a workflow instance.
old_value
additionalProperties
descriptionProperties of the object.
typeany
descriptionOptional. The response is a workflow instance.
typeobject
root['schemas']['LegacyPlaybookRerunPlaybookResponse']['properties']['payload']
new_value
$refWorkflowInstance
descriptionOptional. The workflow instance.
old_value
additionalProperties
descriptionProperties of the object.
typeany
descriptionOptional. The workflow instance.
typeobject
root['schemas']['LegacyPlaybookTemplateWidgetMetadata']['properties']['type']['description']
new_valueRequired. Type is the type of the widget.
old_valueRequired. Type is the type of the widget. Possible values: WIDGET_TEMPLATE_TYPE_UNSPECIFIED = 0; ACTION = 1; CASE_OVERVIEW = 2; ENTITY_GRAPH = 3; EVENTS_TABLE = 4; INSIGHTS = 5; JSON = 6; MULTI_CHOICE_QUESTION = 7; PARALLEL_ACTIONS_CONTAINER = 8; PREVIOUS_ACTION = 9; STATIC_TEXT = 10; VISUAL_REPORT = 11; WEB_PAGE = 12; IFRAME = 13; TABLE = 14; MARKDOWN = 15; FILE = 16; IMAGE = 17; BUTTON = 18; GROUP = 19; CUSTOM = 20;
root['schemas']['LegacyPlaybookTemplateWidgetMetadata']['properties']['width']['description']
new_valueRequired. Width is the width of the widget.
old_valueRequired. Width is the width of the widget. Possible values: ONE = 0; TWO = 1; THREE = 2; FOUR = 3;
root['schemas']['LegacyPlaybookWorkflowAccessPermissions']['properties']['accessLevel']['description']
new_valueRequired. AccessLevel is the access level for the user.
old_valueRequired. AccessLevel is the access level for the user. Possible values: NO_ACCESS = 0; VIEW = 1; EDIT = 2;
root['schemas']['ProxyInfoProvenance']['properties']
new_value
anonymous
$refFieldProvenance
anonymousVpn
$refFieldProvenance
hostingProvider
$refFieldProvenance
proxyOverVpn
$refFieldProvenance
publicProxy
$refFieldProvenance
relayProxy
$refFieldProvenance
residentialProxy
$refFieldProvenance
smartDnsProxy
$refFieldProvenance
torExitNode
$refFieldProvenance
vpnDatacenter
$refFieldProvenance
vpnServiceName
$refFieldProvenance
old_value
root['schemas']['QuickActionButton']['description']
new_valueQuickActionButton
old_valueQuick button.
root['schemas']['QuickActionButton']['properties']['buttonColor']['description']
new_valueThe button color.
old_valueOutput only. The button color.
root['schemas']['QuickActionButton']['properties']['buttonName']['description']
new_valueThe button name.
old_valueOutput only. The button name.
root['schemas']['QuickActionInstanceConfiguration']['description']
new_valueThe configuration of the quick action instance.
old_valueQuick action instance configuration.
root['schemas']['QuickActionParameterValue']['description']
new_valueQuickActionParameterValue
old_valueQuick action parameter value.
root['schemas']['QuickActionParameterValue']['properties']['actionParameterId']['description']
new_valueThe action parameter id.
old_valueOutput only. The parameter id.
root['schemas']['QuickActionParameterValue']['properties']['value']['description']
new_valueThe action parameter value.
old_valueOutput only. The parameter value.
root['schemas']['RemoveDependencyResponse']['properties']
new_value
error
descriptionOptional. An error message in case of an error.
typestring
successful
descriptionRequired. True if the removal was successful.
typeboolean
old_value
root['schemas']['SQSAuthV2']['properties']['awsIamRoleAuth']['description']
new_valueRequired. AWS IAM Role for Identity Federation.
old_valueAWS IAM Role for Identity Federation.
root['schemas']['ScriptResultEntityData']['description']
new_valueThe result entity data of the API action.
old_valueThe result entity data of the pending step.
root['schemas']['ScriptResultEntityData']['properties']['attachments']['description']
new_valueOutput only. The attachments of the result entity data.
old_valueOutput only. The additional properties of the result entity data.
root['schemas']['ScriptResultEntityData']['properties']['isForEntity']['type']
new_valueboolean
old_valuestring
root['schemas']['SecurityEntityCard']['properties']['direction']['description']
new_valueOptional. Direction is the direction of the entity.
old_valueOptional. Direction is the direction of the entity. Possible values: None = 0, Inbound = 10, Outbound = 20, Both = 30,
root['schemas']['SetLogsCollectionResponse']['properties']
new_value
logEnableExpirationTime
descriptionOutput only. The connector instance logging enabled time until unix ms
formatint64
readOnlyTrue
typestring
old_value
lastLoggingEnabledTime
descriptionOutput only. The connector instance logging enabled time until unix ms
formatint64
readOnlyTrue
typestring
root['schemas']['SmtpProvenance']['properties']
new_value
helo
$refFieldProvenance
isTls
$refFieldProvenance
isWebmail
$refFieldProvenance
mailFrom
$refFieldProvenance
messagePath
$refFieldProvenance
rcptTo
items
$refFieldProvenance
typearray
serverResponse
items
$refFieldProvenance
typearray
old_value
root['schemas']['TlsProvenance']['properties']
new_value
cipher
$refFieldProvenance
client
$refClientProvenance
curve
$refFieldProvenance
established
$refFieldProvenance
nextProtocol
$refFieldProvenance
resumed
$refFieldProvenance
server
$refServerProvenance
version
$refFieldProvenance
versionProtocol
$refFieldProvenance
old_value
root['schemas']['TunnelsProvenance']['properties']
new_value
provider
$refFieldProvenance
type
$refFieldProvenance
old_value
root['schemas']['WorkbookAccessPermissionsItem']['properties']['accessLevel']['description']
new_valueRequired. AccessLevel is the access level for the user.
old_valueRequired. AccessLevel is the access level for the user. No access. NO_ACCESS = 0; View access. VIEW = 1; Edit access. EDIT = 2;
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][9]
new_valueCASE_EXTERNAL_CHANNEL_MESSAGE
old_valueWALL_ACTIVITY_TYPE_CASE_EXTERNAL_CHANNEL_MESSAGE
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][9]
new_valueCASE_EXTERNAL_CHANNEL_MESSAGE
old_valueWALL_ACTIVITY_TYPE_CASE_EXTERNAL_CHANNEL_MESSAGE
root['schemas']['LegacyPlaybookAddOrUpdatePlaybookCategoryRequest']['properties']['categoryState']['enumDescriptions'][2]
new_valueThe category state is full.
old_valueFull state from restricted environment.
root['schemas']['QuickActionButton']['properties']['buttonColor']['enumDescriptions'][2]
new_valueThe button color is orange.
old_valueThe color is green.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][6]
new_valueCASE_COMMENT
old_valueWALL_ACTIVITY_TYPE_CASE_COMMENT
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][6]
new_valueCASE_COMMENT
old_valueWALL_ACTIVITY_TYPE_CASE_COMMENT
root['schemas']['ApiWorkflowCategoryDataModel']['properties']['categoryState']['enumDescriptions'][1]
new_valueThe category state is empty.
old_valueFull state.
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][5]
new_valueCASE_EVIDENCE
old_valueWALL_ACTIVITY_TYPE_CASE_EVIDENCE
root['schemas']['LegacyPlaybookAddOrUpdatePlaybookCategoryRequest']['properties']['categoryState']['enumDescriptions'][1]
new_valueThe category state is empty.
old_valueFull state.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][3]
new_valueCASE_TASK
old_valueWALL_ACTIVITY_TYPE_CASE_TASK
root['schemas']['LegacyPlaybookAddOrUpdatePlaybookCategoryRequest']['properties']['categoryState']['enumDescriptions'][0]
new_valueThe category state is unspecified.
old_valueEmpty state.
root['schemas']['FavoriteRequest']['properties']['activityType']['enumDescriptions'][1]
new_valueCase alert data activity type.
old_valueAlert data activity type.
root['schemas']['CaseWallRecord']['properties']['activityType']['enumDescriptions'][0]
new_valueUnspecified wall activity type.
old_valueUnspecified activity type.
root['schemas']['FavoriteRequest']['properties']['activityType']['enumDescriptions'][0]
new_valueUnspecified wall activity type.
old_valueUnspecified activity type.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][4]
new_valueCASE_ACTION
old_valueWALL_ACTIVITY_TYPE_CASE_ACTION
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][4]
new_valueCASE_ACTION
old_valueWALL_ACTIVITY_TYPE_CASE_ACTION
root['schemas']['QuickActionButton']['properties']['buttonColor']['enumDescriptions'][1]
new_valueThe button color is yellow.
old_valueThe color is blue.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][10]
new_valuePINNED_CASE_CHAT_MESSAGE
old_valueWALL_ACTIVITY_TYPE_PINNED_CASE_CHAT_MESSAGE
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][2]
new_valueCASE_STATUS_CHANGE
old_valueWALL_ACTIVITY_TYPE_CASE_STATUS_CHANGE
root['schemas']['QuickActionButton']['properties']['buttonColor']['enumDescriptions'][0]
new_valueThe button color is blue.
old_valueThe color is unspecified.
root['schemas']['CaseWallRecord']['properties']['activityType']['enumDescriptions'][10]
new_valuePinned case chat message activity type.
old_valueCase pinned chat message activity type.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][2]
new_valueCASE_STATUS_CHANGE
old_valueWALL_ACTIVITY_TYPE_CASE_STATUS_CHANGE
root['schemas']['ApiWorkflowCategoryDataModel']['properties']['categoryState']['enumDescriptions'][0]
new_valueThe category state is unspecified.
old_valueEmpty state.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][11]
new_valueCASE_LINK
old_valueWALL_ACTIVITY_TYPE_CASE_LINK
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][5]
new_valueCASE_EVIDENCE
old_valueWALL_ACTIVITY_TYPE_CASE_EVIDENCE
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][7]
new_valueCASE_INSIGHT
old_valueWALL_ACTIVITY_TYPE_CASE_INSIGHT
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][7]
new_valueCASE_INSIGHT
old_valueWALL_ACTIVITY_TYPE_CASE_INSIGHT
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][11]
new_valueCASE_LINK
old_valueWALL_ACTIVITY_TYPE_CASE_LINK
root['schemas']['ApiWorkflowCategoryDataModel']['properties']['categoryState']['enumDescriptions'][2]
new_valueThe category state is full.
old_valueFull state from restricted environment.
root['schemas']['FavoriteRequest']['properties']['activityType']['enumDescriptions'][10]
new_valuePinned case chat message activity type.
old_valueCase pinned chat message activity type.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][8]
new_valueCASE_CREATION
old_valueWALL_ACTIVITY_TYPE_CASE_CREATION
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][1]
new_valueCASE_ALERT_DATA
old_valueWALL_ACTIVITY_TYPE_CASE_ALERT_DATA
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][10]
new_valuePINNED_CASE_CHAT_MESSAGE
old_valueWALL_ACTIVITY_TYPE_PINNED_CASE_CHAT_MESSAGE
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][1]
new_valueCASE_ALERT_DATA
old_valueWALL_ACTIVITY_TYPE_CASE_ALERT_DATA
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][8]
new_valueCASE_CREATION
old_valueWALL_ACTIVITY_TYPE_CASE_CREATION
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][3]
new_valueCASE_TASK
old_valueWALL_ACTIVITY_TYPE_CASE_TASK
root['schemas']['CaseWallRecord']['properties']['activityType']['enumDescriptions'][1]
new_valueCase alert data activity type.
old_valueAlert data activity type.
iterable_item_added
root['schemas']['AnalyticValue']['properties']['dimensions']['items']['enum'][36]LOG_TYPE
root['schemas']['AnalyticValue']['properties']['dimensions']['items']['enumDescriptions'][36]Log type.
root['schemas']['ApiWorkflowCategoryDataModel']['properties']['categoryState']['enum'][0]API_CATEGORY_STATE_UNSPECIFIED
root['schemas']['ApiWorkflowCategoryDataModel']['properties']['categoryState']['enumDescriptions'][3]The category state is full from a restricted environment.
root['schemas']['FavoriteRequest']['properties']['activityKind']['enum'][20]CUSTOM_FORM_CHANGES
root['schemas']['FavoriteRequest']['properties']['activityKind']['enum'][21]PLAYBOOK_ATTACHED
root['schemas']['FavoriteRequest']['properties']['activityKind']['enum'][22]ENTITY_ADDED
root['schemas']['FavoriteRequest']['properties']['activityKind']['enum'][23]PLAYBOOK_RERUN
root['schemas']['FavoriteRequest']['properties']['activityKind']['enum'][24]BLOCK_RERUN
root['schemas']['FavoriteRequest']['properties']['activityKind']['enumDescriptions'][20]Custom form changes activity kind.
root['schemas']['FavoriteRequest']['properties']['activityKind']['enumDescriptions'][21]Playbook attached activity kind.
root['schemas']['FavoriteRequest']['properties']['activityKind']['enumDescriptions'][22]Entity added activity kind.
root['schemas']['FavoriteRequest']['properties']['activityKind']['enumDescriptions'][23]Playbook rerun activity kind.
root['schemas']['FavoriteRequest']['properties']['activityKind']['enumDescriptions'][24]Block rerun activity kind.
root['schemas']['FieldProvenance']['properties']['logType']['enum'][1774]FORTINET_FORTINDR
root['schemas']['FieldProvenance']['properties']['logType']['enum'][2192]TORQ_AUDIT_LOGS
root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][1774]FORTINET_FORTINDR
root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2192]TORQ_AUDIT_LOGS
root['schemas']['LegacyPlaybookAddOrUpdatePlaybookCategoryRequest']['properties']['categoryState']['enum'][0]API_CATEGORY_STATE_UNSPECIFIED
root['schemas']['LegacyPlaybookAddOrUpdatePlaybookCategoryRequest']['properties']['categoryState']['enumDescriptions'][3]The category state is full from a restricted environment.
root['schemas']['MalachiteEnrichmentSource']['properties']['logType']['enum'][1774]FORTINET_FORTINDR
root['schemas']['MalachiteEnrichmentSource']['properties']['logType']['enum'][2192]TORQ_AUDIT_LOGS
root['schemas']['Metric']['properties']['dimensions']['items']['enum'][36]LOG_TYPE
root['schemas']['Metric']['properties']['dimensions']['items']['enumDescriptions'][36]Log type.
root['schemas']['Metric']['properties']['metricName']['enum'][39]UDM_DATA_PRESENCE_SUMMARY
root['schemas']['Metric']['properties']['metricName']['enumDescriptions'][39]UDM data summary tracking unique values of dimensions.
root['schemas']['RawLog']['properties']['type']['enum'][1774]FORTINET_FORTINDR
root['schemas']['RawLog']['properties']['type']['enum'][2192]TORQ_AUDIT_LOGS
root['schemas']['SIEventData']['properties']['rawLogType']['enum'][1774]FORTINET_FORTINDR
root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2192]TORQ_AUDIT_LOGS
root['schemas']['UserError']['properties']['reason']['enum'][25]UNIQUE_FIELD_CONFLICT
root['schemas']['UserError']['properties']['reason']['enumDescriptions'][25]The resource that the user is trying to create already exists. Example ErrorInfo: { "reason": "UNIQUE_FIELD_CONFLICT", "metadata": { "conflicting_fields": "[{\"field_name\": \"display_name\", \"value\": \"display_name\"}]" } }
iterable_item_removed
root['schemas']['QuickActionButton']['properties']['buttonColor']['enum'][0]QUICK_ACTION_BUTTON_COLOR_UNSPECIFIED
root['schemas']['QuickActionButton']['properties']['buttonColor']['enumDescriptions'][3]The color is red.
prod/eu-chronicle-v1beta
values_changed
root['revision']
new_value20250717
old_value20250710
iterable_item_added
root['schemas']['Metric']['properties']['dimensions']['items']['enum'][36]LOG_TYPE
root['schemas']['Metric']['properties']['dimensions']['items']['enumDescriptions'][36]Log type.
root['schemas']['Metric']['properties']['metricName']['enum'][39]UDM_DATA_PRESENCE_SUMMARY
root['schemas']['Metric']['properties']['metricName']['enumDescriptions'][39]UDM data summary tracking unique values of dimensions.
root['schemas']['UserError']['properties']['reason']['enum'][25]UNIQUE_FIELD_CONFLICT
root['schemas']['UserError']['properties']['reason']['enumDescriptions'][25]The resource that the user is trying to create already exists. Example ErrorInfo: { "reason": "UNIQUE_FIELD_CONFLICT", "metadata": { "conflicting_fields": "[{\"field_name\": \"display_name\", \"value\": \"display_name\"}]" } }
prod/eu-rbmopenmaap-
values_changed
root['revision']
new_value20250724
old_value20250721
prod/eu-rbmopenmaap-v1
values_changed
root['revision']
new_value20250724
old_value20250721
prod/europe-west1-connectgateway-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/europe-west1-connectgateway-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/europe-west1-connectgateway-v1beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/europe-west1-containerfilesystem-
values_changed
root['revision']
new_value20250719
old_value20250714
prod/europe-west1-containerfilesystem-v1
values_changed
root['revision']
new_value20250719
old_value20250714
prod/europe-west2-containerfilesystem-
values_changed
root['revision']
new_value20250719
old_value20250714
prod/europe-west2-containerfilesystem-v1
values_changed
root['revision']
new_value20250719
old_value20250714
prod/familymanagement-pa-
values_changed
root['revision']
new_value20250724
old_value20250721
prod/familymanagement-pa-v1
values_changed
root['revision']
new_value20250724
old_value20250721
prod/firebaseapptesters-
values_changed
root['revision']
new_value20250723
old_value20250722
prod/firebaseapptesters-v1
values_changed
root['revision']
new_value20250723
old_value20250722
prod/firebaseapptesters-v1alpha
values_changed
root['revision']
new_value20250723
old_value20250722
prod/firebasecrashlytics-
values_changed
root['revision']
new_value20250724
old_value20250722
prod/firebasecrashlytics-v1alpha
values_changed
root['revision']
new_value20250724
old_value20250722
prod/firebaseextensions-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/firebaseextensions-v1beta
values_changed
root['revision']
new_value20250723
old_value20250721
prod/firebaseextensionspublisher-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/firebaseextensionspublisher-v1beta
values_changed
root['revision']
new_value20250723
old_value20250721
prod/firebaseremoteconfigrealtime-
values_changed
root['revision']
new_value20250724
old_value20250721
prod/firebaseremoteconfigrealtime-v1
values_changed
root['revision']
new_value20250724
old_value20250721
prod/fit-
values_changed
root['revision']
new_value20250723
old_value20250720
prod/fit-v2beta1
values_changed
root['revision']
new_value20250723
old_value20250720
prod/floodforecasting-
values_changed
root['revision']
new_value20250723
old_value20250720
prod/floodforecasting-v1
values_changed
root['revision']
new_value20250723
old_value20250720
prod/generativelanguage-
values_changed
root['revision']
new_value20250724
old_value20250721
prod/generativelanguage-v1
values_changed
root['revision']
new_value20250724
old_value20250721
prod/generativelanguage-v1alpha
values_changed
root['revision']
new_value20250724
old_value20250721
prod/generativelanguage-v1beta
values_changed
root['revision']
new_value20250724
old_value20250721
prod/generativelanguage-v1beta1
values_changed
root['revision']
new_value20250724
old_value20250721
prod/generativelanguage-v1beta2
values_changed
root['revision']
new_value20250724
old_value20250721
prod/generativelanguage-v1beta3
values_changed
root['revision']
new_value20250724
old_value20250721
prod/geoar-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/geoar-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/geocoding-backend-
values_changed
root['revision']
new_value20250723
old_value20250722
prod/geofeedtaskrouting-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/geofeedtaskrouting-v1alpha
values_changed
root['revision']
new_value20250723
old_value20250721
prod/growth-pa-
values_changed
root['revision']
new_value20250721
old_value20250718
prod/growth-pa-v1
values_changed
root['revision']
new_value20250721
old_value20250718
prod/gsuiteaddons-
values_changed
root['revision']
new_value20250721
old_value20250714
prod/gsuiteaddons-v1
values_changed
root['revision']
new_value20250721
old_value20250714
prod/gsuiteaddons-v1alpha1
values_changed
root['revision']
new_value20250721
old_value20250714
prod/guidedhelp-pa-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/guidedhelp-pa-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/guts-
values_changed
root['revision']
new_value20250724
old_value20250717
root['schemas']['AvengMacs']['properties']
new_value
avIntegratorName
typestring
avIntegratorPjm
typestring
avengMacsProgram
typestring
avmBuilding
typestring
avmEscalation
typestring
avmHandoverBug
typestring
avmNumBass
typestring
avmNumCustom
typestring
avmRoomId
typestring
avmRoomName
typestring
avmTags
typestring
bpDueDate
$refDate
bpEquipmentEta
$refDate
bpFinalLocation
typestring
bpFinancialCode
typestring
bpHeadcount
typestring
bpLocker
typestring
bpPoReference
typestring
bpPower
typestring
bpProjectPhase
typestring
bpRegion
typestring
bpRequestorGroup
typestring
bpStuffStation
typestring
bpStuffStationPlus
typestring
bpTags
typestring
bpWorkfrontReference
typestring
building
typestring
buildingName
typestring
completionPhotosLink
typestring
deploymentEndDate
$refDate
deploymentStartDate
$refDate
installationDate
$refDate
integrator
typestring
loe
typestring
numDashboard
typestring
numDisplays32
typestring
numDisplays42
typestring
numDisplays43
typestring
numDisplays49
typestring
numDisplays55
typestring
numDisplays65
typestring
numDisplays70
typestring
numDisplays75
typestring
numDisplays86
typestring
numDisplays98
typestring
numDisplaysDeployed
typestring
numDisplaysOther
typestring
numJamboard
typestring
numKitchenSync
typestring
numLargeConferenceRoom
typestring
numLogitechScribe
typestring
numMediumConferenceRoom
typestring
numMeetKits
typestring
numMprSprintRoom
typestring
numOther
typestring
numPhoneRoom
typestring
numProjectors
typestring
numSmallConferenceRoom
typestring
numStandBasedGvc
typestring
numTtTr
typestring
numUxLab
typestring
primaryFundingSource
typestring
programStatistics
typeboolean
projectCancelled
typeboolean
roomServiceLink
typestring
spacesDeployed
typestring
systemType
typestring
tags
items
typestring
typearray
taskflow
typestring
workflow
typestring
workfrontReferenceNumber
typestring
old_value
avengMacsProgram
typestring
bpDueDate
$refDate
bpEquipmentEta
$refDate
bpFinalLocation
typestring
bpFinancialCode
typestring
bpHeadcount
typestring
bpLocker
typestring
bpPoReference
typestring
bpPower
typestring
bpProjectPhase
typestring
bpRegion
typestring
bpRequestorGroup
typestring
bpStuffStation
typestring
bpStuffStationPlus
typestring
bpTags
typestring
bpWorkfrontReference
typestring
building
typestring
buildingName
typestring
installationDate
$refDate
integrator
typestring
tags
items
typestring
typearray
workfrontReferenceNumber
typestring
prod/guts-v3
values_changed
root['revision']
new_value20250724
old_value20250717
root['schemas']['AvengMacs']['properties']
new_value
avIntegratorName
typestring
avIntegratorPjm
typestring
avengMacsProgram
typestring
avmBuilding
typestring
avmEscalation
typestring
avmHandoverBug
typestring
avmNumBass
typestring
avmNumCustom
typestring
avmRoomId
typestring
avmRoomName
typestring
avmTags
typestring
bpDueDate
$refDate
bpEquipmentEta
$refDate
bpFinalLocation
typestring
bpFinancialCode
typestring
bpHeadcount
typestring
bpLocker
typestring
bpPoReference
typestring
bpPower
typestring
bpProjectPhase
typestring
bpRegion
typestring
bpRequestorGroup
typestring
bpStuffStation
typestring
bpStuffStationPlus
typestring
bpTags
typestring
bpWorkfrontReference
typestring
building
typestring
buildingName
typestring
completionPhotosLink
typestring
deploymentEndDate
$refDate
deploymentStartDate
$refDate
installationDate
$refDate
integrator
typestring
loe
typestring
numDashboard
typestring
numDisplays32
typestring
numDisplays42
typestring
numDisplays43
typestring
numDisplays49
typestring
numDisplays55
typestring
numDisplays65
typestring
numDisplays70
typestring
numDisplays75
typestring
numDisplays86
typestring
numDisplays98
typestring
numDisplaysDeployed
typestring
numDisplaysOther
typestring
numJamboard
typestring
numKitchenSync
typestring
numLargeConferenceRoom
typestring
numLogitechScribe
typestring
numMediumConferenceRoom
typestring
numMeetKits
typestring
numMprSprintRoom
typestring
numOther
typestring
numPhoneRoom
typestring
numProjectors
typestring
numSmallConferenceRoom
typestring
numStandBasedGvc
typestring
numTtTr
typestring
numUxLab
typestring
primaryFundingSource
typestring
programStatistics
typeboolean
projectCancelled
typeboolean
roomServiceLink
typestring
spacesDeployed
typestring
systemType
typestring
tags
items
typestring
typearray
taskflow
typestring
workflow
typestring
workfrontReferenceNumber
typestring
old_value
avengMacsProgram
typestring
bpDueDate
$refDate
bpEquipmentEta
$refDate
bpFinalLocation
typestring
bpFinancialCode
typestring
bpHeadcount
typestring
bpLocker
typestring
bpPoReference
typestring
bpPower
typestring
bpProjectPhase
typestring
bpRegion
typestring
bpRequestorGroup
typestring
bpStuffStation
typestring
bpStuffStationPlus
typestring
bpTags
typestring
bpWorkfrontReference
typestring
building
typestring
buildingName
typestring
installationDate
$refDate
integrator
typestring
tags
items
typestring
typearray
workfrontReferenceNumber
typestring
prod/hangouts-
values_changed
root['revision']
new_value20250723
old_value20250720
prod/hangouts-v1
values_changed
root['revision']
new_value20250723
old_value20250720
prod/hourly-dynamicmail-pa.sandbox-
values_changed
root['revision']
new_value20250725
old_value20250722
prod/hourly-dynamicmail-pa.sandbox-v2
values_changed
root['revision']
new_value20250725
old_value20250722
prod/ipprotection-ppissuer-
values_changed
root['revision']
new_value20250724
old_value20250722
prod/ipprotection-ppissuer-v1
values_changed
root['revision']
new_value20250724
old_value20250722
prod/kidsmanagement-pa-
values_changed
root['revision']
new_value20250724
old_value20250722
prod/kidsmanagement-pa-v1
values_changed
root['revision']
new_value20250724
old_value20250722
prod/licensemanager-
values_changed
root['revision']
new_value20250721
old_value20250716
prod/licensemanager-v1
values_changed
root['revision']
new_value20250721
old_value20250716
prod/licensemanager-v1alpha
values_changed
root['revision']
new_value20250721
old_value20250716
prod/linkauthorization-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/linkauthorization-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/localservicespartner-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/localservicespartner-v1beta1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/lustre-
values_changed
root['revision']
new_value20250716
old_value20250710
prod/lustre-v1
values_changed
root['revision']
new_value20250716
old_value20250710
prod/lustre-v1alpha
values_changed
root['revision']
new_value20250716
old_value20250710
prod/mapsplatformdatasets-
values_changed
root['revision']
new_value20250723
old_value20250720
prod/mapsplatformdatasets-v1
values_changed
root['revision']
new_value20250723
old_value20250720
prod/mapsplatformdatasets-v1alpha
values_changed
root['revision']
new_value20250723
old_value20250720
prod/media3p-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/media3p-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/mlengine-pa-
dictionary_item_added
  • root['resources']['v1']
dictionary_item_removed
  • root['auth']
  • root['resources']['projects']['methods']
values_changed
root['baseUrl']
new_valuehttps://mlengine-pa.googleapis.com/
old_valuehttps://ml.googleapis.com/
root['canonicalName']
new_valueMachine Learning Engine Private Service
old_valueCloud Machine Learning Engine
root['description']
new_valuePrivate API to manages internal resources for Cloud ML Engine.
old_valueAn API to enable creating and using machine learning models.
root['documentationLink']
new_valuehttp://go/cloud-mlengine-private
old_valuehttps://cloud.google.com/ml/
root['id']
new_valuemlengine_pa:v1
old_valueml:v1
root['mtlsRootUrl']
new_valuehttps://mlengine-pa.mtls.googleapis.com/
old_valuehttps://ml.mtls.googleapis.com/
root['name']
new_valuemlengine_pa
old_valueml
root['resources']['projects']['resources']
new_value
trainingJob
resources
trainingWorker
methods
reportStatus
descriptionReportStatus reports the status of the worker to the control plane.
flatPathv1/projects/{projectId}/trainingJob/{trainingJobId}/trainingWorker/{trainingWorkerId}:reportStatus
httpMethodPOST
idmlengine_pa.projects.trainingJob.trainingWorker.reportStatus
parameterOrder
  • projectId
  • trainingJobId
  • trainingWorkerId
parameters
projectId
descriptionThe ID of the project where the Cloud ML compute resources are running ( a.k.a. the shadow project).
locationpath
requiredTrue
typestring
trainingJobId
descriptionThe ID of the Cloud ML training job.
locationpath
requiredTrue
typestring
trainingWorkerId
descriptionThe ID of the worker (i.e., the instance ID of the virtual machine running the Cloud ML worker process).
locationpath
requiredTrue
typestring
pathv1/projects/{projectId}/trainingJob/{trainingJobId}/trainingWorker/{trainingWorkerId}:reportStatus
request
$refReportStatusRequest
response
$refReportStatusResponse
old_value
jobs
methods
cancel
descriptionCancels a running job.
flatPathv1/projects/{projectsId}/jobs/{jobsId}:cancel
httpMethodPOST
idml.projects.jobs.cancel
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the job to cancel.
locationpath
pattern^projects/[^/]+/jobs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:cancel
request
$refGoogleCloudMlV1__CancelJobRequest
response
$refGoogleProtobuf__Empty
scopes
  • https://www.googleapis.com/auth/cloud-platform
create
descriptionCreates a training or a batch prediction job.
flatPathv1/projects/{projectsId}/jobs
httpMethodPOST
idml.projects.jobs.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. The project name.
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/jobs
request
$refGoogleCloudMlV1__Job
response
$refGoogleCloudMlV1__Job
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionDescribes a job.
flatPathv1/projects/{projectsId}/jobs/{jobsId}
httpMethodGET
idml.projects.jobs.get
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the job to get the description of.
locationpath
pattern^projects/[^/]+/jobs/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleCloudMlV1__Job
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
getIamPolicy
descriptionGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
flatPathv1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy
httpMethodGET
idml.projects.jobs.getIamPolicy
parameterOrder
  • resource
parameters
options.requestedPolicyVersion
descriptionOptional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
formatint32
locationquery
typeinteger
resource
descriptionREQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/jobs/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:getIamPolicy
response
$refGoogleIamV1__Policy
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}.
flatPathv1/projects/{projectsId}/jobs
httpMethodGET
idml.projects.jobs.list
parameterOrder
  • parent
parameters
filter
descriptionOptional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census': gcloud ai-platform jobs list --filter='jobId:census*' List all failed jobs with names that start with 'rnn': gcloud ai-platform jobs list --filter='jobId:rnn* AND state:FAILED' For more examples, see the guide to monitoring jobs.
locationquery
typestring
pageSize
descriptionOptional. The number of jobs to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
locationquery
typestring
parent
descriptionRequired. The name of the project for which to list jobs.
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/jobs
response
$refGoogleCloudMlV1__ListJobsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
patch
descriptionUpdates a specific job resource. Currently the only supported fields to update are `labels`.
flatPathv1/projects/{projectsId}/jobs/{jobsId}
httpMethodPATCH
idml.projects.jobs.patch
parameterOrder
  • name
parameters
name
descriptionRequired. The job name.
locationpath
pattern^projects/[^/]+/jobs/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired. Specifies the path, relative to `Job`, of the field to update. To adopt etag mechanism, include `etag` field in the mask, and include the `etag` value in your job resource. For example, to change the labels of a job, the `update_mask` parameter would be specified as `labels`, `etag`, and the `PATCH` request body would specify the new value, as follows: { "labels": { "owner": "Google", "color": "Blue" } "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4" } If `etag` matches the one on the server, the labels of the job will be replaced with the given ones, and the server end `etag` will be recalculated. Currently the only supported update masks are `labels` and `etag`.
formatgoogle-fieldmask
locationquery
typestring
pathv1/{+name}
request
$refGoogleCloudMlV1__Job
response
$refGoogleCloudMlV1__Job
scopes
  • https://www.googleapis.com/auth/cloud-platform
setIamPolicy
descriptionSets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
flatPathv1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy
httpMethodPOST
idml.projects.jobs.setIamPolicy
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/jobs/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:setIamPolicy
request
$refGoogleIamV1__SetIamPolicyRequest
response
$refGoogleIamV1__Policy
scopes
  • https://www.googleapis.com/auth/cloud-platform
testIamPermissions
descriptionReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
flatPathv1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions
httpMethodPOST
idml.projects.jobs.testIamPermissions
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/jobs/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:testIamPermissions
request
$refGoogleIamV1__TestIamPermissionsRequest
response
$refGoogleIamV1__TestIamPermissionsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
locations
methods
get
descriptionGet the complete list of CMLE capabilities in a location, along with their location-specific properties.
flatPathv1/projects/{projectsId}/locations/{locationsId}
httpMethodGET
idml.projects.locations.get
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the location.
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleCloudMlV1__Location
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
list
descriptionList all locations that provides at least one type of CMLE capability.
flatPathv1/projects/{projectsId}/locations
httpMethodGET
idml.projects.locations.list
parameterOrder
  • parent
parameters
pageSize
descriptionOptional. The number of locations to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
locationquery
typestring
parent
descriptionRequired. The name of the project for which available locations are to be listed (since some locations might be whitelisted for specific projects).
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/locations
response
$refGoogleCloudMlV1__ListLocationsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
resources
operations
methods
cancel
descriptionStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
flatPathv1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
httpMethodPOST
idml.projects.locations.operations.cancel
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource to be cancelled.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1/{+name}:cancel
response
$refGoogleProtobuf__Empty
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
flatPathv1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
httpMethodGET
idml.projects.locations.operations.get
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
studies
methods
create
descriptionCreates a study.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies
httpMethodPOST
idml.projects.locations.studies.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. The project and location that the study belongs to. Format: projects/{project}/locations/{location}
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
studyId
descriptionRequired. The ID to use for the study, which will become the final component of the study's resource name.
locationquery
typestring
pathv1/{+parent}/studies
request
$refGoogleCloudMlV1__Study
response
$refGoogleCloudMlV1__Study
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes a study.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}
httpMethodDELETE
idml.projects.locations.studies.delete
parameterOrder
  • name
parameters
name
descriptionRequired. The study name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleProtobuf__Empty
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets a study.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}
httpMethodGET
idml.projects.locations.studies.get
parameterOrder
  • name
parameters
name
descriptionRequired. The study name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleCloudMlV1__Study
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists all the studies in a region for an associated project.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies
httpMethodGET
idml.projects.locations.studies.list
parameterOrder
  • parent
parameters
parent
descriptionRequired. The project and location that the study belongs to. Format: projects/{project}/locations/{location}
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/studies
response
$refGoogleCloudMlV1__ListStudiesResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
resources
trials
methods
addMeasurement
descriptionAdds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addMeasurement
httpMethodPOST
idml.projects.locations.studies.trials.addMeasurement
parameterOrder
  • name
parameters
name
descriptionRequired. The trial name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
requiredTrue
typestring
pathv1/{+name}:addMeasurement
request
$refGoogleCloudMlV1__AddTrialMeasurementRequest
response
$refGoogleCloudMlV1__Trial
scopes
  • https://www.googleapis.com/auth/cloud-platform
checkEarlyStoppingState
descriptionChecks whether a trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkEarlyStoppingState
httpMethodPOST
idml.projects.locations.studies.trials.checkEarlyStoppingState
parameterOrder
  • name
parameters
name
descriptionRequired. The trial name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
requiredTrue
typestring
pathv1/{+name}:checkEarlyStoppingState
request
$refGoogleCloudMlV1__CheckTrialEarlyStoppingStateRequest
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
complete
descriptionMarks a trial as complete.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete
httpMethodPOST
idml.projects.locations.studies.trials.complete
parameterOrder
  • name
parameters
name
descriptionRequired. The trial name.metat
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
requiredTrue
typestring
pathv1/{+name}:complete
request
$refGoogleCloudMlV1__CompleteTrialRequest
response
$refGoogleCloudMlV1__Trial
scopes
  • https://www.googleapis.com/auth/cloud-platform
create
descriptionAdds a user provided trial to a study.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials
httpMethodPOST
idml.projects.locations.studies.trials.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. The name of the study that the trial belongs to.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/trials
request
$refGoogleCloudMlV1__Trial
response
$refGoogleCloudMlV1__Trial
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes a trial.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}
httpMethodDELETE
idml.projects.locations.studies.trials.delete
parameterOrder
  • name
parameters
name
descriptionRequired. The trial name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleProtobuf__Empty
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets a trial.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}
httpMethodGET
idml.projects.locations.studies.trials.get
parameterOrder
  • name
parameters
name
descriptionRequired. The trial name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleCloudMlV1__Trial
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists the trials associated with a study.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials
httpMethodGET
idml.projects.locations.studies.trials.list
parameterOrder
  • parent
parameters
parent
descriptionRequired. The name of the study that the trial belongs to.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/trials
response
$refGoogleCloudMlV1__ListTrialsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
listOptimalTrials
descriptionLists 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
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials
httpMethodPOST
idml.projects.locations.studies.trials.listOptimalTrials
parameterOrder
  • parent
parameters
parent
descriptionRequired. The name of the study that the pareto-optimal trial belongs to.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/trials:listOptimalTrials
request
$refGoogleCloudMlV1__ListOptimalTrialsRequest
response
$refGoogleCloudMlV1__ListOptimalTrialsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
stop
descriptionStops a trial.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop
httpMethodPOST
idml.projects.locations.studies.trials.stop
parameterOrder
  • name
parameters
name
descriptionRequired. The trial name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
requiredTrue
typestring
pathv1/{+name}:stop
request
$refGoogleCloudMlV1__StopTrialRequest
response
$refGoogleCloudMlV1__Trial
scopes
  • https://www.googleapis.com/auth/cloud-platform
suggest
descriptionAdds one or more trials to a study, with parameter values suggested by AI Platform Vizier. Returns a long-running operation associated with the generation of trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest
httpMethodPOST
idml.projects.locations.studies.trials.suggest
parameterOrder
  • parent
parameters
parent
descriptionRequired. The name of the study that the trial belongs to.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/trials:suggest
request
$refGoogleCloudMlV1__SuggestTrialsRequest
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
models
methods
create
descriptionCreates a model which will later contain one or more versions. You must add at least one version before you can request predictions from the model. Add versions by calling projects.models.versions.create.
flatPathv1/projects/{projectsId}/models
httpMethodPOST
idml.projects.models.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. The project name.
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/models
request
$refGoogleCloudMlV1__Model
response
$refGoogleCloudMlV1__Model
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes a model. You can only delete a model if there are no versions in it. You can delete versions by calling projects.models.versions.delete.
flatPathv1/projects/{projectsId}/models/{modelsId}
httpMethodDELETE
idml.projects.models.delete
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the model.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets information about a model, including its name, the description (if set), and the default version (if at least one version of the model has been deployed).
flatPathv1/projects/{projectsId}/models/{modelsId}
httpMethodGET
idml.projects.models.get
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the model.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleCloudMlV1__Model
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
getIamPolicy
descriptionGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
flatPathv1/projects/{projectsId}/models/{modelsId}:getIamPolicy
httpMethodGET
idml.projects.models.getIamPolicy
parameterOrder
  • resource
parameters
options.requestedPolicyVersion
descriptionOptional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
formatint32
locationquery
typeinteger
resource
descriptionREQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:getIamPolicy
response
$refGoogleIamV1__Policy
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the request parameters, the list request returns an empty response body: {}.
flatPathv1/projects/{projectsId}/models
httpMethodGET
idml.projects.models.list
parameterOrder
  • parent
parameters
filter
descriptionOptional. Specifies the subset of models to retrieve.
locationquery
typestring
pageSize
descriptionOptional. The number of models to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
locationquery
typestring
parent
descriptionRequired. The name of the project whose models are to be listed.
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/models
response
$refGoogleCloudMlV1__ListModelsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
patch
descriptionUpdates a specific model resource. Currently the only supported fields to update are `description` and `default_version.name`.
flatPathv1/projects/{projectsId}/models/{modelsId}
httpMethodPATCH
idml.projects.models.patch
parameterOrder
  • name
parameters
name
descriptionRequired. The project name.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired. Specifies the path, relative to `Model`, of the field to update. For example, to change the description of a model to "foo" and set its default version to "version_1", the `update_mask` parameter would be specified as `description`, `default_version.name`, and the `PATCH` request body would specify the new value, as follows: { "description": "foo", "defaultVersion": { "name":"version_1" } } Currently the supported update masks are `description` and `default_version.name`.
formatgoogle-fieldmask
locationquery
typestring
pathv1/{+name}
request
$refGoogleCloudMlV1__Model
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
setIamPolicy
descriptionSets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
flatPathv1/projects/{projectsId}/models/{modelsId}:setIamPolicy
httpMethodPOST
idml.projects.models.setIamPolicy
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:setIamPolicy
request
$refGoogleIamV1__SetIamPolicyRequest
response
$refGoogleIamV1__Policy
scopes
  • https://www.googleapis.com/auth/cloud-platform
testIamPermissions
descriptionReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
flatPathv1/projects/{projectsId}/models/{modelsId}:testIamPermissions
httpMethodPOST
idml.projects.models.testIamPermissions
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:testIamPermissions
request
$refGoogleIamV1__TestIamPermissionsRequest
response
$refGoogleIamV1__TestIamPermissionsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
resources
versions
methods
create
descriptionCreates a new version of a model from a trained TensorFlow model. If the version created in the cloud by this call is the first deployed version of the specified model, it will be made the default version of the model. When you add a version to a model that already has one or more versions, the default version does not automatically change. If you want a new version to be the default, you must call projects.models.versions.setDefault.
flatPathv1/projects/{projectsId}/models/{modelsId}/versions
httpMethodPOST
idml.projects.models.versions.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. The name of the model.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/versions
request
$refGoogleCloudMlV1__Version
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes a model version. Each model can have multiple versions deployed and in use at any given time. Use this method to remove a single version. Note: You cannot delete the version that is set as the default version of the model unless it is the only remaining version.
flatPathv1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}
httpMethodDELETE
idml.projects.models.versions.delete
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the version. You can get the names of all the versions of a model by calling projects.models.versions.list.
locationpath
pattern^projects/[^/]+/models/[^/]+/versions/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets information about a model version. Models can have multiple versions. You can call projects.models.versions.list to get the same information that this method returns for all of the versions of a model.
flatPathv1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}
httpMethodGET
idml.projects.models.versions.get
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the version.
locationpath
pattern^projects/[^/]+/models/[^/]+/versions/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleCloudMlV1__Version
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionGets basic information about all the versions of a model. If you expect that a model has many versions, or if you need to handle only a limited number of results at a time, you can request that the list be retrieved in batches (called pages). If there are no versions that match the request parameters, the list request returns an empty response body: {}.
flatPathv1/projects/{projectsId}/models/{modelsId}/versions
httpMethodGET
idml.projects.models.versions.list
parameterOrder
  • parent
parameters
filter
descriptionOptional. Specifies the subset of versions to retrieve.
locationquery
typestring
pageSize
descriptionOptional. The number of versions to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
locationquery
typestring
parent
descriptionRequired. The name of the model for which to list the version.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/versions
response
$refGoogleCloudMlV1__ListVersionsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
patch
descriptionUpdates the specified Version resource. Currently the only update-able fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`.
flatPathv1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}
httpMethodPATCH
idml.projects.models.versions.patch
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the model.
locationpath
pattern^projects/[^/]+/models/[^/]+/versions/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: ``` { "description": "foo" } ``` Currently the only supported update mask fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. However, you can only update `manualScaling.nodes` if the version uses a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction).
formatgoogle-fieldmask
locationquery
typestring
pathv1/{+name}
request
$refGoogleCloudMlV1__Version
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
setDefault
descriptionDesignates a version to be the default for the model. The default version is used for prediction requests made against the model that don't specify a version. The first version to be created for a model is automatically set as the default. You must make any subsequent changes to the default version setting manually using this method.
flatPathv1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault
httpMethodPOST
idml.projects.models.versions.setDefault
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the version to make the default for the model. You can get the names of all the versions of a model by calling projects.models.versions.list.
locationpath
pattern^projects/[^/]+/models/[^/]+/versions/[^/]+$
requiredTrue
typestring
pathv1/{+name}:setDefault
request
$refGoogleCloudMlV1__SetDefaultVersionRequest
response
$refGoogleCloudMlV1__Version
scopes
  • https://www.googleapis.com/auth/cloud-platform
operations
methods
cancel
descriptionStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
flatPathv1/projects/{projectsId}/operations/{operationsId}:cancel
httpMethodPOST
idml.projects.operations.cancel
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource to be cancelled.
locationpath
pattern^projects/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1/{+name}:cancel
response
$refGoogleProtobuf__Empty
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
flatPathv1/projects/{projectsId}/operations/{operationsId}
httpMethodGET
idml.projects.operations.get
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource.
locationpath
pattern^projects/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
flatPathv1/projects/{projectsId}/operations
httpMethodGET
idml.projects.operations.list
parameterOrder
  • name
parameters
filter
descriptionThe standard list filter.
locationquery
typestring
name
descriptionThe name of the operation's parent resource.
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pageSize
descriptionThe standard list page size.
formatint32
locationquery
typeinteger
pageToken
descriptionThe standard list page token.
locationquery
typestring
pathv1/{+name}/operations
response
$refGoogleLongrunning__ListOperationsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
root['revision']
new_value20250613
old_value20250118
root['rootUrl']
new_valuehttps://mlengine-pa.googleapis.com/
old_valuehttps://ml.googleapis.com/
root['schemas']
new_value
AcceleratorSpecs
idAcceleratorSpecs
properties
acceleratorType
descriptionRequired. The type of GPU.
enum
  • ACCELERATOR_TYPE_UNSPECIFIED
  • NVIDIA_TESLA_K80
  • NVIDIA_TESLA_P100
  • NVIDIA_TESLA_V100
  • NVIDIA_TESLA_P4
  • NVIDIA_TESLA_T4
  • NVIDIA_TESLA_A100
  • TPU_V2
  • TPU_V3
  • TPU_V2_POD
  • TPU_V3_POD
  • TPU_V4_POD
enumDescriptions
  • Unspecified accelerator type. Default to no GPU.
  • Nvidia Tesla K80 GPU.
  • Nvidia Tesla P100 GPU.
  • Nvidia V100 GPU.
  • Nvidia Tesla P4 GPU.
  • Nvidia T4 GPU.
  • Nvidia A100 GPU.
  • TPU v2.
  • TPU v3.
  • TPU v2 POD.
  • TPU v3 POD.
  • TPU v4 POD.
typestring
allowedCount
descriptionRequired. The number of GPUs allowed in this combination. Cannot be zero.
items
formatdouble
typenumber
typearray
typeobject
AcceleratorsListByRegion
descriptionFor each region, the list of eccelerators available.
idAcceleratorsListByRegion
properties
accelerators
items
enum
  • ACCELERATOR_TYPE_UNSPECIFIED
  • NVIDIA_TESLA_K80
  • NVIDIA_TESLA_P100
  • NVIDIA_TESLA_V100
  • NVIDIA_TESLA_P4
  • NVIDIA_TESLA_T4
  • NVIDIA_TESLA_A100
  • TPU_V2
  • TPU_V3
  • TPU_V2_POD
  • TPU_V3_POD
  • TPU_V4_POD
enumDescriptions
  • Unspecified accelerator type. Default to no GPU.
  • Nvidia Tesla K80 GPU.
  • Nvidia Tesla P100 GPU.
  • Nvidia V100 GPU.
  • Nvidia Tesla P4 GPU.
  • Nvidia T4 GPU.
  • Nvidia A100 GPU.
  • TPU v2.
  • TPU v3.
  • TPU v2 POD.
  • TPU v3 POD.
  • TPU v4 POD.
typestring
typearray
region
typestring
typeobject
AvailableAccelerators
idAvailableAccelerators
properties
acceleratorsListByRegion
descriptionList of all accelerators per region for training.
items
$refAcceleratorsListByRegion
typearray
opAcceleratorsListByRegion
descriptionList of all accelerators per region for online prediction.
items
$refAcceleratorsListByRegion
typearray
typeobject
AvailableMachines
idAvailableMachines
properties
availableGceMachineTypes
descriptionList of all GCE machine Types with available accelerators.
items
$refMachineSpecs
typearray
availableOpGceMachineTypes
descriptionList of all online prediction GCE machine Types with available accelerators.
items
$refMachineSpecs
typearray
typeobject
Config
descriptionApi configuration of Cloud ML frontend. Contains information that the end user need to know such as supported machine types, and information about CMLE runtime versions.
idConfig
properties
machineTypes
descriptionList of all available machine types.
items
$refMachineType
typearray
opRuntimeVersions
descriptionList of all available CMLE OP only runtime versions.
items
$refRuntimeVersion
typearray
runtimeVersions
descriptionList of all available CMLE runtime versions.
items
$refRuntimeVersion
typearray
typeobject
ContainerState
descriptionContainerState stores the current state of the container. See this reference for more details: https://docs.docker.com/engine/api/v1.30/#
idContainerState
properties
customContainerImagePullError
descriptionThe details of error happened when pulling the custom container image. This field is populated if custom_container_image_pull_state = FAILURE.
typestring
customContainerImagePullState
descriptionThe state of pulling custom container image. The possible values are "PULLING", "SUCCESS" and "FAILURE".
typestring
dead
descriptionWhether the container is dead.
typeboolean
diskUsagePercentage
descriptionDisk usage percentage of "/". The value is between [0, 100].
formatint32
typeinteger
error
descriptionThe error returned by the container
typestring
exitCode
descriptionThe exit code if the container finished.
formatint64
typestring
finishedAt
descriptionWhen the container finished.
formatgoogle-datetime
typestring
isStuckInGettingState
descriptionWhether the container is stuck in getting state
typeboolean
nfsMountError
descriptionThe error occurred when mounting nfs server
typestring
oomKilled
descriptionWhether the container has run out of memory.
typeboolean
paused
descriptionWhether the container is paused.
typeboolean
pid
descriptionThe PID of the container.
formatint64
typestring
restarting
descriptionWhether the container is restarting.
typeboolean
running
descriptionWhether the container is running.
typeboolean
startedAt
descriptionWhen the container started.
formatgoogle-datetime
typestring
status
descriptionThe current status.
typestring
terminationLog
descriptionThe termination log generated by that container.
typestring
trainingContainerImagePullEndTime
descriptionThe end time of the pulling the training container image.
formatgoogle-datetime
typestring
trainingContainerImagePullStartTime
descriptionThe start time of the pulling the training container image.
formatgoogle-datetime
typestring
typeobject
ContainerStatus
descriptionContainerStatusReport provides information about a single container
idContainerStatus
properties
args
descriptionThe arguments to the command being run.
items
typestring
typearray
containerId
descriptionThe container ID used in the Spanner table key. It is identical for all training containers.
typestring
createdAt
descriptionWhen the container was created.
formatgoogle-datetime
typestring
dockerId
descriptionThe ID of this container, according to Docker.
typestring
dockerName
descriptionThe name of this container, according to Docker.
typestring
image
descriptionThe container's image.
typestring
lastUpdatedAt
descriptionWhen the status of the container was last updated.
formatgoogle-datetime
typestring
path
descriptionThe path to the command being run.
typestring
restartCount
descriptionThe number of times the container restarted.
formatint32
typeinteger
state
$refContainerState
descriptionThe state of the container.
typeobject
FrameworkVersion
descriptionRepresents a specific version of a framework.
idFrameworkVersion
properties
framework
enum
  • FRAMEWORK_UNSPECIFIED
  • TENSORFLOW
  • SCIKIT_LEARN
  • XGBOOST
enumDescriptions
  • Unspecified framework. Assigns a value based on the file suffix.
  • Tensorflow framework.
  • Scikit-learn framework.
  • XGBoost framework.
typestring
version
typestring
typeobject
MachineSpecs
idMachineSpecs
properties
availableAccelerators
descriptionOptional. Different accelerator configurations allowed.
items
$refAcceleratorSpecs
typearray
cpus
descriptionAvailable number of CPUs
formatdouble
typenumber
gceMachineName
descriptionRequired. GCE machine name.
typestring
ramBytes
descriptionAvailable RAM size.
formatuint64
typestring
typeobject
MachineType
idMachineType
properties
name
typestring
typeobject
ReportStatusRequest
descriptionReportStatusRequest is a request to report the status of a worker to the control plane.
idReportStatusRequest
properties
clusterName
descriptionThe name of the JMS cluster on which the container is running.
typestring
consumerProjectId
descriptionThe ID of the consumer project associated with the shadow project.
typestring
containerStatuses
descriptionThe status of the containers running on the virtual machine.
items
$refContainerStatus
typearray
typeobject
ReportStatusResponse
descriptionReportStatusTrainingWorkerResponse is the response from the control plane to worker status reports.
idReportStatusResponse
properties
typeobject
RuntimeVersion
descriptionCloud Machine Learning Engine uses images, based on runtime version designation, to configure cloud resources to service your training and prediction requests. Each `RuntimeVersion` contains information about its constituent packages.
idRuntimeVersion
properties
frameworks
descriptionList of all supported frameworks in this `RuntimeVersion` and their corresponding versions.
items
$refFrameworkVersion
typearray
libraries
additionalProperties
typestring
descriptionMap of each library and its corresponding version that is available in this runtime_version, similar to what is available in: https://cloud.google.com/ml-engine/docs/tensorflow/runtime-version-list Example: "numpy": "1.13.3", "pandas": "0.19.2", etc.
typeobject
name
typestring
supportedPythonVersions
descriptionList of all supported python versions for this runtime version. Note that these python versions are supported by all `frameworks`.
items
typestring
typearray
typeobject
old_value
GoogleApi__HttpBody
descriptionMessage that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
idGoogleApi__HttpBody
properties
contentType
descriptionThe HTTP Content-Type header value specifying the content type of the body.
typestring
data
descriptionThe HTTP request/response body as raw binary.
formatbyte
typestring
extensions
descriptionApplication specific response metadata. Must be set in the first response for streaming APIs.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
typeobject
GoogleCloudMlV1_AutomatedStoppingConfig_DecayCurveAutomatedStoppingConfig
idGoogleCloudMlV1_AutomatedStoppingConfig_DecayCurveAutomatedStoppingConfig
properties
useElapsedTime
descriptionIf true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
typeboolean
typeobject
GoogleCloudMlV1_AutomatedStoppingConfig_MedianAutomatedStoppingConfig
descriptionThe 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.
idGoogleCloudMlV1_AutomatedStoppingConfig_MedianAutomatedStoppingConfig
properties
useElapsedTime
descriptionIf true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial.
typeboolean
typeobject
GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric
descriptionAn observed value of a metric.
idGoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric
properties
objectiveValue
descriptionThe objective value at this training step.
formatdouble
typenumber
trainingStep
descriptionThe global training step for this metric.
formatint64
typestring
typeobject
GoogleCloudMlV1_Measurement_Metric
descriptionA message representing a metric in the measurement.
idGoogleCloudMlV1_Measurement_Metric
properties
metric
descriptionRequired. Metric name.
typestring
value
descriptionRequired. The value for this metric.
formatdouble
typenumber
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_CategoricalValueSpec
idGoogleCloudMlV1_StudyConfigParameterSpec_CategoricalValueSpec
properties
values
descriptionMust be specified if type is `CATEGORICAL`. The list of possible categories.
items
typestring
typearray
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_DiscreteValueSpec
idGoogleCloudMlV1_StudyConfigParameterSpec_DiscreteValueSpec
properties
values
descriptionMust be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. 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.
items
formatdouble
typenumber
typearray
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_DoubleValueSpec
idGoogleCloudMlV1_StudyConfigParameterSpec_DoubleValueSpec
properties
maxValue
descriptionMust be specified if type is `DOUBLE`. Maximum value of the parameter.
formatdouble
typenumber
minValue
descriptionMust be specified if type is `DOUBLE`. Minimum value of the parameter.
formatdouble
typenumber
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_IntegerValueSpec
idGoogleCloudMlV1_StudyConfigParameterSpec_IntegerValueSpec
properties
maxValue
descriptionMust be specified if type is `INTEGER`. Maximum value of the parameter.
formatint64
typestring
minValue
descriptionMust be specified if type is `INTEGER`. Minimum value of the parameter.
formatint64
typestring
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentCategoricalValueSpec
descriptionRepresents the spec to match categorical values from parent parameter.
idGoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentCategoricalValueSpec
properties
values
descriptionMatches values of the parent parameter with type 'CATEGORICAL'. All values must exist in `categorical_value_spec` of parent parameter.
items
typestring
typearray
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentDiscreteValueSpec
descriptionRepresents the spec to match discrete values from parent parameter.
idGoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentDiscreteValueSpec
properties
values
descriptionMatches values of the parent parameter with type 'DISCRETE'. All values must exist in `discrete_value_spec` of parent parameter.
items
formatdouble
typenumber
typearray
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentIntValueSpec
descriptionRepresents the spec to match integer values from parent parameter.
idGoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentIntValueSpec
properties
values
descriptionMatches values of the parent parameter with type 'INTEGER'. All values must lie in `integer_value_spec` of parent parameter.
items
formatint64
typestring
typearray
typeobject
GoogleCloudMlV1_StudyConfig_MetricSpec
descriptionRepresents a metric to optimize.
idGoogleCloudMlV1_StudyConfig_MetricSpec
properties
goal
descriptionRequired. The optimization goal of the metric.
enum
  • GOAL_TYPE_UNSPECIFIED
  • MAXIMIZE
  • MINIMIZE
enumDescriptions
  • Goal Type will default to maximize.
  • Maximize the goal metric.
  • Minimize the goal metric.
typestring
metric
descriptionRequired. The name of the metric.
typestring
typeobject
GoogleCloudMlV1_StudyConfig_ParameterSpec
descriptionRepresents a single parameter to optimize.
idGoogleCloudMlV1_StudyConfig_ParameterSpec
properties
categoricalValueSpec
$refGoogleCloudMlV1_StudyConfigParameterSpec_CategoricalValueSpec
descriptionThe value spec for a 'CATEGORICAL' parameter.
childParameterSpecs
descriptionA child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
items
$refGoogleCloudMlV1_StudyConfig_ParameterSpec
typearray
discreteValueSpec
$refGoogleCloudMlV1_StudyConfigParameterSpec_DiscreteValueSpec
descriptionThe value spec for a 'DISCRETE' parameter.
doubleValueSpec
$refGoogleCloudMlV1_StudyConfigParameterSpec_DoubleValueSpec
descriptionThe value spec for a 'DOUBLE' parameter.
integerValueSpec
$refGoogleCloudMlV1_StudyConfigParameterSpec_IntegerValueSpec
descriptionThe value spec for an 'INTEGER' parameter.
parameter
descriptionRequired. The parameter name must be unique amongst all ParameterSpecs.
typestring
parentCategoricalValues
$refGoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentCategoricalValueSpec
parentDiscreteValues
$refGoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentDiscreteValueSpec
parentIntValues
$refGoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentIntValueSpec
scaleType
descriptionHow the parameter should be scaled. Leave unset for categorical parameters.
enum
  • SCALE_TYPE_UNSPECIFIED
  • UNIT_LINEAR_SCALE
  • UNIT_LOG_SCALE
  • UNIT_REVERSE_LOG_SCALE
enumDescriptions
  • By default, no scaling is applied.
  • Scales the feasible space to (0, 1) linearly.
  • Scales the feasible space logarithmically to (0, 1). The entire feasible space must be strictly positive.
  • 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.
typestring
type
descriptionRequired. The type of the parameter.
enum
  • PARAMETER_TYPE_UNSPECIFIED
  • DOUBLE
  • INTEGER
  • CATEGORICAL
  • DISCRETE
enumDescriptions
  • You must specify a valid type. Using this unspecified type will result in an error.
  • Type for real-valued parameters.
  • Type for integral parameters.
  • The parameter is categorical, with a value chosen from the categories field.
  • The parameter is real valued, with a fixed set of feasible points. If `type==DISCRETE`, feasible_points must be provided, and {`min_value`, `max_value`} will be ignored.
typestring
typeobject
GoogleCloudMlV1_Trial_Parameter
descriptionA message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
idGoogleCloudMlV1_Trial_Parameter
properties
floatValue
descriptionMust be set if ParameterType is DOUBLE or DISCRETE.
formatdouble
typenumber
intValue
descriptionMust be set if ParameterType is INTEGER
formatint64
typestring
parameter
descriptionThe name of the parameter.
typestring
stringValue
descriptionMust be set if ParameterTypeis CATEGORICAL
typestring
typeobject
GoogleCloudMlV1__AcceleratorConfig
descriptionRepresents a hardware accelerator request config. Note that the AcceleratorConfig can be used in both Jobs and Versions. Learn more about [accelerators for training](/ml-engine/docs/using-gpus) and [accelerators for online prediction](/ml-engine/docs/machine-types-online-prediction#gpus).
idGoogleCloudMlV1__AcceleratorConfig
properties
count
descriptionThe number of accelerators to attach to each machine running the job.
formatint64
typestring
type
descriptionThe type of accelerator to use.
enum
  • ACCELERATOR_TYPE_UNSPECIFIED
  • NVIDIA_TESLA_K80
  • NVIDIA_TESLA_P100
  • NVIDIA_TESLA_V100
  • NVIDIA_TESLA_P4
  • NVIDIA_TESLA_T4
  • NVIDIA_TESLA_A100
  • TPU_V2
  • TPU_V3
  • TPU_V2_POD
  • TPU_V3_POD
  • TPU_V4_POD
enumDescriptions
  • Unspecified accelerator type. Default to no GPU.
  • Nvidia Tesla K80 GPU.
  • Nvidia Tesla P100 GPU.
  • Nvidia V100 GPU.
  • Nvidia Tesla P4 GPU.
  • Nvidia T4 GPU.
  • Nvidia A100 GPU.
  • TPU v2.
  • TPU v3.
  • TPU v2 POD.
  • TPU v3 POD.
  • TPU v4 POD.
typestring
typeobject
GoogleCloudMlV1__AddTrialMeasurementRequest
descriptionThe request message for the AddTrialMeasurement service method.
idGoogleCloudMlV1__AddTrialMeasurementRequest
properties
measurement
$refGoogleCloudMlV1__Measurement
descriptionRequired. The measurement to be added to a trial.
typeobject
GoogleCloudMlV1__AutoScaling
descriptionOptions for automatically scaling a model.
idGoogleCloudMlV1__AutoScaling
properties
maxNodes
descriptionThe maximum number of nodes to scale this model under load. The actual value will depend on resource quota and availability.
formatint32
typeinteger
metrics
descriptionMetricSpec contains the specifications to use to calculate the desired nodes count.
items
$refGoogleCloudMlV1__MetricSpec
typearray
minNodes
descriptionOptional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least `rate` * `min_nodes` * number of hours since last billing cycle, where `rate` is the cost per node-hour as documented in the [pricing guide](/ml-engine/docs/pricing), even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at least `min_nodes`. You will be charged for the time in which additional nodes are used. If `min_nodes` is not specified and AutoScaling is used with a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction), `min_nodes` defaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. If `min_nodes` is not specified and AutoScaling is used with a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction), `min_nodes` defaults to 1. `min_nodes` must be at least 1 for use with a Compute Engine machine type. You can set `min_nodes` when creating the model version, and you can also update `min_nodes` for an existing version: update_body.json: { 'autoScaling': { 'minNodes': 5 } } HTTP request: PATCH https://ml.googleapis.com/v1/{name=projects/*/models/*/versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json
formatint32
typeinteger
typeobject
GoogleCloudMlV1__AutomatedStoppingConfig
descriptionConfiguration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run.
idGoogleCloudMlV1__AutomatedStoppingConfig
properties
decayCurveStoppingConfig
$refGoogleCloudMlV1_AutomatedStoppingConfig_DecayCurveAutomatedStoppingConfig
medianAutomatedStoppingConfig
$refGoogleCloudMlV1_AutomatedStoppingConfig_MedianAutomatedStoppingConfig
typeobject
GoogleCloudMlV1__BuiltInAlgorithmOutput
descriptionRepresents output related to a built-in algorithm Job.
idGoogleCloudMlV1__BuiltInAlgorithmOutput
properties
framework
descriptionFramework on which the built-in algorithm was trained.
typestring
modelPath
descriptionThe Cloud Storage path to the `model/` directory where the training job saves the trained model. Only set for successful jobs that don't use hyperparameter tuning.
typestring
pythonVersion
descriptionPython version on which the built-in algorithm was trained.
typestring
runtimeVersion
descriptionAI Platform runtime version on which the built-in algorithm was trained.
typestring
typeobject
GoogleCloudMlV1__CancelJobRequest
descriptionRequest message for the CancelJob method.
idGoogleCloudMlV1__CancelJobRequest
properties
typeobject
GoogleCloudMlV1__Capability
idGoogleCloudMlV1__Capability
properties
availableAccelerators
descriptionAvailable accelerators for the capability.
items
enum
  • ACCELERATOR_TYPE_UNSPECIFIED
  • NVIDIA_TESLA_K80
  • NVIDIA_TESLA_P100
  • NVIDIA_TESLA_V100
  • NVIDIA_TESLA_P4
  • NVIDIA_TESLA_T4
  • NVIDIA_TESLA_A100
  • TPU_V2
  • TPU_V3
  • TPU_V2_POD
  • TPU_V3_POD
  • TPU_V4_POD
enumDescriptions
  • Unspecified accelerator type. Default to no GPU.
  • Nvidia Tesla K80 GPU.
  • Nvidia Tesla P100 GPU.
  • Nvidia V100 GPU.
  • Nvidia Tesla P4 GPU.
  • Nvidia T4 GPU.
  • Nvidia A100 GPU.
  • TPU v2.
  • TPU v3.
  • TPU v2 POD.
  • TPU v3 POD.
  • TPU v4 POD.
typestring
typearray
type
enum
  • TYPE_UNSPECIFIED
  • TRAINING
  • BATCH_PREDICTION
  • ONLINE_PREDICTION
enumDescriptions
typestring
typeobject
GoogleCloudMlV1__CheckTrialEarlyStoppingStateMetatdata
descriptionThis message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.
idGoogleCloudMlV1__CheckTrialEarlyStoppingStateMetatdata
properties
createTime
descriptionThe time at which the operation was submitted.
formatgoogle-datetime
typestring
study
descriptionThe name of the study that the trial belongs to.
typestring
trial
descriptionThe trial name.
typestring
typeobject
GoogleCloudMlV1__CheckTrialEarlyStoppingStateRequest
descriptionThe request message for the CheckTrialEarlyStoppingState service method.
idGoogleCloudMlV1__CheckTrialEarlyStoppingStateRequest
properties
typeobject
GoogleCloudMlV1__CheckTrialEarlyStoppingStateResponse
descriptionThe message will be placed in the response field of a completed google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.
idGoogleCloudMlV1__CheckTrialEarlyStoppingStateResponse
properties
endTime
descriptionThe time at which operation processing completed.
formatgoogle-datetime
typestring
shouldStop
descriptionTrue if the Trial should stop.
typeboolean
startTime
descriptionThe time at which the operation was started.
formatgoogle-datetime
typestring
typeobject
GoogleCloudMlV1__CompleteTrialRequest
descriptionThe request message for the CompleteTrial service method.
idGoogleCloudMlV1__CompleteTrialRequest
properties
finalMeasurement
$refGoogleCloudMlV1__Measurement
descriptionOptional. 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
infeasibleReason
descriptionOptional. A human readable reason why the trial was infeasible. This should only be provided if `trial_infeasible` is true.
typestring
trialInfeasible
descriptionOptional. True if the trial cannot be run with the given Parameter, and final_measurement will be ignored.
typeboolean
typeobject
GoogleCloudMlV1__Config
idGoogleCloudMlV1__Config
properties
tpuServiceAccount
descriptionThe service account Cloud ML uses to run on TPU node.
typestring
typeobject
GoogleCloudMlV1__ContainerPort
descriptionRepresents a network port in a single container. This message is a subset of the [Kubernetes ContainerPort v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#containerport-v1-core).
idGoogleCloudMlV1__ContainerPort
properties
containerPort
descriptionNumber of the port to expose on the container. This must be a valid port number: 0 < PORT_NUMBER < 65536.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__ContainerSpec
descriptionSpecification of a custom container for serving predictions. This message is a subset of the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core).
idGoogleCloudMlV1__ContainerSpec
properties
args
descriptionImmutable. 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 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 `commmand` 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 AI Platform Prediction](/ai-platform/prediction/docs/custom-container-requirements#aip-variables) and environment variables set in the 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: $( VARIABLE_NAME) 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: $$(VARIABLE_NAME) This field corresponds to the `args` field of the [Kubernetes Containers v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core).
items
typestring
typearray
command
descriptionImmutable. 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 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 AI Platform Prediction](/ai-platform/prediction/docs/custom-container-requirements#aip-variables) and environment variables set in the 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: $( VARIABLE_NAME) 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: $$(VARIABLE_NAME) This field corresponds to the `command` field of the [Kubernetes Containers v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core).
items
typestring
typearray
env
descriptionImmutable. 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 and 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.18/#container-v1-core).
items
$refGoogleCloudMlV1__EnvVar
typearray
image
descriptionURI of the Docker image to be used as the custom container for serving predictions. This URI must identify [an image in Artifact Registry](/artifact-registry/docs/overview) and begin with the hostname `{REGION}-docker.pkg.dev`, where `{REGION}` is replaced by the region that matches AI Platform Prediction [regional endpoint](/ai-platform/prediction/docs/regional-endpoints) that you are using. For example, if you are using the `us-central1-ml.googleapis.com` endpoint, then this URI must begin with `us-central1-docker.pkg.dev`. To use a custom container, the [AI Platform Google-managed service account](/ai-platform/prediction/docs/custom-service-account#default) must have permission to pull (read) the Docker image at this URI. The AI Platform Google-managed service account has the following format: `service-{PROJECT_NUMBER}@cloud-ml.google.com.iam.gserviceaccount.com` {PROJECT_NUMBER} is replaced by your Google Cloud project number. By default, this service account has necessary permissions to pull an Artifact Registry image in the same Google Cloud project where you are using AI Platform Prediction. In this case, no configuration is necessary. If you want to use an image from a different Google Cloud project, learn how to [grant the Artifact Registry Reader (roles/artifactregistry.reader) role for a repository](/artifact-registry/docs/access-control#grant-repo) to your projet's AI Platform Google-managed service account. To learn about the requirements for the Docker image itself, read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements).
typestring
ports
descriptionImmutable. List of ports to expose from the container. AI Platform Prediction sends any prediction requests that it receives to the first port on this list. AI Platform Prediction also sends [liveness and health checks](/ai-platform/prediction/docs/custom-container-requirements#health) to this port. If you do not specify this field, it defaults to following value: ```json [ { "containerPort": 8080 } ] ``` AI Platform Prediction 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.18/#container-v1-core).
items
$refGoogleCloudMlV1__ContainerPort
typearray
typeobject
GoogleCloudMlV1__DiskConfig
descriptionRepresents the config of disk options.
idGoogleCloudMlV1__DiskConfig
properties
bootDiskSizeGb
descriptionSize in GB of the boot disk (default is 100GB).
formatint32
typeinteger
bootDiskType
descriptionType 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).
typestring
typeobject
GoogleCloudMlV1__EncryptionConfig
descriptionRepresents a custom encryption key configuration that can be applied to a resource.
idGoogleCloudMlV1__EncryptionConfig
properties
kmsKeyName
descriptionThe Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a training job. It has the following format: `projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}`
typestring
typeobject
GoogleCloudMlV1__EnvVar
descriptionRepresents an environment variable to be made available in a container. This message is a subset of the [Kubernetes EnvVar v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#envvar-v1-core).
idGoogleCloudMlV1__EnvVar
properties
name
descriptionName of the environment variable. Must be a [valid C identifier](https://github.com/kubernetes/kubernetes/blob/v1.18.8/staging/src/k8s.io/apimachinery/pkg/util/validation/validation.go#L258) and must not begin with the prefix `AIP_`.
typestring
value
descriptionValue of the environment variable. Defaults to an empty string. In this field, you can reference [environment variables set by AI Platform Prediction](/ai-platform/prediction/docs/custom-container-requirements#aip-variables) and environment variables set earlier in the same env field as where this message occurs. 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: $(VARIABLE_NAME) 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: $$(VARIABLE_NAME)
typestring
typeobject
GoogleCloudMlV1__ExplainRequest
descriptionRequest for explanations to be issued against a trained model.
idGoogleCloudMlV1__ExplainRequest
properties
httpBody
$refGoogleApi__HttpBody
descriptionRequired. The explanation request body.
typeobject
GoogleCloudMlV1__ExplanationConfig
descriptionMessage holding configuration options for explaining model predictions. There are three feature attribution methods supported for TensorFlow models: integrated gradients, sampled Shapley, and XRAI. [Learn more about feature attributions.](/ai-platform/prediction/docs/ai-explanations/overview)
idGoogleCloudMlV1__ExplanationConfig
properties
integratedGradientsAttribution
$refGoogleCloudMlV1__IntegratedGradientsAttribution
descriptionAttributes credit by computing 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
sampledShapleyAttribution
$refGoogleCloudMlV1__SampledShapleyAttribution
descriptionAn 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.
xraiAttribution
$refGoogleCloudMlV1__XraiAttribution
descriptionAttributes credit by computing the XRAI taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Currently only implemented for models with natural image inputs.
typeobject
GoogleCloudMlV1__GetConfigResponse
descriptionReturns service account information associated with a project.
idGoogleCloudMlV1__GetConfigResponse
properties
config
$refGoogleCloudMlV1__Config
serviceAccount
descriptionThe service account Cloud ML uses to access resources in the project.
typestring
serviceAccountProject
descriptionThe project number for `service_account`.
formatint64
typestring
typeobject
GoogleCloudMlV1__HyperparameterOutput
descriptionRepresents the result of a single hyperparameter tuning trial from a training job. The TrainingOutput object that is returned on successful completion of a training job with hyperparameter tuning includes a list of HyperparameterOutput objects, one for each successful trial.
idGoogleCloudMlV1__HyperparameterOutput
properties
allMetrics
descriptionAll recorded object metrics for this trial. This field is not currently populated.
items
$refGoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric
typearray
builtInAlgorithmOutput
$refGoogleCloudMlV1__BuiltInAlgorithmOutput
descriptionDetails related to built-in algorithms jobs. Only set for trials of built-in algorithms jobs that have succeeded.
endTime
descriptionOutput only. End time for the trial.
formatgoogle-datetime
typestring
finalMetric
$refGoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric
descriptionThe final objective metric seen for this trial.
hyperparameters
additionalProperties
typestring
descriptionThe hyperparameters given to this trial.
typeobject
isTrialStoppedEarly
descriptionTrue if the trial is stopped early.
typeboolean
startTime
descriptionOutput only. Start time for the trial.
formatgoogle-datetime
typestring
state
descriptionOutput only. The detailed state of the trial.
enum
  • STATE_UNSPECIFIED
  • QUEUED
  • PREPARING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLING
  • CANCELLED
enumDescriptions
  • The job state is unspecified.
  • The job has been just created and processing has not yet begun.
  • The service is preparing to run the job.
  • The job is in progress.
  • The job completed successfully.
  • The job failed. `error_message` should contain the details of the failure.
  • The job is being cancelled. `error_message` should describe the reason for the cancellation.
  • The job has been cancelled. `error_message` should describe the reason for the cancellation.
typestring
trialId
descriptionThe trial id for these results.
typestring
webAccessUris
additionalProperties
typestring
descriptionURIs for accessing [interactive shells](https://cloud.google.com/ai-platform/training/docs/monitor-debug-interactive-shell) (one URI for each training node). Only available if this trial is part of a hyperparameter tuning job and the job's training_input.enable_web_access is `true`. The keys are names of each node in the training job; for example, `master-replica-0` for the master node, `worker-replica-0` for the first worker, and `ps-replica-0` for the first parameter server. The values are the URIs for each node's interactive shell.
typeobject
typeobject
GoogleCloudMlV1__HyperparameterSpec
descriptionRepresents a set of hyperparameters to optimize.
idGoogleCloudMlV1__HyperparameterSpec
properties
algorithm
descriptionOptional. The search algorithm specified for the hyperparameter tuning job. Uses the default AI Platform hyperparameter tuning algorithm if unspecified.
enum
  • ALGORITHM_UNSPECIFIED
  • GRID_SEARCH
  • RANDOM_SEARCH
enumDescriptions
  • The default algorithm used by the hyperparameter tuning service. This is a Bayesian optimization algorithm.
  • Simple grid search within the feasible space. To use grid search, all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`.
  • Simple random search within the feasible space.
typestring
enableTrialEarlyStopping
descriptionOptional. Indicates if the hyperparameter tuning job enables auto trial early stopping.
typeboolean
goal
descriptionRequired. The type of goal to use for tuning. Available types are `MAXIMIZE` and `MINIMIZE`. Defaults to `MAXIMIZE`.
enum
  • GOAL_TYPE_UNSPECIFIED
  • MAXIMIZE
  • MINIMIZE
enumDescriptions
  • Goal Type will default to maximize.
  • Maximize the goal metric.
  • Minimize the goal metric.
typestring
hyperparameterMetricTag
descriptionOptional. The TensorFlow summary tag name to use for optimizing trials. For current versions of TensorFlow, this tag name should exactly match what is shown in TensorBoard, including all scopes. For versions of TensorFlow prior to 0.12, this should be only the tag passed to tf.Summary. By default, "training/hptuning/metric" will be used.
typestring
maxFailedTrials
descriptionOptional. The number of failed trials that need to be seen before failing the hyperparameter tuning job. You can specify this field to override the default failing criteria for AI Platform hyperparameter tuning jobs. Defaults to zero, which means the service decides when a hyperparameter job should fail.
formatint32
typeinteger
maxParallelTrials
descriptionOptional. The number of training trials to run concurrently. You can reduce the time it takes to perform hyperparameter tuning by adding trials in parallel. However, each trail only benefits from the information gained in completed trials. That means that a trial does not get access to the results of trials running at the same time, which could reduce the quality of the overall optimization. Each trial will use the same scale tier and machine types. Defaults to one.
formatint32
typeinteger
maxTrials
descriptionOptional. How many training trials should be attempted to optimize the specified hyperparameters. Defaults to one.
formatint32
typeinteger
params
descriptionRequired. The set of parameters to tune.
items
$refGoogleCloudMlV1__ParameterSpec
typearray
resumePreviousJobId
descriptionOptional. The prior hyperparameter tuning job id that users hope to continue with. The job id will be used to find the corresponding vizier study guid and resume the study.
typestring
typeobject
GoogleCloudMlV1__IntegratedGradientsAttribution
descriptionAttributes credit by computing 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
idGoogleCloudMlV1__IntegratedGradientsAttribution
properties
numIntegralSteps
descriptionNumber 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.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__Job
descriptionRepresents a training or prediction job.
idGoogleCloudMlV1__Job
properties
createTime
descriptionOutput only. When the job was created.
formatgoogle-datetime
typestring
endTime
descriptionOutput only. When the job processing was completed.
formatgoogle-datetime
typestring
errorMessage
descriptionOutput only. The details of a failure or a cancellation.
typestring
etag
description`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform job updates in order to avoid race conditions: An `etag` is returned in the response to `GetJob`, and systems are expected to put that etag in the request to `UpdateJob` to ensure that their change will be applied to the same version of the job.
formatbyte
typestring
jobId
descriptionRequired. The user-specified id of the job.
typestring
jobPosition
descriptionOutput only. It's only effect when the job is in QUEUED state. If it's positive, it indicates the job's position in the job scheduler. It's 0 when the job is already scheduled.
formatint64
readOnlyTrue
typestring
labels
additionalProperties
typestring
descriptionOptional. One or more labels that you can add, to organize your jobs. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels.
typeobject
predictionInput
$refGoogleCloudMlV1__PredictionInput
descriptionInput parameters to create a prediction job.
predictionOutput
$refGoogleCloudMlV1__PredictionOutput
descriptionThe current prediction job result.
startTime
descriptionOutput only. When the job processing was started.
formatgoogle-datetime
typestring
state
descriptionOutput only. The detailed state of a job.
enum
  • STATE_UNSPECIFIED
  • QUEUED
  • PREPARING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLING
  • CANCELLED
enumDescriptions
  • The job state is unspecified.
  • The job has been just created and processing has not yet begun.
  • The service is preparing to run the job.
  • The job is in progress.
  • The job completed successfully.
  • The job failed. `error_message` should contain the details of the failure.
  • The job is being cancelled. `error_message` should describe the reason for the cancellation.
  • The job has been cancelled. `error_message` should describe the reason for the cancellation.
typestring
trainingInput
$refGoogleCloudMlV1__TrainingInput
descriptionInput parameters to create a training job.
trainingOutput
$refGoogleCloudMlV1__TrainingOutput
descriptionThe current training job result.
typeobject
GoogleCloudMlV1__ListJobsResponse
descriptionResponse message for the ListJobs method.
idGoogleCloudMlV1__ListJobsResponse
properties
jobs
descriptionThe list of jobs.
items
$refGoogleCloudMlV1__Job
typearray
nextPageToken
descriptionOptional. Pass this token as the `page_token` field of the request for a subsequent call.
typestring
typeobject
GoogleCloudMlV1__ListLocationsResponse
idGoogleCloudMlV1__ListLocationsResponse
properties
locations
descriptionLocations where at least one type of CMLE capability is available.
items
$refGoogleCloudMlV1__Location
typearray
nextPageToken
descriptionOptional. Pass this token as the `page_token` field of the request for a subsequent call.
typestring
typeobject
GoogleCloudMlV1__ListModelsResponse
descriptionResponse message for the ListModels method.
idGoogleCloudMlV1__ListModelsResponse
properties
models
descriptionThe list of models.
items
$refGoogleCloudMlV1__Model
typearray
nextPageToken
descriptionOptional. Pass this token as the `page_token` field of the request for a subsequent call.
typestring
typeobject
GoogleCloudMlV1__ListOptimalTrialsRequest
descriptionThe request message for the ListTrials service method.
idGoogleCloudMlV1__ListOptimalTrialsRequest
properties
typeobject
GoogleCloudMlV1__ListOptimalTrialsResponse
descriptionThe response message for the ListOptimalTrials method.
idGoogleCloudMlV1__ListOptimalTrialsResponse
properties
trials
descriptionThe 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
items
$refGoogleCloudMlV1__Trial
typearray
typeobject
GoogleCloudMlV1__ListStudiesResponse
idGoogleCloudMlV1__ListStudiesResponse
properties
studies
descriptionThe studies associated with the project.
items
$refGoogleCloudMlV1__Study
typearray
typeobject
GoogleCloudMlV1__ListTrialsResponse
descriptionThe response message for the ListTrials method.
idGoogleCloudMlV1__ListTrialsResponse
properties
trials
descriptionThe trials associated with the study.
items
$refGoogleCloudMlV1__Trial
typearray
typeobject
GoogleCloudMlV1__ListVersionsResponse
descriptionResponse message for the ListVersions method.
idGoogleCloudMlV1__ListVersionsResponse
properties
nextPageToken
descriptionOptional. Pass this token as the `page_token` field of the request for a subsequent call.
typestring
versions
descriptionThe list of versions.
items
$refGoogleCloudMlV1__Version
typearray
typeobject
GoogleCloudMlV1__Location
idGoogleCloudMlV1__Location
properties
capabilities
descriptionCapabilities available in the location.
items
$refGoogleCloudMlV1__Capability
typearray
name
typestring
typeobject
GoogleCloudMlV1__ManualScaling
descriptionOptions for manually scaling a model.
idGoogleCloudMlV1__ManualScaling
properties
nodes
descriptionThe number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed, so the cost of operating this model will be proportional to `nodes` * number of hours since last billing cycle plus the cost for each prediction performed.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__Measurement
descriptionA message representing a measurement.
idGoogleCloudMlV1__Measurement
properties
elapsedTime
descriptionOutput only. Time that the trial has been running at the point of this measurement.
formatgoogle-duration
typestring
metrics
descriptionProvides a list of metrics that act as inputs into the objective function.
items
$refGoogleCloudMlV1_Measurement_Metric
typearray
stepCount
descriptionThe number of steps a machine learning model has been trained for. Must be non-negative.
formatint64
typestring
typeobject
GoogleCloudMlV1__MetricSpec
descriptionMetricSpec contains the specifications to use to calculate the desired nodes count when autoscaling is enabled.
idGoogleCloudMlV1__MetricSpec
properties
name
descriptionmetric name.
enum
  • METRIC_NAME_UNSPECIFIED
  • CPU_USAGE
  • GPU_DUTY_CYCLE
enumDescriptions
  • Unspecified MetricName.
  • CPU usage.
  • GPU duty cycle.
typestring
target
descriptionTarget specifies the target value for the given metric; once real metric deviates from the threshold by a certain percentage, the node count changes.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__Model
descriptionRepresents a machine learning solution. A model can have multiple versions, each of which is a deployed, trained model ready to receive prediction requests. The model itself is just a container.
idGoogleCloudMlV1__Model
properties
defaultVersion
$refGoogleCloudMlV1__Version
descriptionOutput only. The default version of the model. This version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.models.versions.setDefault.
description
descriptionOptional. The description specified for the model when it was created.
typestring
etag
description`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetModel`, and systems are expected to put that etag in the request to `UpdateModel` to ensure that their change will be applied to the model as intended.
formatbyte
typestring
labels
additionalProperties
typestring
descriptionOptional. One or more labels that you can add, to organize your models. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models.
typeobject
name
descriptionRequired. The name specified for the model when it was created. The model name must be unique within the project it is created in.
typestring
onlinePredictionConsoleLogging
descriptionOptional. If true, online prediction nodes send `stderr` and `stdout` streams to Cloud Logging. These can be more verbose than the standard access logs (see `onlinePredictionLogging`) and can incur higher cost. However, they are helpful for debugging. Note that [logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high QPS. Estimate your costs before enabling this option. Default is false.
typeboolean
onlinePredictionLogging
descriptionOptional. 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 request. Note that [logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. Default is false.
typeboolean
regions
descriptionOptional. The list of regions where the model is going to be deployed. Only one region per model is supported. Defaults to 'us-central1' if nothing is set. See the available regions for AI Platform services. Note: * No matter where a model is deployed, it can always be accessed by users from anywhere, both for online and batch prediction. * The region for a batch prediction job is set by the region field when submitting the batch prediction job and does not take its value from this field.
items
typestring
typearray
typeobject
GoogleCloudMlV1__OperationMetadata
descriptionRepresents the metadata of the long-running operation.
idGoogleCloudMlV1__OperationMetadata
properties
createTime
descriptionThe time the operation was submitted.
formatgoogle-datetime
typestring
endTime
descriptionThe time operation processing completed.
formatgoogle-datetime
typestring
isCancellationRequested
descriptionIndicates whether a request to cancel this operation has been made.
typeboolean
labels
additionalProperties
typestring
descriptionThe user labels, inherited from the model or the model version being operated on.
typeobject
modelName
descriptionContains the name of the model associated with the operation.
typestring
operationType
descriptionThe operation type.
enum
  • OPERATION_TYPE_UNSPECIFIED
  • CREATE_VERSION
  • DELETE_VERSION
  • DELETE_MODEL
  • UPDATE_MODEL
  • UPDATE_VERSION
  • UPDATE_CONFIG
enumDescriptions
  • Unspecified operation type.
  • An operation to create a new version.
  • An operation to delete an existing version.
  • An operation to delete an existing model.
  • An operation to update an existing model.
  • An operation to update an existing version.
  • An operation to update project configuration.
typestring
projectNumber
descriptionContains the project number associated with the operation.
formatint64
typestring
startTime
descriptionThe time operation processing started.
formatgoogle-datetime
typestring
version
$refGoogleCloudMlV1__Version
descriptionContains the version associated with the operation.
typeobject
GoogleCloudMlV1__ParameterSpec
descriptionRepresents a single hyperparameter to optimize.
idGoogleCloudMlV1__ParameterSpec
properties
categoricalValues
descriptionRequired if type is `CATEGORICAL`. The list of possible categories.
items
typestring
typearray
discreteValues
descriptionRequired if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. 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.
items
formatdouble
typenumber
typearray
maxValue
descriptionRequired if type is `DOUBLE` or `INTEGER`. This field should be unset if type is `CATEGORICAL`. This value should be integers if type is `INTEGER`.
formatdouble
typenumber
minValue
descriptionRequired if type is `DOUBLE` or `INTEGER`. This field should be unset if type is `CATEGORICAL`. This value should be integers if type is INTEGER.
formatdouble
typenumber
parameterName
descriptionRequired. The parameter name must be unique amongst all ParameterConfigs in a HyperparameterSpec message. E.g., "learning_rate".
typestring
scaleType
descriptionOptional. How the parameter should be scaled to the hypercube. Leave unset for categorical parameters. Some kind of scaling is strongly recommended for real or integral parameters (e.g., `UNIT_LINEAR_SCALE`).
enum
  • NONE
  • UNIT_LINEAR_SCALE
  • UNIT_LOG_SCALE
  • UNIT_REVERSE_LOG_SCALE
enumDescriptions
  • By default, no scaling is applied.
  • Scales the feasible space to (0, 1) linearly.
  • Scales the feasible space logarithmically to (0, 1). The entire feasible space must be strictly positive.
  • 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.
typestring
type
descriptionRequired. The type of the parameter.
enum
  • PARAMETER_TYPE_UNSPECIFIED
  • DOUBLE
  • INTEGER
  • CATEGORICAL
  • DISCRETE
enumDescriptions
  • You must specify a valid type. Using this unspecified type will result in an error.
  • Type for real-valued parameters.
  • Type for integral parameters.
  • The parameter is categorical, with a value chosen from the categories field.
  • The parameter is real valued, with a fixed set of feasible points. If `type==DISCRETE`, feasible_points must be provided, and {`min_value`, `max_value`} will be ignored.
typestring
typeobject
GoogleCloudMlV1__PredictRequest
descriptionRequest for predictions to be issued against a trained model.
idGoogleCloudMlV1__PredictRequest
properties
httpBody
$refGoogleApi__HttpBody
description Required. The prediction request body. Refer to the [request body details section](#request-body-details) for more information on how to structure your request.
typeobject
GoogleCloudMlV1__PredictionInput
descriptionRepresents input parameters for a prediction job.
idGoogleCloudMlV1__PredictionInput
properties
batchSize
descriptionOptional. Number of records per batch, defaults to 64. The service will buffer batch_size number of records in memory before invoking one Tensorflow prediction call internally. So take the record size and memory available into consideration when setting this parameter.
formatint64
typestring
dataFormat
descriptionRequired. The format of the input data files.
enum
  • DATA_FORMAT_UNSPECIFIED
  • JSON
  • TEXT
  • TF_RECORD
  • TF_RECORD_GZIP
  • CSV
enumDescriptions
  • Unspecified format.
  • Each line of the file is a JSON dictionary representing one record.
  • Deprecated. Use JSON instead.
  • The source file is a TFRecord file. Currently available only for input data.
  • The source file is a GZIP-compressed TFRecord file. Currently available only for input data.
  • Values are comma-separated rows, with keys in a separate file. Currently available only for output data.
typestring
inputPaths
descriptionRequired. The Cloud Storage location of the input data files. May contain wildcards.
items
typestring
typearray
maxWorkerCount
descriptionOptional. The maximum number of workers to be used for parallel processing. Defaults to 10 if not specified.
formatint64
typestring
modelName
descriptionUse this field if you want to use the default version for the specified model. The string must use the following format: `"projects/YOUR_PROJECT/models/YOUR_MODEL"`
typestring
outputDataFormat
descriptionOptional. Format of the output data files, defaults to JSON.
enum
  • DATA_FORMAT_UNSPECIFIED
  • JSON
  • TEXT
  • TF_RECORD
  • TF_RECORD_GZIP
  • CSV
enumDescriptions
  • Unspecified format.
  • Each line of the file is a JSON dictionary representing one record.
  • Deprecated. Use JSON instead.
  • The source file is a TFRecord file. Currently available only for input data.
  • The source file is a GZIP-compressed TFRecord file. Currently available only for input data.
  • Values are comma-separated rows, with keys in a separate file. Currently available only for output data.
typestring
outputPath
descriptionRequired. The output Google Cloud Storage location.
typestring
region
descriptionRequired. The Google Compute Engine region to run the prediction job in. See the available regions for AI Platform services.
typestring
runtimeVersion
descriptionOptional. The AI Platform runtime version to use for this batch prediction. If not set, AI Platform will pick the runtime version used during the CreateVersion request for this model version, or choose the latest stable version when model version information is not available such as when the model is specified by uri.
typestring
signatureName
descriptionOptional. The name of the signature defined in the SavedModel to use for this job. Please refer to [SavedModel](https://tensorflow.github.io/serving/serving_basic.html) for information about how to use signatures. Defaults to [DEFAULT_SERVING_SIGNATURE_DEF_KEY](https://www.tensorflow.org/api_docs/python/tf/saved_model/signature_constants) , which is "serving_default".
typestring
uri
descriptionUse this field if you want to specify a Google Cloud Storage path for the model to use.
typestring
versionName
descriptionUse this field if you want to specify a version of the model to use. The string is formatted the same way as `model_version`, with the addition of the version information: `"projects/YOUR_PROJECT/models/YOUR_MODEL/versions/YOUR_VERSION"`
typestring
typeobject
GoogleCloudMlV1__PredictionOutput
descriptionRepresents results of a prediction job.
idGoogleCloudMlV1__PredictionOutput
properties
errorCount
descriptionThe number of data instances which resulted in errors.
formatint64
typestring
nodeHours
descriptionNode hours used by the batch prediction job.
formatdouble
typenumber
outputPath
descriptionThe output Google Cloud Storage location provided at the job creation time.
typestring
predictionCount
descriptionThe number of generated predictions.
formatint64
typestring
typeobject
GoogleCloudMlV1__ReplicaConfig
descriptionRepresents the configuration for a replica in a cluster.
idGoogleCloudMlV1__ReplicaConfig
properties
acceleratorConfig
$refGoogleCloudMlV1__AcceleratorConfig
descriptionRepresents the type and number of accelerators used by the replica. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu)
containerArgs
descriptionArguments to the entrypoint command. The following rules apply for container_command and container_args: - If you do not supply command or args: The defaults defined in the Docker image are used. - If you supply a command but no args: The default EntryPoint and the default Cmd defined in the Docker image are ignored. Your command is run without any arguments. - If you supply only args: The default Entrypoint defined in the Docker image is run with the args that you supplied. - If you supply a command and args: The default Entrypoint and the default Cmd defined in the Docker image are ignored. Your command is run with your args. It cannot be set if custom container image is not provided. Note that this field and [TrainingInput.args] are mutually exclusive, i.e., both cannot be set at the same time.
items
typestring
typearray
containerCommand
descriptionThe command with which the replica's custom container is run. If provided, it will override default ENTRYPOINT of the docker image. If not provided, the docker image's ENTRYPOINT is used. It cannot be set if custom container image is not provided. Note that this field and [TrainingInput.args] are mutually exclusive, i.e., both cannot be set at the same time.
items
typestring
typearray
diskConfig
$refGoogleCloudMlV1__DiskConfig
descriptionRepresents the configuration of disk options.
imageUri
descriptionThe Docker image to run on the replica. This image must be in Container Registry. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers).
typestring
tpuTfVersion
descriptionThe AI Platform runtime version that includes a TensorFlow version matching the one used in the custom container. This field is required if the replica is a TPU worker that uses a custom container. Otherwise, do not specify this field. This must be a [runtime version that currently supports training with TPUs](/ml-engine/docs/tensorflow/runtime-version-list#tpu-support). Note that the version of TensorFlow included in a runtime version may differ from the numbering of the runtime version itself, because it may have a different [patch version](https://www.tensorflow.org/guide/version_compat#semantic_versioning_20). In this field, you must specify the runtime version (TensorFlow minor version). For example, if your custom container runs TensorFlow `1.x.y`, specify `1.x`.
typestring
typeobject
GoogleCloudMlV1__RequestLoggingConfig
descriptionConfiguration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs.
idGoogleCloudMlV1__RequestLoggingConfig
properties
bigqueryTableName
descriptionRequired. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE
typestring
samplingPercentage
descriptionPercentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0.
formatdouble
typenumber
typeobject
GoogleCloudMlV1__RouteMap
descriptionSpecifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements.
idGoogleCloudMlV1__RouteMap
properties
health
descriptionHTTP path on the container to send health checkss to. AI Platform Prediction 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](/ai-platform/prediction/docs/custom-container-requirements#checks). For example, if you set this field to `/bar`, then AI Platform Prediction intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/ MODEL/versions/VERSION The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID /models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
typestring
predict
descriptionHTTP path on the container to send prediction requests to. AI Platform Prediction forwards requests sent using projects.predict to this path on the container's IP address and port. AI Platform Prediction then returns the container's response in the API response. For example, if you set this field to `/foo`, then when AI Platform Prediction 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 Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/MODEL/versions/VERSION:predict The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID/models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
typestring
typeobject
GoogleCloudMlV1__SampledShapleyAttribution
descriptionAn 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.
idGoogleCloudMlV1__SampledShapleyAttribution
properties
numPaths
descriptionThe number of feature permutations to consider when approximating the Shapley values.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__Scheduling
descriptionAll parameters related to scheduling of training jobs.
idGoogleCloudMlV1__Scheduling
properties
maxRunningTime
descriptionOptional. The maximum job running time, expressed in seconds. The field can contain up to nine fractional digits, terminated by `s`. If not specified, this field defaults to `604800s` (seven days). If the training job is still running after this duration, AI Platform Training cancels it. The duration is measured from when the job enters the `RUNNING` state; therefore it does not overlap with the duration limited by Scheduling.max_wait_time. For example, if you want to ensure your job runs for no more than 2 hours, set this field to `7200s` (2 hours * 60 minutes / hour * 60 seconds / minute). If you submit your training job using the `gcloud` tool, you can [specify this field in a `config.yaml` file](/ai-platform/training/docs/training-jobs#formatting_your_configuration_parameters). For example: ```yaml trainingInput: scheduling: maxRunningTime: 7200s ```
formatgoogle-duration
typestring
maxWaitTime
descriptionOptional. The maximum job wait time, expressed in seconds. The field can contain up to nine fractional digits, terminated by `s`. If not specified, there is no limit to the wait time. The minimum for this field is `1800s` (30 minutes). If the training job has not entered the `RUNNING` state after this duration, AI Platform Training cancels it. After the job begins running, it can no longer be cancelled due to the maximum wait time. Therefore the duration limited by this field does not overlap with the duration limited by Scheduling.max_running_time. For example, if the job temporarily stops running and retries due to a [VM restart](/ai-platform/training/docs/overview#restarts), this cannot lead to a maximum wait time cancellation. However, independently of this constraint, AI Platform Training might stop a job if there are too many retries due to exhausted resources in a region. The following example describes how you might use this field: To cancel your job if it doesn't start running within 1 hour, set this field to `3600s` (1 hour * 60 minutes / hour * 60 seconds / minute). If the job is still in the `QUEUED` or `PREPARING` state after an hour of waiting, AI Platform Training cancels the job. If you submit your training job using the `gcloud` tool, you can [specify this field in a `config.yaml` file](/ai-platform/training/docs/training-jobs#formatting_your_configuration_parameters). For example: ```yaml trainingInput: scheduling: maxWaitTime: 3600s ```
formatgoogle-duration
typestring
priority
descriptionOptional. Job scheduling will be based on this priority, which in the range [0, 1000]. The bigger the number, the higher the priority. Default to 0 if not set. If there are multiple jobs requesting same type of accelerators, the high priority job will be scheduled prior to ones with low priority.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__SetDefaultVersionRequest
descriptionRequest message for the SetDefaultVersion request.
idGoogleCloudMlV1__SetDefaultVersionRequest
properties
typeobject
GoogleCloudMlV1__StopTrialRequest
idGoogleCloudMlV1__StopTrialRequest
properties
typeobject
GoogleCloudMlV1__Study
descriptionA message representing a Study.
idGoogleCloudMlV1__Study
properties
createTime
descriptionOutput only. Time at which the study was created.
formatgoogle-datetime
readOnlyTrue
typestring
inactiveReason
descriptionOutput only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
readOnlyTrue
typestring
name
descriptionOutput only. The name of a study.
readOnlyTrue
typestring
state
descriptionOutput only. The detailed state of a study.
enum
  • STATE_UNSPECIFIED
  • ACTIVE
  • INACTIVE
  • COMPLETED
enumDescriptions
  • The study state is unspecified.
  • The study is active.
  • The study is stopped due to an internal error.
  • The study is done when the service exhausts the parameter search space or max_trial_count is reached.
readOnlyTrue
typestring
studyConfig
$refGoogleCloudMlV1__StudyConfig
descriptionRequired. Configuration of the study.
typeobject
GoogleCloudMlV1__StudyConfig
descriptionRepresents configuration of a study.
idGoogleCloudMlV1__StudyConfig
properties
algorithm
descriptionThe search algorithm specified for the study.
enum
  • ALGORITHM_UNSPECIFIED
  • GAUSSIAN_PROCESS_BANDIT
  • GRID_SEARCH
  • RANDOM_SEARCH
enumDescriptions
  • The default algorithm used by the Cloud AI Platform Vizier service.
  • Gaussian Process Bandit.
  • Simple grid search within the feasible space. To use grid search, all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`.
  • Simple random search within the feasible space.
typestring
automatedStoppingConfig
$refGoogleCloudMlV1__AutomatedStoppingConfig
descriptionConfiguration for automated stopping of unpromising Trials.
metrics
descriptionMetric specs for the study.
items
$refGoogleCloudMlV1_StudyConfig_MetricSpec
typearray
parameters
descriptionRequired. The set of parameters to tune.
items
$refGoogleCloudMlV1_StudyConfig_ParameterSpec
typearray
typeobject
GoogleCloudMlV1__SuggestTrialsMetadata
descriptionMetadata field of a google.longrunning.Operation associated with a SuggestTrialsRequest.
idGoogleCloudMlV1__SuggestTrialsMetadata
properties
clientId
descriptionThe identifier of the client that is requesting the suggestion.
typestring
createTime
descriptionThe time operation was submitted.
formatgoogle-datetime
typestring
study
descriptionThe name of the study that the trial belongs to.
typestring
suggestionCount
descriptionThe number of suggestions requested.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__SuggestTrialsRequest
descriptionThe request message for the SuggestTrial service method.
idGoogleCloudMlV1__SuggestTrialsRequest
properties
clientId
descriptionRequired. 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.
typestring
suggestionCount
descriptionRequired. The number of suggestions requested.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__SuggestTrialsResponse
descriptionThis message will be placed in the response field of a completed google.longrunning.Operation associated with a SuggestTrials request.
idGoogleCloudMlV1__SuggestTrialsResponse
properties
endTime
descriptionThe time at which operation processing completed.
formatgoogle-datetime
typestring
startTime
descriptionThe time at which the operation was started.
formatgoogle-datetime
typestring
studyState
descriptionThe state of the study.
enum
  • STATE_UNSPECIFIED
  • ACTIVE
  • INACTIVE
  • COMPLETED
enumDescriptions
  • The study state is unspecified.
  • The study is active.
  • The study is stopped due to an internal error.
  • The study is done when the service exhausts the parameter search space or max_trial_count is reached.
typestring
trials
descriptionA list of trials.
items
$refGoogleCloudMlV1__Trial
typearray
typeobject
GoogleCloudMlV1__TrainingInput
descriptionRepresents input parameters for a training job. When using the gcloud command to submit your training job, you can specify the input parameters as command-line arguments and/or in a YAML configuration file referenced from the --config command-line argument. For details, see the guide to [submitting a training job](/ai-platform/training/docs/training-jobs).
idGoogleCloudMlV1__TrainingInput
properties
args
descriptionOptional. Command-line arguments passed to the training application when it starts. If your job uses a custom container, then the arguments are passed to the container's `ENTRYPOINT` command.
items
typestring
typearray
enableWebAccess
descriptionOptional. Whether you want AI Platform Training to enable [interactive shell access](https://cloud.google.com/ai-platform/training/docs/monitor-debug-interactive-shell) to training containers. If set to `true`, you can access interactive shells at the URIs given by TrainingOutput.web_access_uris or HyperparameterOutput.web_access_uris (within TrainingOutput.trials).
typeboolean
encryptionConfig
$refGoogleCloudMlV1__EncryptionConfig
descriptionOptional. Options for using customer-managed encryption keys (CMEK) to protect resources created by a training job, instead of using Google's default encryption. If this is set, then all resources created by the training job will be encrypted with the customer-managed encryption key that you specify. [Learn how and when to use CMEK with AI Platform Training](/ai-platform/training/docs/cmek).
evaluatorConfig
$refGoogleCloudMlV1__ReplicaConfig
descriptionOptional. The configuration for evaluators. You should only set `evaluatorConfig.acceleratorConfig` if `evaluatorType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `evaluatorConfig.imageUri` only if you build a custom image for your evaluator. If `evaluatorConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers).
evaluatorCount
descriptionOptional. The number of evaluator replicas to use for the training job. Each replica in the cluster will be of the type specified in `evaluator_type`. This value can only be used when `scale_tier` is set to `CUSTOM`. If you set this value, you must also set `evaluator_type`. The default value is zero.
formatint64
typestring
evaluatorType
descriptionOptional. Specifies the type of virtual machine to use for your training job's evaluator nodes. The supported values are the same as those described in the entry for `masterType`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be Compute Engine machine types or both must be legacy machine types. This value must be present when `scaleTier` is set to `CUSTOM` and `evaluatorCount` is greater than zero.
typestring
hyperparameters
$refGoogleCloudMlV1__HyperparameterSpec
descriptionOptional. The set of Hyperparameters to tune.
jobDir
descriptionOptional. A Google Cloud Storage path in which to store training outputs and other data needed for training. This path is passed to your TensorFlow program as the '--job-dir' command-line argument. The benefit of specifying this field is that Cloud ML validates the path for use in training.
typestring
masterConfig
$refGoogleCloudMlV1__ReplicaConfig
descriptionOptional. The configuration for your master worker. You should only set `masterConfig.acceleratorConfig` if `masterType` is set to a Compute Engine machine type. Learn about [restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `masterConfig.imageUri` only if you build a custom image. Only one of `masterConfig.imageUri` and `runtimeVersion` should be set. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers).
masterType
descriptionOptional. Specifies the type of virtual machine to use for your training job's master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this field. See the [list of compatible Compute Engine machine types](/ai-platform/training/docs/machine-types#compute-engine-machine-types). Alternatively, you can use the certain legacy machine types in this field. See the [list of legacy machine types](/ai-platform/training/docs/machine-types#legacy-machine-types). Finally, if you want to use a TPU for training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for training with TPUs](/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
typestring
network
descriptionOptional. The full name of the [Compute Engine network](/vpc/docs/vpc) to which the Job is peered. For example, `projects/12345/global/networks/myVPC`. The format of this field is `projects/{project}/global/networks/{network}`, where {project} is a project number (like `12345`) and {network} is network name. Private services access must already be configured for the network. If left unspecified, the Job is not peered with any network. [Learn about using VPC Network Peering.](/ai-platform/training/docs/vpc-peering).
typestring
packageUris
descriptionRequired. The Google Cloud Storage location of the packages with the training program and any additional dependencies. The maximum number of package URIs is 100.
items
typestring
typearray
parameterServerConfig
$refGoogleCloudMlV1__ReplicaConfig
descriptionOptional. The configuration for parameter servers. You should only set `parameterServerConfig.acceleratorConfig` if `parameterServerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `parameterServerConfig.imageUri` only if you build a custom image for your parameter server. If `parameterServerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers).
parameterServerCount
descriptionOptional. The number of parameter server replicas to use for the training job. Each replica in the cluster will be of the type specified in `parameter_server_type`. This value can only be used when `scale_tier` is set to `CUSTOM`. If you set this value, you must also set `parameter_server_type`. The default value is zero.
formatint64
typestring
parameterServerType
descriptionOptional. Specifies the type of virtual machine to use for your training job's parameter server. The supported values are the same as those described in the entry for `master_type`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be Compute Engine machine types or both must be legacy machine types. This value must be present when `scaleTier` is set to `CUSTOM` and `parameter_server_count` is greater than zero.
typestring
pythonModule
descriptionRequired. The Python module name to run after installing the packages.
typestring
pythonVersion
descriptionOptional. The version of Python used in training. You must either specify this field or specify `masterConfig.imageUri`. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list).
typestring
region
descriptionRequired. The region to run the training job in. See the [available regions](/ai-platform/training/docs/regions) for AI Platform Training.
typestring
runtimeVersion
descriptionOptional. The AI Platform runtime version to use for training. You must either specify this field or specify `masterConfig.imageUri`. For more information, see the [runtime version list](/ai-platform/training/docs/runtime-version-list) and learn [how to manage runtime versions](/ai-platform/training/docs/versioning).
typestring
scaleTier
descriptionRequired. Specifies the machine types, the number of replicas for workers and parameter servers.
enum
  • BASIC
  • STANDARD_1
  • PREMIUM_1
  • BASIC_GPU
  • BASIC_TPU
  • CUSTOM
enumDescriptions
  • A single worker instance. This tier is suitable for learning how to use Cloud ML, and for experimenting with new models using small datasets.
  • Many workers and a few parameter servers.
  • A large number of workers with many parameter servers.
  • A single worker instance [with a GPU](/ai-platform/training/docs/using-gpus).
  • A single worker instance with a [Cloud TPU](/ml-engine/docs/tensorflow/using-tpus).
  • The CUSTOM tier is not a set tier, but rather enables you to use your own cluster specification. When you use this tier, set values to configure your processing cluster according to these guidelines: * You _must_ set `TrainingInput.masterType` to specify the type of machine to use for your master node. This is the only required setting. * You _may_ set `TrainingInput.workerCount` to specify the number of workers to use. If you specify one or more workers, you _must_ also set `TrainingInput.workerType` to specify the type of machine to use for your worker nodes. * You _may_ set `TrainingInput.parameterServerCount` to specify the number of parameter servers to use. If you specify one or more parameter servers, you _must_ also set `TrainingInput.parameterServerType` to specify the type of machine to use for your parameter servers. Note that all of your workers must use the same machine type, which can be different from your parameter server type and master type. Your parameter servers must likewise use the same machine type, which can be different from your worker type and master type.
typestring
scheduling
$refGoogleCloudMlV1__Scheduling
descriptionOptional. Scheduling options for a training job.
serviceAccount
descriptionOptional. The email address of a service account to use when running the training appplication. You must have the `iam.serviceAccounts.actAs` permission for the specified service account. In addition, the AI Platform Training Google-managed service account must have the `roles/iam.serviceAccountAdmin` role for the specified service account. [Learn more about configuring a service account.](/ai-platform/training/docs/custom-service-account) If not specified, the AI Platform Training Google-managed service account is used by default.
typestring
useChiefInTfConfig
descriptionOptional. Use `chief` instead of `master` in the `TF_CONFIG` environment variable when training with a custom container. Defaults to `false`. [Learn more about this field.](/ai-platform/training/docs/distributed-training-details#chief-versus-master) This field has no effect for training jobs that don't use a custom container.
typeboolean
workerConfig
$refGoogleCloudMlV1__ReplicaConfig
descriptionOptional. The configuration for workers. You should only set `workerConfig.acceleratorConfig` if `workerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `workerConfig.imageUri` only if you build a custom image for your worker. If `workerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers).
workerCount
descriptionOptional. The number of worker replicas to use for the training job. Each replica in the cluster will be of the type specified in `worker_type`. This value can only be used when `scale_tier` is set to `CUSTOM`. If you set this value, you must also set `worker_type`. The default value is zero.
formatint64
typestring
workerType
descriptionOptional. Specifies the type of virtual machine to use for your training job's worker nodes. The supported values are the same as those described in the entry for `masterType`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be Compute Engine machine types or both must be legacy machine types. If you use `cloud_tpu` for this value, see special instructions for [configuring a custom TPU machine](/ml-engine/docs/tensorflow/using-tpus#configuring_a_custom_tpu_machine). This value must be present when `scaleTier` is set to `CUSTOM` and `workerCount` is greater than zero.
typestring
typeobject
GoogleCloudMlV1__TrainingOutput
descriptionRepresents results of a training job. Output only.
idGoogleCloudMlV1__TrainingOutput
properties
builtInAlgorithmOutput
$refGoogleCloudMlV1__BuiltInAlgorithmOutput
descriptionDetails related to built-in algorithms jobs. Only set for built-in algorithms jobs.
completedTrialCount
descriptionThe number of hyperparameter tuning trials that completed successfully. Only set for hyperparameter tuning jobs.
formatint64
typestring
consumedMLUnits
descriptionThe amount of ML units consumed by the job.
formatdouble
typenumber
hyperparameterMetricTag
descriptionThe TensorFlow summary tag name used for optimizing hyperparameter tuning trials. See [`HyperparameterSpec.hyperparameterMetricTag`](#HyperparameterSpec.FIELDS.hyperparameter_metric_tag) for more information. Only set for hyperparameter tuning jobs.
typestring
isBuiltInAlgorithmJob
descriptionWhether this job is a built-in Algorithm job.
typeboolean
isHyperparameterTuningJob
descriptionWhether this job is a hyperparameter tuning job.
typeboolean
trials
descriptionResults for individual Hyperparameter trials. Only set for hyperparameter tuning jobs.
items
$refGoogleCloudMlV1__HyperparameterOutput
typearray
webAccessUris
additionalProperties
typestring
descriptionOutput only. URIs for accessing [interactive shells](https://cloud.google.com/ai-platform/training/docs/monitor-debug-interactive-shell) (one URI for each training node). Only available if training_input.enable_web_access is `true`. The keys are names of each node in the training job; for example, `master-replica-0` for the master node, `worker-replica-0` for the first worker, and `ps-replica-0` for the first parameter server. The values are the URIs for each node's interactive shell.
readOnlyTrue
typeobject
typeobject
GoogleCloudMlV1__Trial
descriptionA message representing a trial.
idGoogleCloudMlV1__Trial
properties
clientId
descriptionOutput only. The identifier of the client that originally requested this trial.
readOnlyTrue
typestring
endTime
descriptionOutput only. Time at which the trial's status changed to COMPLETED.
formatgoogle-datetime
readOnlyTrue
typestring
finalMeasurement
$refGoogleCloudMlV1__Measurement
descriptionThe final measurement containing the objective value.
infeasibleReason
descriptionOutput only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
readOnlyTrue
typestring
measurements
descriptionA list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
items
$refGoogleCloudMlV1__Measurement
typearray
name
descriptionOutput only. Name of the trial assigned by the service.
readOnlyTrue
typestring
parameters
descriptionThe parameters of the trial.
items
$refGoogleCloudMlV1_Trial_Parameter
typearray
startTime
descriptionOutput only. Time at which the trial was started.
formatgoogle-datetime
readOnlyTrue
typestring
state
descriptionThe detailed state of a trial.
enum
  • STATE_UNSPECIFIED
  • REQUESTED
  • ACTIVE
  • COMPLETED
  • STOPPING
enumDescriptions
  • The trial state is unspecified.
  • Indicates that a specific trial has been requested, but it has not yet been suggested by the service.
  • Indicates that the trial has been suggested.
  • Indicates that the trial is done, and either has a final_measurement set, or is marked as trial_infeasible.
  • Indicates that the trial should stop according to the service.
typestring
trialInfeasible
descriptionOutput only. If true, the parameters in this trial are not attempted again.
readOnlyTrue
typeboolean
typeobject
GoogleCloudMlV1__Version
descriptionRepresents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling projects.models.versions.list.
idGoogleCloudMlV1__Version
properties
acceleratorConfig
$refGoogleCloudMlV1__AcceleratorConfig
descriptionOptional. Accelerator config for using GPUs for online prediction (beta). Only specify this field if you have specified a Compute Engine (N1) machine type in the `machineType` field. Learn more about [using GPUs for online prediction](/ml-engine/docs/machine-types-online-prediction#gpus).
autoScaling
$refGoogleCloudMlV1__AutoScaling
descriptionAutomatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes.
container
$refGoogleCloudMlV1__ContainerSpec
descriptionOptional. Specifies a custom container to use for serving predictions. If you specify this field, then `machineType` is required. If you specify this field, then `deploymentUri` is optional. If you specify this field, then you must not specify `runtimeVersion`, `packageUris`, `framework`, `pythonVersion`, or `predictionClass`.
createTime
descriptionOutput only. The time the version was created.
formatgoogle-datetime
typestring
deploymentUri
descriptionThe Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the [guide to deploying models](/ai-platform/prediction/docs/deploying-models) for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn [how to use this field with a custom container](/ai-platform/prediction/docs/custom-container-requirements#artifacts).
typestring
description
descriptionOptional. The description specified for the version when it was created.
typestring
errorMessage
descriptionOutput only. The details of a failure or a cancellation.
typestring
etag
description`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetVersion`, and systems are expected to put that etag in the request to `UpdateVersion` to ensure that their change will be applied to the model as intended.
formatbyte
typestring
explanationConfig
$refGoogleCloudMlV1__ExplanationConfig
descriptionOptional. Configures explainability features on the model's version. Some explanation features require additional metadata to be loaded as part of the model payload.
framework
descriptionOptional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ai-platform/prediction/docs/custom-prediction-routines) or if you're using a [custom container](/ai-platform/prediction/docs/use-custom-container).
enum
  • FRAMEWORK_UNSPECIFIED
  • TENSORFLOW
  • SCIKIT_LEARN
  • XGBOOST
enumDescriptions
  • Unspecified framework. Assigns a value based on the file suffix.
  • Tensorflow framework.
  • Scikit-learn framework.
  • XGBoost framework.
typestring
isDefault
descriptionOutput only. If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault.
typeboolean
labels
additionalProperties
typestring
descriptionOptional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models.
typeobject
lastMigrationModelId
descriptionOutput only. The [AI Platform (Unified) `Model`](https://cloud.google.com/ai-platform-unified/docs/reference/rest/v1beta1/projects.locations.models) ID for the last [model migration](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform-unified).
readOnlyTrue
typestring
lastMigrationTime
descriptionOutput only. The last time this version was successfully [migrated to AI Platform (Unified)](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform-unified).
formatgoogle-datetime
readOnlyTrue
typestring
lastUseTime
descriptionOutput only. The time the version was last used for prediction.
formatgoogle-datetime
typestring
machineType
descriptionOptional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read [Choosing a machine type for online prediction](/ai-platform/prediction/docs/machine-types-online-prediction). If this field is not specified and you are using a [regional endpoint](/ai-platform/prediction/docs/regional-endpoints), then the machine type defaults to `n1-standard-2`. If this field is not specified and you are using the global endpoint (`ml.googleapis.com`), then the machine type defaults to `mls1-c1-m2`.
typestring
manualScaling
$refGoogleCloudMlV1__ManualScaling
descriptionManually select the number of nodes to use for serving the model. You should generally use `auto_scaling` with an appropriate `min_nodes` instead, but this option is available if you want more predictable billing. Beware that latency and error rates will increase if the traffic exceeds that capability of the system to serve it based on the selected number of nodes.
name
descriptionRequired. The name specified for the version when it was created. The version name must be unique within the model it is created in.
typestring
packageUris
descriptionOptional. Cloud Storage paths (`gs://…`) of packages for [custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines) or [scikit-learn pipelines with custom code](/ml-engine/docs/scikit/exporting-for-prediction#custom-pipeline-code). For a custom prediction routine, one of these packages must contain your Predictor class (see [`predictionClass`](#Version.FIELDS.prediction_class)). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected [runtime version](/ml-engine/docs/tensorflow/runtime-version-list). If you specify this field, you must also set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater.
items
typestring
typearray
predictionClass
descriptionOptional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines).
typestring
pythonVersion
descriptionRequired. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list).
typestring
requestLoggingConfig
$refGoogleCloudMlV1__RequestLoggingConfig
descriptionOptional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version.
routes
$refGoogleCloudMlV1__RouteMap
descriptionOptional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values.
runtimeVersion
descriptionRequired. The AI Platform runtime version to use for this deployment. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning).
typestring
serviceAccount
descriptionOptional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the `containerSpec` or the `predictionClass` field. Learn more about [using a custom service account](/ai-platform/prediction/docs/custom-service-account).
typestring
state
descriptionOutput only. The state of a version.
enum
  • UNKNOWN
  • READY
  • CREATING
  • FAILED
  • DELETING
  • UPDATING
enumDescriptions
  • The version state is unspecified.
  • The version is ready for prediction.
  • The version is being created. New UpdateVersion and DeleteVersion requests will fail if a version is in the CREATING state.
  • The version failed to be created, possibly cancelled. `error_message` should contain the details of the failure.
  • The version is being deleted. New UpdateVersion and DeleteVersion requests will fail if a version is in the DELETING state.
  • The version is being updated. New UpdateVersion and DeleteVersion requests will fail if a version is in the UPDATING state.
typestring
typeobject
GoogleCloudMlV1__XraiAttribution
descriptionAttributes credit by computing the XRAI taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Currently only implemented for models with natural image inputs.
idGoogleCloudMlV1__XraiAttribution
properties
numIntegralSteps
descriptionNumber 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.
formatint32
typeinteger
typeobject
GoogleIamV1__AuditConfig
descriptionSpecifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
idGoogleIamV1__AuditConfig
properties
auditLogConfigs
descriptionThe configuration for logging of each type of permission.
items
$refGoogleIamV1__AuditLogConfig
typearray
service
descriptionSpecifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
typestring
typeobject
GoogleIamV1__AuditLogConfig
descriptionProvides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
idGoogleIamV1__AuditLogConfig
properties
exemptedMembers
descriptionSpecifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
items
typestring
typearray
logType
descriptionThe log type that this config enables.
enum
  • LOG_TYPE_UNSPECIFIED
  • ADMIN_READ
  • DATA_WRITE
  • DATA_READ
enumDescriptions
  • Default case. Should never be this.
  • Admin reads. Example: CloudIAM getIamPolicy
  • Data writes. Example: CloudSQL Users create
  • Data reads. Example: CloudSQL Users list
typestring
typeobject
GoogleIamV1__Binding
descriptionAssociates `members`, or principals, with a `role`.
idGoogleIamV1__Binding
properties
condition
$refGoogleType__Expr
descriptionThe condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
members
descriptionSpecifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
items
typestring
typearray
role
descriptionRole that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
typestring
typeobject
GoogleIamV1__Policy
descriptionAn Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
idGoogleIamV1__Policy
properties
auditConfigs
descriptionSpecifies cloud audit logging configuration for this policy.
items
$refGoogleIamV1__AuditConfig
typearray
bindings
descriptionAssociates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
items
$refGoogleIamV1__Binding
typearray
etag
description`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
formatbyte
typestring
version
descriptionSpecifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
formatint32
typeinteger
typeobject
GoogleIamV1__SetIamPolicyRequest
descriptionRequest message for `SetIamPolicy` method.
idGoogleIamV1__SetIamPolicyRequest
properties
policy
$refGoogleIamV1__Policy
descriptionREQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
updateMask
descriptionOPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
formatgoogle-fieldmask
typestring
typeobject
GoogleIamV1__TestIamPermissionsRequest
descriptionRequest message for `TestIamPermissions` method.
idGoogleIamV1__TestIamPermissionsRequest
properties
permissions
descriptionThe set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
items
typestring
typearray
typeobject
GoogleIamV1__TestIamPermissionsResponse
descriptionResponse message for `TestIamPermissions` method.
idGoogleIamV1__TestIamPermissionsResponse
properties
permissions
descriptionA subset of `TestPermissionsRequest.permissions` that the caller is allowed.
items
typestring
typearray
typeobject
GoogleLongrunning__ListOperationsResponse
descriptionThe response message for Operations.ListOperations.
idGoogleLongrunning__ListOperationsResponse
properties
nextPageToken
descriptionThe standard List next-page token.
typestring
operations
descriptionA list of operations that matches the specified filter in the request.
items
$refGoogleLongrunning__Operation
typearray
typeobject
GoogleLongrunning__Operation
descriptionThis resource represents a long-running operation that is the result of a network API call.
idGoogleLongrunning__Operation
properties
done
descriptionIf the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
typeboolean
error
$refGoogleRpc__Status
descriptionThe error result of the operation in case of failure or cancellation.
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
typeobject
name
descriptionThe server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
typestring
response
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionThe normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
typeobject
typeobject
GoogleProtobuf__Empty
descriptionA generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
idGoogleProtobuf__Empty
properties
typeobject
GoogleRpc__Status
descriptionThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
idGoogleRpc__Status
properties
code
descriptionThe status code, which should be an enum value of google.rpc.Code.
formatint32
typeinteger
details
descriptionA list of messages that carry the error details. There is a common set of message types for APIs to use.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
message
descriptionA developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
typestring
typeobject
GoogleType__Expr
descriptionRepresents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
idGoogleType__Expr
properties
description
descriptionOptional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
typestring
expression
descriptionTextual representation of an expression in Common Expression Language syntax.
typestring
location
descriptionOptional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
typestring
title
descriptionOptional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
typestring
typeobject
root['title']
new_valueAI Platform Training & Prediction Private API
old_valueAI Platform Training & Prediction API
prod/mlengine-pa-v1
dictionary_item_added
  • root['resources']['v1']
dictionary_item_removed
  • root['auth']
  • root['resources']['projects']['methods']
values_changed
root['baseUrl']
new_valuehttps://mlengine-pa.googleapis.com/
old_valuehttps://ml.googleapis.com/
root['canonicalName']
new_valueMachine Learning Engine Private Service
old_valueCloud Machine Learning Engine
root['description']
new_valuePrivate API to manages internal resources for Cloud ML Engine.
old_valueAn API to enable creating and using machine learning models.
root['documentationLink']
new_valuehttp://go/cloud-mlengine-private
old_valuehttps://cloud.google.com/ml/
root['id']
new_valuemlengine_pa:v1
old_valueml:v1
root['mtlsRootUrl']
new_valuehttps://mlengine-pa.mtls.googleapis.com/
old_valuehttps://ml.mtls.googleapis.com/
root['name']
new_valuemlengine_pa
old_valueml
root['resources']['projects']['resources']
new_value
trainingJob
resources
trainingWorker
methods
reportStatus
descriptionReportStatus reports the status of the worker to the control plane.
flatPathv1/projects/{projectId}/trainingJob/{trainingJobId}/trainingWorker/{trainingWorkerId}:reportStatus
httpMethodPOST
idmlengine_pa.projects.trainingJob.trainingWorker.reportStatus
parameterOrder
  • projectId
  • trainingJobId
  • trainingWorkerId
parameters
projectId
descriptionThe ID of the project where the Cloud ML compute resources are running ( a.k.a. the shadow project).
locationpath
requiredTrue
typestring
trainingJobId
descriptionThe ID of the Cloud ML training job.
locationpath
requiredTrue
typestring
trainingWorkerId
descriptionThe ID of the worker (i.e., the instance ID of the virtual machine running the Cloud ML worker process).
locationpath
requiredTrue
typestring
pathv1/projects/{projectId}/trainingJob/{trainingJobId}/trainingWorker/{trainingWorkerId}:reportStatus
request
$refReportStatusRequest
response
$refReportStatusResponse
old_value
jobs
methods
cancel
descriptionCancels a running job.
flatPathv1/projects/{projectsId}/jobs/{jobsId}:cancel
httpMethodPOST
idml.projects.jobs.cancel
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the job to cancel.
locationpath
pattern^projects/[^/]+/jobs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:cancel
request
$refGoogleCloudMlV1__CancelJobRequest
response
$refGoogleProtobuf__Empty
scopes
  • https://www.googleapis.com/auth/cloud-platform
create
descriptionCreates a training or a batch prediction job.
flatPathv1/projects/{projectsId}/jobs
httpMethodPOST
idml.projects.jobs.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. The project name.
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/jobs
request
$refGoogleCloudMlV1__Job
response
$refGoogleCloudMlV1__Job
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionDescribes a job.
flatPathv1/projects/{projectsId}/jobs/{jobsId}
httpMethodGET
idml.projects.jobs.get
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the job to get the description of.
locationpath
pattern^projects/[^/]+/jobs/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleCloudMlV1__Job
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
getIamPolicy
descriptionGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
flatPathv1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy
httpMethodGET
idml.projects.jobs.getIamPolicy
parameterOrder
  • resource
parameters
options.requestedPolicyVersion
descriptionOptional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
formatint32
locationquery
typeinteger
resource
descriptionREQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/jobs/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:getIamPolicy
response
$refGoogleIamV1__Policy
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}.
flatPathv1/projects/{projectsId}/jobs
httpMethodGET
idml.projects.jobs.list
parameterOrder
  • parent
parameters
filter
descriptionOptional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census': gcloud ai-platform jobs list --filter='jobId:census*' List all failed jobs with names that start with 'rnn': gcloud ai-platform jobs list --filter='jobId:rnn* AND state:FAILED' For more examples, see the guide to monitoring jobs.
locationquery
typestring
pageSize
descriptionOptional. The number of jobs to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
locationquery
typestring
parent
descriptionRequired. The name of the project for which to list jobs.
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/jobs
response
$refGoogleCloudMlV1__ListJobsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
patch
descriptionUpdates a specific job resource. Currently the only supported fields to update are `labels`.
flatPathv1/projects/{projectsId}/jobs/{jobsId}
httpMethodPATCH
idml.projects.jobs.patch
parameterOrder
  • name
parameters
name
descriptionRequired. The job name.
locationpath
pattern^projects/[^/]+/jobs/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired. Specifies the path, relative to `Job`, of the field to update. To adopt etag mechanism, include `etag` field in the mask, and include the `etag` value in your job resource. For example, to change the labels of a job, the `update_mask` parameter would be specified as `labels`, `etag`, and the `PATCH` request body would specify the new value, as follows: { "labels": { "owner": "Google", "color": "Blue" } "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4" } If `etag` matches the one on the server, the labels of the job will be replaced with the given ones, and the server end `etag` will be recalculated. Currently the only supported update masks are `labels` and `etag`.
formatgoogle-fieldmask
locationquery
typestring
pathv1/{+name}
request
$refGoogleCloudMlV1__Job
response
$refGoogleCloudMlV1__Job
scopes
  • https://www.googleapis.com/auth/cloud-platform
setIamPolicy
descriptionSets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
flatPathv1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy
httpMethodPOST
idml.projects.jobs.setIamPolicy
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/jobs/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:setIamPolicy
request
$refGoogleIamV1__SetIamPolicyRequest
response
$refGoogleIamV1__Policy
scopes
  • https://www.googleapis.com/auth/cloud-platform
testIamPermissions
descriptionReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
flatPathv1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions
httpMethodPOST
idml.projects.jobs.testIamPermissions
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/jobs/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:testIamPermissions
request
$refGoogleIamV1__TestIamPermissionsRequest
response
$refGoogleIamV1__TestIamPermissionsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
locations
methods
get
descriptionGet the complete list of CMLE capabilities in a location, along with their location-specific properties.
flatPathv1/projects/{projectsId}/locations/{locationsId}
httpMethodGET
idml.projects.locations.get
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the location.
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleCloudMlV1__Location
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
list
descriptionList all locations that provides at least one type of CMLE capability.
flatPathv1/projects/{projectsId}/locations
httpMethodGET
idml.projects.locations.list
parameterOrder
  • parent
parameters
pageSize
descriptionOptional. The number of locations to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
locationquery
typestring
parent
descriptionRequired. The name of the project for which available locations are to be listed (since some locations might be whitelisted for specific projects).
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/locations
response
$refGoogleCloudMlV1__ListLocationsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
resources
operations
methods
cancel
descriptionStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
flatPathv1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
httpMethodPOST
idml.projects.locations.operations.cancel
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource to be cancelled.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1/{+name}:cancel
response
$refGoogleProtobuf__Empty
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
flatPathv1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
httpMethodGET
idml.projects.locations.operations.get
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
studies
methods
create
descriptionCreates a study.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies
httpMethodPOST
idml.projects.locations.studies.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. The project and location that the study belongs to. Format: projects/{project}/locations/{location}
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
studyId
descriptionRequired. The ID to use for the study, which will become the final component of the study's resource name.
locationquery
typestring
pathv1/{+parent}/studies
request
$refGoogleCloudMlV1__Study
response
$refGoogleCloudMlV1__Study
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes a study.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}
httpMethodDELETE
idml.projects.locations.studies.delete
parameterOrder
  • name
parameters
name
descriptionRequired. The study name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleProtobuf__Empty
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets a study.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}
httpMethodGET
idml.projects.locations.studies.get
parameterOrder
  • name
parameters
name
descriptionRequired. The study name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleCloudMlV1__Study
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists all the studies in a region for an associated project.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies
httpMethodGET
idml.projects.locations.studies.list
parameterOrder
  • parent
parameters
parent
descriptionRequired. The project and location that the study belongs to. Format: projects/{project}/locations/{location}
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/studies
response
$refGoogleCloudMlV1__ListStudiesResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
resources
trials
methods
addMeasurement
descriptionAdds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addMeasurement
httpMethodPOST
idml.projects.locations.studies.trials.addMeasurement
parameterOrder
  • name
parameters
name
descriptionRequired. The trial name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
requiredTrue
typestring
pathv1/{+name}:addMeasurement
request
$refGoogleCloudMlV1__AddTrialMeasurementRequest
response
$refGoogleCloudMlV1__Trial
scopes
  • https://www.googleapis.com/auth/cloud-platform
checkEarlyStoppingState
descriptionChecks whether a trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkEarlyStoppingState
httpMethodPOST
idml.projects.locations.studies.trials.checkEarlyStoppingState
parameterOrder
  • name
parameters
name
descriptionRequired. The trial name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
requiredTrue
typestring
pathv1/{+name}:checkEarlyStoppingState
request
$refGoogleCloudMlV1__CheckTrialEarlyStoppingStateRequest
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
complete
descriptionMarks a trial as complete.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete
httpMethodPOST
idml.projects.locations.studies.trials.complete
parameterOrder
  • name
parameters
name
descriptionRequired. The trial name.metat
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
requiredTrue
typestring
pathv1/{+name}:complete
request
$refGoogleCloudMlV1__CompleteTrialRequest
response
$refGoogleCloudMlV1__Trial
scopes
  • https://www.googleapis.com/auth/cloud-platform
create
descriptionAdds a user provided trial to a study.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials
httpMethodPOST
idml.projects.locations.studies.trials.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. The name of the study that the trial belongs to.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/trials
request
$refGoogleCloudMlV1__Trial
response
$refGoogleCloudMlV1__Trial
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes a trial.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}
httpMethodDELETE
idml.projects.locations.studies.trials.delete
parameterOrder
  • name
parameters
name
descriptionRequired. The trial name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleProtobuf__Empty
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets a trial.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}
httpMethodGET
idml.projects.locations.studies.trials.get
parameterOrder
  • name
parameters
name
descriptionRequired. The trial name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleCloudMlV1__Trial
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists the trials associated with a study.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials
httpMethodGET
idml.projects.locations.studies.trials.list
parameterOrder
  • parent
parameters
parent
descriptionRequired. The name of the study that the trial belongs to.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/trials
response
$refGoogleCloudMlV1__ListTrialsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
listOptimalTrials
descriptionLists 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
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials
httpMethodPOST
idml.projects.locations.studies.trials.listOptimalTrials
parameterOrder
  • parent
parameters
parent
descriptionRequired. The name of the study that the pareto-optimal trial belongs to.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/trials:listOptimalTrials
request
$refGoogleCloudMlV1__ListOptimalTrialsRequest
response
$refGoogleCloudMlV1__ListOptimalTrialsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
stop
descriptionStops a trial.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop
httpMethodPOST
idml.projects.locations.studies.trials.stop
parameterOrder
  • name
parameters
name
descriptionRequired. The trial name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
requiredTrue
typestring
pathv1/{+name}:stop
request
$refGoogleCloudMlV1__StopTrialRequest
response
$refGoogleCloudMlV1__Trial
scopes
  • https://www.googleapis.com/auth/cloud-platform
suggest
descriptionAdds one or more trials to a study, with parameter values suggested by AI Platform Vizier. Returns a long-running operation associated with the generation of trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.
flatPathv1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest
httpMethodPOST
idml.projects.locations.studies.trials.suggest
parameterOrder
  • parent
parameters
parent
descriptionRequired. The name of the study that the trial belongs to.
locationpath
pattern^projects/[^/]+/locations/[^/]+/studies/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/trials:suggest
request
$refGoogleCloudMlV1__SuggestTrialsRequest
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
models
methods
create
descriptionCreates a model which will later contain one or more versions. You must add at least one version before you can request predictions from the model. Add versions by calling projects.models.versions.create.
flatPathv1/projects/{projectsId}/models
httpMethodPOST
idml.projects.models.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. The project name.
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/models
request
$refGoogleCloudMlV1__Model
response
$refGoogleCloudMlV1__Model
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes a model. You can only delete a model if there are no versions in it. You can delete versions by calling projects.models.versions.delete.
flatPathv1/projects/{projectsId}/models/{modelsId}
httpMethodDELETE
idml.projects.models.delete
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the model.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets information about a model, including its name, the description (if set), and the default version (if at least one version of the model has been deployed).
flatPathv1/projects/{projectsId}/models/{modelsId}
httpMethodGET
idml.projects.models.get
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the model.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleCloudMlV1__Model
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
getIamPolicy
descriptionGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
flatPathv1/projects/{projectsId}/models/{modelsId}:getIamPolicy
httpMethodGET
idml.projects.models.getIamPolicy
parameterOrder
  • resource
parameters
options.requestedPolicyVersion
descriptionOptional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
formatint32
locationquery
typeinteger
resource
descriptionREQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:getIamPolicy
response
$refGoogleIamV1__Policy
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the request parameters, the list request returns an empty response body: {}.
flatPathv1/projects/{projectsId}/models
httpMethodGET
idml.projects.models.list
parameterOrder
  • parent
parameters
filter
descriptionOptional. Specifies the subset of models to retrieve.
locationquery
typestring
pageSize
descriptionOptional. The number of models to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
locationquery
typestring
parent
descriptionRequired. The name of the project whose models are to be listed.
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/models
response
$refGoogleCloudMlV1__ListModelsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
patch
descriptionUpdates a specific model resource. Currently the only supported fields to update are `description` and `default_version.name`.
flatPathv1/projects/{projectsId}/models/{modelsId}
httpMethodPATCH
idml.projects.models.patch
parameterOrder
  • name
parameters
name
descriptionRequired. The project name.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired. Specifies the path, relative to `Model`, of the field to update. For example, to change the description of a model to "foo" and set its default version to "version_1", the `update_mask` parameter would be specified as `description`, `default_version.name`, and the `PATCH` request body would specify the new value, as follows: { "description": "foo", "defaultVersion": { "name":"version_1" } } Currently the supported update masks are `description` and `default_version.name`.
formatgoogle-fieldmask
locationquery
typestring
pathv1/{+name}
request
$refGoogleCloudMlV1__Model
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
setIamPolicy
descriptionSets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
flatPathv1/projects/{projectsId}/models/{modelsId}:setIamPolicy
httpMethodPOST
idml.projects.models.setIamPolicy
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:setIamPolicy
request
$refGoogleIamV1__SetIamPolicyRequest
response
$refGoogleIamV1__Policy
scopes
  • https://www.googleapis.com/auth/cloud-platform
testIamPermissions
descriptionReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
flatPathv1/projects/{projectsId}/models/{modelsId}:testIamPermissions
httpMethodPOST
idml.projects.models.testIamPermissions
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:testIamPermissions
request
$refGoogleIamV1__TestIamPermissionsRequest
response
$refGoogleIamV1__TestIamPermissionsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
resources
versions
methods
create
descriptionCreates a new version of a model from a trained TensorFlow model. If the version created in the cloud by this call is the first deployed version of the specified model, it will be made the default version of the model. When you add a version to a model that already has one or more versions, the default version does not automatically change. If you want a new version to be the default, you must call projects.models.versions.setDefault.
flatPathv1/projects/{projectsId}/models/{modelsId}/versions
httpMethodPOST
idml.projects.models.versions.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. The name of the model.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/versions
request
$refGoogleCloudMlV1__Version
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes a model version. Each model can have multiple versions deployed and in use at any given time. Use this method to remove a single version. Note: You cannot delete the version that is set as the default version of the model unless it is the only remaining version.
flatPathv1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}
httpMethodDELETE
idml.projects.models.versions.delete
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the version. You can get the names of all the versions of a model by calling projects.models.versions.list.
locationpath
pattern^projects/[^/]+/models/[^/]+/versions/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets information about a model version. Models can have multiple versions. You can call projects.models.versions.list to get the same information that this method returns for all of the versions of a model.
flatPathv1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}
httpMethodGET
idml.projects.models.versions.get
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the version.
locationpath
pattern^projects/[^/]+/models/[^/]+/versions/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleCloudMlV1__Version
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionGets basic information about all the versions of a model. If you expect that a model has many versions, or if you need to handle only a limited number of results at a time, you can request that the list be retrieved in batches (called pages). If there are no versions that match the request parameters, the list request returns an empty response body: {}.
flatPathv1/projects/{projectsId}/models/{modelsId}/versions
httpMethodGET
idml.projects.models.versions.list
parameterOrder
  • parent
parameters
filter
descriptionOptional. Specifies the subset of versions to retrieve.
locationquery
typestring
pageSize
descriptionOptional. The number of versions to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
locationquery
typestring
parent
descriptionRequired. The name of the model for which to list the version.
locationpath
pattern^projects/[^/]+/models/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/versions
response
$refGoogleCloudMlV1__ListVersionsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
patch
descriptionUpdates the specified Version resource. Currently the only update-able fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`.
flatPathv1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}
httpMethodPATCH
idml.projects.models.versions.patch
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the model.
locationpath
pattern^projects/[^/]+/models/[^/]+/versions/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: ``` { "description": "foo" } ``` Currently the only supported update mask fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. However, you can only update `manualScaling.nodes` if the version uses a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction).
formatgoogle-fieldmask
locationquery
typestring
pathv1/{+name}
request
$refGoogleCloudMlV1__Version
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
setDefault
descriptionDesignates a version to be the default for the model. The default version is used for prediction requests made against the model that don't specify a version. The first version to be created for a model is automatically set as the default. You must make any subsequent changes to the default version setting manually using this method.
flatPathv1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault
httpMethodPOST
idml.projects.models.versions.setDefault
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the version to make the default for the model. You can get the names of all the versions of a model by calling projects.models.versions.list.
locationpath
pattern^projects/[^/]+/models/[^/]+/versions/[^/]+$
requiredTrue
typestring
pathv1/{+name}:setDefault
request
$refGoogleCloudMlV1__SetDefaultVersionRequest
response
$refGoogleCloudMlV1__Version
scopes
  • https://www.googleapis.com/auth/cloud-platform
operations
methods
cancel
descriptionStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
flatPathv1/projects/{projectsId}/operations/{operationsId}:cancel
httpMethodPOST
idml.projects.operations.cancel
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource to be cancelled.
locationpath
pattern^projects/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1/{+name}:cancel
response
$refGoogleProtobuf__Empty
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
flatPathv1/projects/{projectsId}/operations/{operationsId}
httpMethodGET
idml.projects.operations.get
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource.
locationpath
pattern^projects/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleLongrunning__Operation
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
flatPathv1/projects/{projectsId}/operations
httpMethodGET
idml.projects.operations.list
parameterOrder
  • name
parameters
filter
descriptionThe standard list filter.
locationquery
typestring
name
descriptionThe name of the operation's parent resource.
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pageSize
descriptionThe standard list page size.
formatint32
locationquery
typeinteger
pageToken
descriptionThe standard list page token.
locationquery
typestring
pathv1/{+name}/operations
response
$refGoogleLongrunning__ListOperationsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
root['revision']
new_value20250613
old_value20250118
root['rootUrl']
new_valuehttps://mlengine-pa.googleapis.com/
old_valuehttps://ml.googleapis.com/
root['schemas']
new_value
AcceleratorSpecs
idAcceleratorSpecs
properties
acceleratorType
descriptionRequired. The type of GPU.
enum
  • ACCELERATOR_TYPE_UNSPECIFIED
  • NVIDIA_TESLA_K80
  • NVIDIA_TESLA_P100
  • NVIDIA_TESLA_V100
  • NVIDIA_TESLA_P4
  • NVIDIA_TESLA_T4
  • NVIDIA_TESLA_A100
  • TPU_V2
  • TPU_V3
  • TPU_V2_POD
  • TPU_V3_POD
  • TPU_V4_POD
enumDescriptions
  • Unspecified accelerator type. Default to no GPU.
  • Nvidia Tesla K80 GPU.
  • Nvidia Tesla P100 GPU.
  • Nvidia V100 GPU.
  • Nvidia Tesla P4 GPU.
  • Nvidia T4 GPU.
  • Nvidia A100 GPU.
  • TPU v2.
  • TPU v3.
  • TPU v2 POD.
  • TPU v3 POD.
  • TPU v4 POD.
typestring
allowedCount
descriptionRequired. The number of GPUs allowed in this combination. Cannot be zero.
items
formatdouble
typenumber
typearray
typeobject
AcceleratorsListByRegion
descriptionFor each region, the list of eccelerators available.
idAcceleratorsListByRegion
properties
accelerators
items
enum
  • ACCELERATOR_TYPE_UNSPECIFIED
  • NVIDIA_TESLA_K80
  • NVIDIA_TESLA_P100
  • NVIDIA_TESLA_V100
  • NVIDIA_TESLA_P4
  • NVIDIA_TESLA_T4
  • NVIDIA_TESLA_A100
  • TPU_V2
  • TPU_V3
  • TPU_V2_POD
  • TPU_V3_POD
  • TPU_V4_POD
enumDescriptions
  • Unspecified accelerator type. Default to no GPU.
  • Nvidia Tesla K80 GPU.
  • Nvidia Tesla P100 GPU.
  • Nvidia V100 GPU.
  • Nvidia Tesla P4 GPU.
  • Nvidia T4 GPU.
  • Nvidia A100 GPU.
  • TPU v2.
  • TPU v3.
  • TPU v2 POD.
  • TPU v3 POD.
  • TPU v4 POD.
typestring
typearray
region
typestring
typeobject
AvailableAccelerators
idAvailableAccelerators
properties
acceleratorsListByRegion
descriptionList of all accelerators per region for training.
items
$refAcceleratorsListByRegion
typearray
opAcceleratorsListByRegion
descriptionList of all accelerators per region for online prediction.
items
$refAcceleratorsListByRegion
typearray
typeobject
AvailableMachines
idAvailableMachines
properties
availableGceMachineTypes
descriptionList of all GCE machine Types with available accelerators.
items
$refMachineSpecs
typearray
availableOpGceMachineTypes
descriptionList of all online prediction GCE machine Types with available accelerators.
items
$refMachineSpecs
typearray
typeobject
Config
descriptionApi configuration of Cloud ML frontend. Contains information that the end user need to know such as supported machine types, and information about CMLE runtime versions.
idConfig
properties
machineTypes
descriptionList of all available machine types.
items
$refMachineType
typearray
opRuntimeVersions
descriptionList of all available CMLE OP only runtime versions.
items
$refRuntimeVersion
typearray
runtimeVersions
descriptionList of all available CMLE runtime versions.
items
$refRuntimeVersion
typearray
typeobject
ContainerState
descriptionContainerState stores the current state of the container. See this reference for more details: https://docs.docker.com/engine/api/v1.30/#
idContainerState
properties
customContainerImagePullError
descriptionThe details of error happened when pulling the custom container image. This field is populated if custom_container_image_pull_state = FAILURE.
typestring
customContainerImagePullState
descriptionThe state of pulling custom container image. The possible values are "PULLING", "SUCCESS" and "FAILURE".
typestring
dead
descriptionWhether the container is dead.
typeboolean
diskUsagePercentage
descriptionDisk usage percentage of "/". The value is between [0, 100].
formatint32
typeinteger
error
descriptionThe error returned by the container
typestring
exitCode
descriptionThe exit code if the container finished.
formatint64
typestring
finishedAt
descriptionWhen the container finished.
formatgoogle-datetime
typestring
isStuckInGettingState
descriptionWhether the container is stuck in getting state
typeboolean
nfsMountError
descriptionThe error occurred when mounting nfs server
typestring
oomKilled
descriptionWhether the container has run out of memory.
typeboolean
paused
descriptionWhether the container is paused.
typeboolean
pid
descriptionThe PID of the container.
formatint64
typestring
restarting
descriptionWhether the container is restarting.
typeboolean
running
descriptionWhether the container is running.
typeboolean
startedAt
descriptionWhen the container started.
formatgoogle-datetime
typestring
status
descriptionThe current status.
typestring
terminationLog
descriptionThe termination log generated by that container.
typestring
trainingContainerImagePullEndTime
descriptionThe end time of the pulling the training container image.
formatgoogle-datetime
typestring
trainingContainerImagePullStartTime
descriptionThe start time of the pulling the training container image.
formatgoogle-datetime
typestring
typeobject
ContainerStatus
descriptionContainerStatusReport provides information about a single container
idContainerStatus
properties
args
descriptionThe arguments to the command being run.
items
typestring
typearray
containerId
descriptionThe container ID used in the Spanner table key. It is identical for all training containers.
typestring
createdAt
descriptionWhen the container was created.
formatgoogle-datetime
typestring
dockerId
descriptionThe ID of this container, according to Docker.
typestring
dockerName
descriptionThe name of this container, according to Docker.
typestring
image
descriptionThe container's image.
typestring
lastUpdatedAt
descriptionWhen the status of the container was last updated.
formatgoogle-datetime
typestring
path
descriptionThe path to the command being run.
typestring
restartCount
descriptionThe number of times the container restarted.
formatint32
typeinteger
state
$refContainerState
descriptionThe state of the container.
typeobject
FrameworkVersion
descriptionRepresents a specific version of a framework.
idFrameworkVersion
properties
framework
enum
  • FRAMEWORK_UNSPECIFIED
  • TENSORFLOW
  • SCIKIT_LEARN
  • XGBOOST
enumDescriptions
  • Unspecified framework. Assigns a value based on the file suffix.
  • Tensorflow framework.
  • Scikit-learn framework.
  • XGBoost framework.
typestring
version
typestring
typeobject
MachineSpecs
idMachineSpecs
properties
availableAccelerators
descriptionOptional. Different accelerator configurations allowed.
items
$refAcceleratorSpecs
typearray
cpus
descriptionAvailable number of CPUs
formatdouble
typenumber
gceMachineName
descriptionRequired. GCE machine name.
typestring
ramBytes
descriptionAvailable RAM size.
formatuint64
typestring
typeobject
MachineType
idMachineType
properties
name
typestring
typeobject
ReportStatusRequest
descriptionReportStatusRequest is a request to report the status of a worker to the control plane.
idReportStatusRequest
properties
clusterName
descriptionThe name of the JMS cluster on which the container is running.
typestring
consumerProjectId
descriptionThe ID of the consumer project associated with the shadow project.
typestring
containerStatuses
descriptionThe status of the containers running on the virtual machine.
items
$refContainerStatus
typearray
typeobject
ReportStatusResponse
descriptionReportStatusTrainingWorkerResponse is the response from the control plane to worker status reports.
idReportStatusResponse
properties
typeobject
RuntimeVersion
descriptionCloud Machine Learning Engine uses images, based on runtime version designation, to configure cloud resources to service your training and prediction requests. Each `RuntimeVersion` contains information about its constituent packages.
idRuntimeVersion
properties
frameworks
descriptionList of all supported frameworks in this `RuntimeVersion` and their corresponding versions.
items
$refFrameworkVersion
typearray
libraries
additionalProperties
typestring
descriptionMap of each library and its corresponding version that is available in this runtime_version, similar to what is available in: https://cloud.google.com/ml-engine/docs/tensorflow/runtime-version-list Example: "numpy": "1.13.3", "pandas": "0.19.2", etc.
typeobject
name
typestring
supportedPythonVersions
descriptionList of all supported python versions for this runtime version. Note that these python versions are supported by all `frameworks`.
items
typestring
typearray
typeobject
old_value
GoogleApi__HttpBody
descriptionMessage that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
idGoogleApi__HttpBody
properties
contentType
descriptionThe HTTP Content-Type header value specifying the content type of the body.
typestring
data
descriptionThe HTTP request/response body as raw binary.
formatbyte
typestring
extensions
descriptionApplication specific response metadata. Must be set in the first response for streaming APIs.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
typeobject
GoogleCloudMlV1_AutomatedStoppingConfig_DecayCurveAutomatedStoppingConfig
idGoogleCloudMlV1_AutomatedStoppingConfig_DecayCurveAutomatedStoppingConfig
properties
useElapsedTime
descriptionIf true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
typeboolean
typeobject
GoogleCloudMlV1_AutomatedStoppingConfig_MedianAutomatedStoppingConfig
descriptionThe 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.
idGoogleCloudMlV1_AutomatedStoppingConfig_MedianAutomatedStoppingConfig
properties
useElapsedTime
descriptionIf true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial.
typeboolean
typeobject
GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric
descriptionAn observed value of a metric.
idGoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric
properties
objectiveValue
descriptionThe objective value at this training step.
formatdouble
typenumber
trainingStep
descriptionThe global training step for this metric.
formatint64
typestring
typeobject
GoogleCloudMlV1_Measurement_Metric
descriptionA message representing a metric in the measurement.
idGoogleCloudMlV1_Measurement_Metric
properties
metric
descriptionRequired. Metric name.
typestring
value
descriptionRequired. The value for this metric.
formatdouble
typenumber
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_CategoricalValueSpec
idGoogleCloudMlV1_StudyConfigParameterSpec_CategoricalValueSpec
properties
values
descriptionMust be specified if type is `CATEGORICAL`. The list of possible categories.
items
typestring
typearray
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_DiscreteValueSpec
idGoogleCloudMlV1_StudyConfigParameterSpec_DiscreteValueSpec
properties
values
descriptionMust be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. 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.
items
formatdouble
typenumber
typearray
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_DoubleValueSpec
idGoogleCloudMlV1_StudyConfigParameterSpec_DoubleValueSpec
properties
maxValue
descriptionMust be specified if type is `DOUBLE`. Maximum value of the parameter.
formatdouble
typenumber
minValue
descriptionMust be specified if type is `DOUBLE`. Minimum value of the parameter.
formatdouble
typenumber
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_IntegerValueSpec
idGoogleCloudMlV1_StudyConfigParameterSpec_IntegerValueSpec
properties
maxValue
descriptionMust be specified if type is `INTEGER`. Maximum value of the parameter.
formatint64
typestring
minValue
descriptionMust be specified if type is `INTEGER`. Minimum value of the parameter.
formatint64
typestring
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentCategoricalValueSpec
descriptionRepresents the spec to match categorical values from parent parameter.
idGoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentCategoricalValueSpec
properties
values
descriptionMatches values of the parent parameter with type 'CATEGORICAL'. All values must exist in `categorical_value_spec` of parent parameter.
items
typestring
typearray
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentDiscreteValueSpec
descriptionRepresents the spec to match discrete values from parent parameter.
idGoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentDiscreteValueSpec
properties
values
descriptionMatches values of the parent parameter with type 'DISCRETE'. All values must exist in `discrete_value_spec` of parent parameter.
items
formatdouble
typenumber
typearray
typeobject
GoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentIntValueSpec
descriptionRepresents the spec to match integer values from parent parameter.
idGoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentIntValueSpec
properties
values
descriptionMatches values of the parent parameter with type 'INTEGER'. All values must lie in `integer_value_spec` of parent parameter.
items
formatint64
typestring
typearray
typeobject
GoogleCloudMlV1_StudyConfig_MetricSpec
descriptionRepresents a metric to optimize.
idGoogleCloudMlV1_StudyConfig_MetricSpec
properties
goal
descriptionRequired. The optimization goal of the metric.
enum
  • GOAL_TYPE_UNSPECIFIED
  • MAXIMIZE
  • MINIMIZE
enumDescriptions
  • Goal Type will default to maximize.
  • Maximize the goal metric.
  • Minimize the goal metric.
typestring
metric
descriptionRequired. The name of the metric.
typestring
typeobject
GoogleCloudMlV1_StudyConfig_ParameterSpec
descriptionRepresents a single parameter to optimize.
idGoogleCloudMlV1_StudyConfig_ParameterSpec
properties
categoricalValueSpec
$refGoogleCloudMlV1_StudyConfigParameterSpec_CategoricalValueSpec
descriptionThe value spec for a 'CATEGORICAL' parameter.
childParameterSpecs
descriptionA child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
items
$refGoogleCloudMlV1_StudyConfig_ParameterSpec
typearray
discreteValueSpec
$refGoogleCloudMlV1_StudyConfigParameterSpec_DiscreteValueSpec
descriptionThe value spec for a 'DISCRETE' parameter.
doubleValueSpec
$refGoogleCloudMlV1_StudyConfigParameterSpec_DoubleValueSpec
descriptionThe value spec for a 'DOUBLE' parameter.
integerValueSpec
$refGoogleCloudMlV1_StudyConfigParameterSpec_IntegerValueSpec
descriptionThe value spec for an 'INTEGER' parameter.
parameter
descriptionRequired. The parameter name must be unique amongst all ParameterSpecs.
typestring
parentCategoricalValues
$refGoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentCategoricalValueSpec
parentDiscreteValues
$refGoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentDiscreteValueSpec
parentIntValues
$refGoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentIntValueSpec
scaleType
descriptionHow the parameter should be scaled. Leave unset for categorical parameters.
enum
  • SCALE_TYPE_UNSPECIFIED
  • UNIT_LINEAR_SCALE
  • UNIT_LOG_SCALE
  • UNIT_REVERSE_LOG_SCALE
enumDescriptions
  • By default, no scaling is applied.
  • Scales the feasible space to (0, 1) linearly.
  • Scales the feasible space logarithmically to (0, 1). The entire feasible space must be strictly positive.
  • 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.
typestring
type
descriptionRequired. The type of the parameter.
enum
  • PARAMETER_TYPE_UNSPECIFIED
  • DOUBLE
  • INTEGER
  • CATEGORICAL
  • DISCRETE
enumDescriptions
  • You must specify a valid type. Using this unspecified type will result in an error.
  • Type for real-valued parameters.
  • Type for integral parameters.
  • The parameter is categorical, with a value chosen from the categories field.
  • The parameter is real valued, with a fixed set of feasible points. If `type==DISCRETE`, feasible_points must be provided, and {`min_value`, `max_value`} will be ignored.
typestring
typeobject
GoogleCloudMlV1_Trial_Parameter
descriptionA message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
idGoogleCloudMlV1_Trial_Parameter
properties
floatValue
descriptionMust be set if ParameterType is DOUBLE or DISCRETE.
formatdouble
typenumber
intValue
descriptionMust be set if ParameterType is INTEGER
formatint64
typestring
parameter
descriptionThe name of the parameter.
typestring
stringValue
descriptionMust be set if ParameterTypeis CATEGORICAL
typestring
typeobject
GoogleCloudMlV1__AcceleratorConfig
descriptionRepresents a hardware accelerator request config. Note that the AcceleratorConfig can be used in both Jobs and Versions. Learn more about [accelerators for training](/ml-engine/docs/using-gpus) and [accelerators for online prediction](/ml-engine/docs/machine-types-online-prediction#gpus).
idGoogleCloudMlV1__AcceleratorConfig
properties
count
descriptionThe number of accelerators to attach to each machine running the job.
formatint64
typestring
type
descriptionThe type of accelerator to use.
enum
  • ACCELERATOR_TYPE_UNSPECIFIED
  • NVIDIA_TESLA_K80
  • NVIDIA_TESLA_P100
  • NVIDIA_TESLA_V100
  • NVIDIA_TESLA_P4
  • NVIDIA_TESLA_T4
  • NVIDIA_TESLA_A100
  • TPU_V2
  • TPU_V3
  • TPU_V2_POD
  • TPU_V3_POD
  • TPU_V4_POD
enumDescriptions
  • Unspecified accelerator type. Default to no GPU.
  • Nvidia Tesla K80 GPU.
  • Nvidia Tesla P100 GPU.
  • Nvidia V100 GPU.
  • Nvidia Tesla P4 GPU.
  • Nvidia T4 GPU.
  • Nvidia A100 GPU.
  • TPU v2.
  • TPU v3.
  • TPU v2 POD.
  • TPU v3 POD.
  • TPU v4 POD.
typestring
typeobject
GoogleCloudMlV1__AddTrialMeasurementRequest
descriptionThe request message for the AddTrialMeasurement service method.
idGoogleCloudMlV1__AddTrialMeasurementRequest
properties
measurement
$refGoogleCloudMlV1__Measurement
descriptionRequired. The measurement to be added to a trial.
typeobject
GoogleCloudMlV1__AutoScaling
descriptionOptions for automatically scaling a model.
idGoogleCloudMlV1__AutoScaling
properties
maxNodes
descriptionThe maximum number of nodes to scale this model under load. The actual value will depend on resource quota and availability.
formatint32
typeinteger
metrics
descriptionMetricSpec contains the specifications to use to calculate the desired nodes count.
items
$refGoogleCloudMlV1__MetricSpec
typearray
minNodes
descriptionOptional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least `rate` * `min_nodes` * number of hours since last billing cycle, where `rate` is the cost per node-hour as documented in the [pricing guide](/ml-engine/docs/pricing), even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at least `min_nodes`. You will be charged for the time in which additional nodes are used. If `min_nodes` is not specified and AutoScaling is used with a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction), `min_nodes` defaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. If `min_nodes` is not specified and AutoScaling is used with a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction), `min_nodes` defaults to 1. `min_nodes` must be at least 1 for use with a Compute Engine machine type. You can set `min_nodes` when creating the model version, and you can also update `min_nodes` for an existing version: update_body.json: { 'autoScaling': { 'minNodes': 5 } } HTTP request: PATCH https://ml.googleapis.com/v1/{name=projects/*/models/*/versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json
formatint32
typeinteger
typeobject
GoogleCloudMlV1__AutomatedStoppingConfig
descriptionConfiguration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run.
idGoogleCloudMlV1__AutomatedStoppingConfig
properties
decayCurveStoppingConfig
$refGoogleCloudMlV1_AutomatedStoppingConfig_DecayCurveAutomatedStoppingConfig
medianAutomatedStoppingConfig
$refGoogleCloudMlV1_AutomatedStoppingConfig_MedianAutomatedStoppingConfig
typeobject
GoogleCloudMlV1__BuiltInAlgorithmOutput
descriptionRepresents output related to a built-in algorithm Job.
idGoogleCloudMlV1__BuiltInAlgorithmOutput
properties
framework
descriptionFramework on which the built-in algorithm was trained.
typestring
modelPath
descriptionThe Cloud Storage path to the `model/` directory where the training job saves the trained model. Only set for successful jobs that don't use hyperparameter tuning.
typestring
pythonVersion
descriptionPython version on which the built-in algorithm was trained.
typestring
runtimeVersion
descriptionAI Platform runtime version on which the built-in algorithm was trained.
typestring
typeobject
GoogleCloudMlV1__CancelJobRequest
descriptionRequest message for the CancelJob method.
idGoogleCloudMlV1__CancelJobRequest
properties
typeobject
GoogleCloudMlV1__Capability
idGoogleCloudMlV1__Capability
properties
availableAccelerators
descriptionAvailable accelerators for the capability.
items
enum
  • ACCELERATOR_TYPE_UNSPECIFIED
  • NVIDIA_TESLA_K80
  • NVIDIA_TESLA_P100
  • NVIDIA_TESLA_V100
  • NVIDIA_TESLA_P4
  • NVIDIA_TESLA_T4
  • NVIDIA_TESLA_A100
  • TPU_V2
  • TPU_V3
  • TPU_V2_POD
  • TPU_V3_POD
  • TPU_V4_POD
enumDescriptions
  • Unspecified accelerator type. Default to no GPU.
  • Nvidia Tesla K80 GPU.
  • Nvidia Tesla P100 GPU.
  • Nvidia V100 GPU.
  • Nvidia Tesla P4 GPU.
  • Nvidia T4 GPU.
  • Nvidia A100 GPU.
  • TPU v2.
  • TPU v3.
  • TPU v2 POD.
  • TPU v3 POD.
  • TPU v4 POD.
typestring
typearray
type
enum
  • TYPE_UNSPECIFIED
  • TRAINING
  • BATCH_PREDICTION
  • ONLINE_PREDICTION
enumDescriptions
typestring
typeobject
GoogleCloudMlV1__CheckTrialEarlyStoppingStateMetatdata
descriptionThis message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.
idGoogleCloudMlV1__CheckTrialEarlyStoppingStateMetatdata
properties
createTime
descriptionThe time at which the operation was submitted.
formatgoogle-datetime
typestring
study
descriptionThe name of the study that the trial belongs to.
typestring
trial
descriptionThe trial name.
typestring
typeobject
GoogleCloudMlV1__CheckTrialEarlyStoppingStateRequest
descriptionThe request message for the CheckTrialEarlyStoppingState service method.
idGoogleCloudMlV1__CheckTrialEarlyStoppingStateRequest
properties
typeobject
GoogleCloudMlV1__CheckTrialEarlyStoppingStateResponse
descriptionThe message will be placed in the response field of a completed google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.
idGoogleCloudMlV1__CheckTrialEarlyStoppingStateResponse
properties
endTime
descriptionThe time at which operation processing completed.
formatgoogle-datetime
typestring
shouldStop
descriptionTrue if the Trial should stop.
typeboolean
startTime
descriptionThe time at which the operation was started.
formatgoogle-datetime
typestring
typeobject
GoogleCloudMlV1__CompleteTrialRequest
descriptionThe request message for the CompleteTrial service method.
idGoogleCloudMlV1__CompleteTrialRequest
properties
finalMeasurement
$refGoogleCloudMlV1__Measurement
descriptionOptional. 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
infeasibleReason
descriptionOptional. A human readable reason why the trial was infeasible. This should only be provided if `trial_infeasible` is true.
typestring
trialInfeasible
descriptionOptional. True if the trial cannot be run with the given Parameter, and final_measurement will be ignored.
typeboolean
typeobject
GoogleCloudMlV1__Config
idGoogleCloudMlV1__Config
properties
tpuServiceAccount
descriptionThe service account Cloud ML uses to run on TPU node.
typestring
typeobject
GoogleCloudMlV1__ContainerPort
descriptionRepresents a network port in a single container. This message is a subset of the [Kubernetes ContainerPort v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#containerport-v1-core).
idGoogleCloudMlV1__ContainerPort
properties
containerPort
descriptionNumber of the port to expose on the container. This must be a valid port number: 0 < PORT_NUMBER < 65536.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__ContainerSpec
descriptionSpecification of a custom container for serving predictions. This message is a subset of the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core).
idGoogleCloudMlV1__ContainerSpec
properties
args
descriptionImmutable. 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 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 `commmand` 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 AI Platform Prediction](/ai-platform/prediction/docs/custom-container-requirements#aip-variables) and environment variables set in the 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: $( VARIABLE_NAME) 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: $$(VARIABLE_NAME) This field corresponds to the `args` field of the [Kubernetes Containers v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core).
items
typestring
typearray
command
descriptionImmutable. 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 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 AI Platform Prediction](/ai-platform/prediction/docs/custom-container-requirements#aip-variables) and environment variables set in the 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: $( VARIABLE_NAME) 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: $$(VARIABLE_NAME) This field corresponds to the `command` field of the [Kubernetes Containers v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core).
items
typestring
typearray
env
descriptionImmutable. 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 and 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.18/#container-v1-core).
items
$refGoogleCloudMlV1__EnvVar
typearray
image
descriptionURI of the Docker image to be used as the custom container for serving predictions. This URI must identify [an image in Artifact Registry](/artifact-registry/docs/overview) and begin with the hostname `{REGION}-docker.pkg.dev`, where `{REGION}` is replaced by the region that matches AI Platform Prediction [regional endpoint](/ai-platform/prediction/docs/regional-endpoints) that you are using. For example, if you are using the `us-central1-ml.googleapis.com` endpoint, then this URI must begin with `us-central1-docker.pkg.dev`. To use a custom container, the [AI Platform Google-managed service account](/ai-platform/prediction/docs/custom-service-account#default) must have permission to pull (read) the Docker image at this URI. The AI Platform Google-managed service account has the following format: `service-{PROJECT_NUMBER}@cloud-ml.google.com.iam.gserviceaccount.com` {PROJECT_NUMBER} is replaced by your Google Cloud project number. By default, this service account has necessary permissions to pull an Artifact Registry image in the same Google Cloud project where you are using AI Platform Prediction. In this case, no configuration is necessary. If you want to use an image from a different Google Cloud project, learn how to [grant the Artifact Registry Reader (roles/artifactregistry.reader) role for a repository](/artifact-registry/docs/access-control#grant-repo) to your projet's AI Platform Google-managed service account. To learn about the requirements for the Docker image itself, read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements).
typestring
ports
descriptionImmutable. List of ports to expose from the container. AI Platform Prediction sends any prediction requests that it receives to the first port on this list. AI Platform Prediction also sends [liveness and health checks](/ai-platform/prediction/docs/custom-container-requirements#health) to this port. If you do not specify this field, it defaults to following value: ```json [ { "containerPort": 8080 } ] ``` AI Platform Prediction 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.18/#container-v1-core).
items
$refGoogleCloudMlV1__ContainerPort
typearray
typeobject
GoogleCloudMlV1__DiskConfig
descriptionRepresents the config of disk options.
idGoogleCloudMlV1__DiskConfig
properties
bootDiskSizeGb
descriptionSize in GB of the boot disk (default is 100GB).
formatint32
typeinteger
bootDiskType
descriptionType 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).
typestring
typeobject
GoogleCloudMlV1__EncryptionConfig
descriptionRepresents a custom encryption key configuration that can be applied to a resource.
idGoogleCloudMlV1__EncryptionConfig
properties
kmsKeyName
descriptionThe Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a training job. It has the following format: `projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}`
typestring
typeobject
GoogleCloudMlV1__EnvVar
descriptionRepresents an environment variable to be made available in a container. This message is a subset of the [Kubernetes EnvVar v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#envvar-v1-core).
idGoogleCloudMlV1__EnvVar
properties
name
descriptionName of the environment variable. Must be a [valid C identifier](https://github.com/kubernetes/kubernetes/blob/v1.18.8/staging/src/k8s.io/apimachinery/pkg/util/validation/validation.go#L258) and must not begin with the prefix `AIP_`.
typestring
value
descriptionValue of the environment variable. Defaults to an empty string. In this field, you can reference [environment variables set by AI Platform Prediction](/ai-platform/prediction/docs/custom-container-requirements#aip-variables) and environment variables set earlier in the same env field as where this message occurs. 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: $(VARIABLE_NAME) 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: $$(VARIABLE_NAME)
typestring
typeobject
GoogleCloudMlV1__ExplainRequest
descriptionRequest for explanations to be issued against a trained model.
idGoogleCloudMlV1__ExplainRequest
properties
httpBody
$refGoogleApi__HttpBody
descriptionRequired. The explanation request body.
typeobject
GoogleCloudMlV1__ExplanationConfig
descriptionMessage holding configuration options for explaining model predictions. There are three feature attribution methods supported for TensorFlow models: integrated gradients, sampled Shapley, and XRAI. [Learn more about feature attributions.](/ai-platform/prediction/docs/ai-explanations/overview)
idGoogleCloudMlV1__ExplanationConfig
properties
integratedGradientsAttribution
$refGoogleCloudMlV1__IntegratedGradientsAttribution
descriptionAttributes credit by computing 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
sampledShapleyAttribution
$refGoogleCloudMlV1__SampledShapleyAttribution
descriptionAn 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.
xraiAttribution
$refGoogleCloudMlV1__XraiAttribution
descriptionAttributes credit by computing the XRAI taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Currently only implemented for models with natural image inputs.
typeobject
GoogleCloudMlV1__GetConfigResponse
descriptionReturns service account information associated with a project.
idGoogleCloudMlV1__GetConfigResponse
properties
config
$refGoogleCloudMlV1__Config
serviceAccount
descriptionThe service account Cloud ML uses to access resources in the project.
typestring
serviceAccountProject
descriptionThe project number for `service_account`.
formatint64
typestring
typeobject
GoogleCloudMlV1__HyperparameterOutput
descriptionRepresents the result of a single hyperparameter tuning trial from a training job. The TrainingOutput object that is returned on successful completion of a training job with hyperparameter tuning includes a list of HyperparameterOutput objects, one for each successful trial.
idGoogleCloudMlV1__HyperparameterOutput
properties
allMetrics
descriptionAll recorded object metrics for this trial. This field is not currently populated.
items
$refGoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric
typearray
builtInAlgorithmOutput
$refGoogleCloudMlV1__BuiltInAlgorithmOutput
descriptionDetails related to built-in algorithms jobs. Only set for trials of built-in algorithms jobs that have succeeded.
endTime
descriptionOutput only. End time for the trial.
formatgoogle-datetime
typestring
finalMetric
$refGoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric
descriptionThe final objective metric seen for this trial.
hyperparameters
additionalProperties
typestring
descriptionThe hyperparameters given to this trial.
typeobject
isTrialStoppedEarly
descriptionTrue if the trial is stopped early.
typeboolean
startTime
descriptionOutput only. Start time for the trial.
formatgoogle-datetime
typestring
state
descriptionOutput only. The detailed state of the trial.
enum
  • STATE_UNSPECIFIED
  • QUEUED
  • PREPARING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLING
  • CANCELLED
enumDescriptions
  • The job state is unspecified.
  • The job has been just created and processing has not yet begun.
  • The service is preparing to run the job.
  • The job is in progress.
  • The job completed successfully.
  • The job failed. `error_message` should contain the details of the failure.
  • The job is being cancelled. `error_message` should describe the reason for the cancellation.
  • The job has been cancelled. `error_message` should describe the reason for the cancellation.
typestring
trialId
descriptionThe trial id for these results.
typestring
webAccessUris
additionalProperties
typestring
descriptionURIs for accessing [interactive shells](https://cloud.google.com/ai-platform/training/docs/monitor-debug-interactive-shell) (one URI for each training node). Only available if this trial is part of a hyperparameter tuning job and the job's training_input.enable_web_access is `true`. The keys are names of each node in the training job; for example, `master-replica-0` for the master node, `worker-replica-0` for the first worker, and `ps-replica-0` for the first parameter server. The values are the URIs for each node's interactive shell.
typeobject
typeobject
GoogleCloudMlV1__HyperparameterSpec
descriptionRepresents a set of hyperparameters to optimize.
idGoogleCloudMlV1__HyperparameterSpec
properties
algorithm
descriptionOptional. The search algorithm specified for the hyperparameter tuning job. Uses the default AI Platform hyperparameter tuning algorithm if unspecified.
enum
  • ALGORITHM_UNSPECIFIED
  • GRID_SEARCH
  • RANDOM_SEARCH
enumDescriptions
  • The default algorithm used by the hyperparameter tuning service. This is a Bayesian optimization algorithm.
  • Simple grid search within the feasible space. To use grid search, all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`.
  • Simple random search within the feasible space.
typestring
enableTrialEarlyStopping
descriptionOptional. Indicates if the hyperparameter tuning job enables auto trial early stopping.
typeboolean
goal
descriptionRequired. The type of goal to use for tuning. Available types are `MAXIMIZE` and `MINIMIZE`. Defaults to `MAXIMIZE`.
enum
  • GOAL_TYPE_UNSPECIFIED
  • MAXIMIZE
  • MINIMIZE
enumDescriptions
  • Goal Type will default to maximize.
  • Maximize the goal metric.
  • Minimize the goal metric.
typestring
hyperparameterMetricTag
descriptionOptional. The TensorFlow summary tag name to use for optimizing trials. For current versions of TensorFlow, this tag name should exactly match what is shown in TensorBoard, including all scopes. For versions of TensorFlow prior to 0.12, this should be only the tag passed to tf.Summary. By default, "training/hptuning/metric" will be used.
typestring
maxFailedTrials
descriptionOptional. The number of failed trials that need to be seen before failing the hyperparameter tuning job. You can specify this field to override the default failing criteria for AI Platform hyperparameter tuning jobs. Defaults to zero, which means the service decides when a hyperparameter job should fail.
formatint32
typeinteger
maxParallelTrials
descriptionOptional. The number of training trials to run concurrently. You can reduce the time it takes to perform hyperparameter tuning by adding trials in parallel. However, each trail only benefits from the information gained in completed trials. That means that a trial does not get access to the results of trials running at the same time, which could reduce the quality of the overall optimization. Each trial will use the same scale tier and machine types. Defaults to one.
formatint32
typeinteger
maxTrials
descriptionOptional. How many training trials should be attempted to optimize the specified hyperparameters. Defaults to one.
formatint32
typeinteger
params
descriptionRequired. The set of parameters to tune.
items
$refGoogleCloudMlV1__ParameterSpec
typearray
resumePreviousJobId
descriptionOptional. The prior hyperparameter tuning job id that users hope to continue with. The job id will be used to find the corresponding vizier study guid and resume the study.
typestring
typeobject
GoogleCloudMlV1__IntegratedGradientsAttribution
descriptionAttributes credit by computing 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
idGoogleCloudMlV1__IntegratedGradientsAttribution
properties
numIntegralSteps
descriptionNumber 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.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__Job
descriptionRepresents a training or prediction job.
idGoogleCloudMlV1__Job
properties
createTime
descriptionOutput only. When the job was created.
formatgoogle-datetime
typestring
endTime
descriptionOutput only. When the job processing was completed.
formatgoogle-datetime
typestring
errorMessage
descriptionOutput only. The details of a failure or a cancellation.
typestring
etag
description`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform job updates in order to avoid race conditions: An `etag` is returned in the response to `GetJob`, and systems are expected to put that etag in the request to `UpdateJob` to ensure that their change will be applied to the same version of the job.
formatbyte
typestring
jobId
descriptionRequired. The user-specified id of the job.
typestring
jobPosition
descriptionOutput only. It's only effect when the job is in QUEUED state. If it's positive, it indicates the job's position in the job scheduler. It's 0 when the job is already scheduled.
formatint64
readOnlyTrue
typestring
labels
additionalProperties
typestring
descriptionOptional. One or more labels that you can add, to organize your jobs. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels.
typeobject
predictionInput
$refGoogleCloudMlV1__PredictionInput
descriptionInput parameters to create a prediction job.
predictionOutput
$refGoogleCloudMlV1__PredictionOutput
descriptionThe current prediction job result.
startTime
descriptionOutput only. When the job processing was started.
formatgoogle-datetime
typestring
state
descriptionOutput only. The detailed state of a job.
enum
  • STATE_UNSPECIFIED
  • QUEUED
  • PREPARING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLING
  • CANCELLED
enumDescriptions
  • The job state is unspecified.
  • The job has been just created and processing has not yet begun.
  • The service is preparing to run the job.
  • The job is in progress.
  • The job completed successfully.
  • The job failed. `error_message` should contain the details of the failure.
  • The job is being cancelled. `error_message` should describe the reason for the cancellation.
  • The job has been cancelled. `error_message` should describe the reason for the cancellation.
typestring
trainingInput
$refGoogleCloudMlV1__TrainingInput
descriptionInput parameters to create a training job.
trainingOutput
$refGoogleCloudMlV1__TrainingOutput
descriptionThe current training job result.
typeobject
GoogleCloudMlV1__ListJobsResponse
descriptionResponse message for the ListJobs method.
idGoogleCloudMlV1__ListJobsResponse
properties
jobs
descriptionThe list of jobs.
items
$refGoogleCloudMlV1__Job
typearray
nextPageToken
descriptionOptional. Pass this token as the `page_token` field of the request for a subsequent call.
typestring
typeobject
GoogleCloudMlV1__ListLocationsResponse
idGoogleCloudMlV1__ListLocationsResponse
properties
locations
descriptionLocations where at least one type of CMLE capability is available.
items
$refGoogleCloudMlV1__Location
typearray
nextPageToken
descriptionOptional. Pass this token as the `page_token` field of the request for a subsequent call.
typestring
typeobject
GoogleCloudMlV1__ListModelsResponse
descriptionResponse message for the ListModels method.
idGoogleCloudMlV1__ListModelsResponse
properties
models
descriptionThe list of models.
items
$refGoogleCloudMlV1__Model
typearray
nextPageToken
descriptionOptional. Pass this token as the `page_token` field of the request for a subsequent call.
typestring
typeobject
GoogleCloudMlV1__ListOptimalTrialsRequest
descriptionThe request message for the ListTrials service method.
idGoogleCloudMlV1__ListOptimalTrialsRequest
properties
typeobject
GoogleCloudMlV1__ListOptimalTrialsResponse
descriptionThe response message for the ListOptimalTrials method.
idGoogleCloudMlV1__ListOptimalTrialsResponse
properties
trials
descriptionThe 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
items
$refGoogleCloudMlV1__Trial
typearray
typeobject
GoogleCloudMlV1__ListStudiesResponse
idGoogleCloudMlV1__ListStudiesResponse
properties
studies
descriptionThe studies associated with the project.
items
$refGoogleCloudMlV1__Study
typearray
typeobject
GoogleCloudMlV1__ListTrialsResponse
descriptionThe response message for the ListTrials method.
idGoogleCloudMlV1__ListTrialsResponse
properties
trials
descriptionThe trials associated with the study.
items
$refGoogleCloudMlV1__Trial
typearray
typeobject
GoogleCloudMlV1__ListVersionsResponse
descriptionResponse message for the ListVersions method.
idGoogleCloudMlV1__ListVersionsResponse
properties
nextPageToken
descriptionOptional. Pass this token as the `page_token` field of the request for a subsequent call.
typestring
versions
descriptionThe list of versions.
items
$refGoogleCloudMlV1__Version
typearray
typeobject
GoogleCloudMlV1__Location
idGoogleCloudMlV1__Location
properties
capabilities
descriptionCapabilities available in the location.
items
$refGoogleCloudMlV1__Capability
typearray
name
typestring
typeobject
GoogleCloudMlV1__ManualScaling
descriptionOptions for manually scaling a model.
idGoogleCloudMlV1__ManualScaling
properties
nodes
descriptionThe number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed, so the cost of operating this model will be proportional to `nodes` * number of hours since last billing cycle plus the cost for each prediction performed.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__Measurement
descriptionA message representing a measurement.
idGoogleCloudMlV1__Measurement
properties
elapsedTime
descriptionOutput only. Time that the trial has been running at the point of this measurement.
formatgoogle-duration
typestring
metrics
descriptionProvides a list of metrics that act as inputs into the objective function.
items
$refGoogleCloudMlV1_Measurement_Metric
typearray
stepCount
descriptionThe number of steps a machine learning model has been trained for. Must be non-negative.
formatint64
typestring
typeobject
GoogleCloudMlV1__MetricSpec
descriptionMetricSpec contains the specifications to use to calculate the desired nodes count when autoscaling is enabled.
idGoogleCloudMlV1__MetricSpec
properties
name
descriptionmetric name.
enum
  • METRIC_NAME_UNSPECIFIED
  • CPU_USAGE
  • GPU_DUTY_CYCLE
enumDescriptions
  • Unspecified MetricName.
  • CPU usage.
  • GPU duty cycle.
typestring
target
descriptionTarget specifies the target value for the given metric; once real metric deviates from the threshold by a certain percentage, the node count changes.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__Model
descriptionRepresents a machine learning solution. A model can have multiple versions, each of which is a deployed, trained model ready to receive prediction requests. The model itself is just a container.
idGoogleCloudMlV1__Model
properties
defaultVersion
$refGoogleCloudMlV1__Version
descriptionOutput only. The default version of the model. This version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.models.versions.setDefault.
description
descriptionOptional. The description specified for the model when it was created.
typestring
etag
description`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetModel`, and systems are expected to put that etag in the request to `UpdateModel` to ensure that their change will be applied to the model as intended.
formatbyte
typestring
labels
additionalProperties
typestring
descriptionOptional. One or more labels that you can add, to organize your models. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models.
typeobject
name
descriptionRequired. The name specified for the model when it was created. The model name must be unique within the project it is created in.
typestring
onlinePredictionConsoleLogging
descriptionOptional. If true, online prediction nodes send `stderr` and `stdout` streams to Cloud Logging. These can be more verbose than the standard access logs (see `onlinePredictionLogging`) and can incur higher cost. However, they are helpful for debugging. Note that [logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high QPS. Estimate your costs before enabling this option. Default is false.
typeboolean
onlinePredictionLogging
descriptionOptional. 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 request. Note that [logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. Default is false.
typeboolean
regions
descriptionOptional. The list of regions where the model is going to be deployed. Only one region per model is supported. Defaults to 'us-central1' if nothing is set. See the available regions for AI Platform services. Note: * No matter where a model is deployed, it can always be accessed by users from anywhere, both for online and batch prediction. * The region for a batch prediction job is set by the region field when submitting the batch prediction job and does not take its value from this field.
items
typestring
typearray
typeobject
GoogleCloudMlV1__OperationMetadata
descriptionRepresents the metadata of the long-running operation.
idGoogleCloudMlV1__OperationMetadata
properties
createTime
descriptionThe time the operation was submitted.
formatgoogle-datetime
typestring
endTime
descriptionThe time operation processing completed.
formatgoogle-datetime
typestring
isCancellationRequested
descriptionIndicates whether a request to cancel this operation has been made.
typeboolean
labels
additionalProperties
typestring
descriptionThe user labels, inherited from the model or the model version being operated on.
typeobject
modelName
descriptionContains the name of the model associated with the operation.
typestring
operationType
descriptionThe operation type.
enum
  • OPERATION_TYPE_UNSPECIFIED
  • CREATE_VERSION
  • DELETE_VERSION
  • DELETE_MODEL
  • UPDATE_MODEL
  • UPDATE_VERSION
  • UPDATE_CONFIG
enumDescriptions
  • Unspecified operation type.
  • An operation to create a new version.
  • An operation to delete an existing version.
  • An operation to delete an existing model.
  • An operation to update an existing model.
  • An operation to update an existing version.
  • An operation to update project configuration.
typestring
projectNumber
descriptionContains the project number associated with the operation.
formatint64
typestring
startTime
descriptionThe time operation processing started.
formatgoogle-datetime
typestring
version
$refGoogleCloudMlV1__Version
descriptionContains the version associated with the operation.
typeobject
GoogleCloudMlV1__ParameterSpec
descriptionRepresents a single hyperparameter to optimize.
idGoogleCloudMlV1__ParameterSpec
properties
categoricalValues
descriptionRequired if type is `CATEGORICAL`. The list of possible categories.
items
typestring
typearray
discreteValues
descriptionRequired if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. 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.
items
formatdouble
typenumber
typearray
maxValue
descriptionRequired if type is `DOUBLE` or `INTEGER`. This field should be unset if type is `CATEGORICAL`. This value should be integers if type is `INTEGER`.
formatdouble
typenumber
minValue
descriptionRequired if type is `DOUBLE` or `INTEGER`. This field should be unset if type is `CATEGORICAL`. This value should be integers if type is INTEGER.
formatdouble
typenumber
parameterName
descriptionRequired. The parameter name must be unique amongst all ParameterConfigs in a HyperparameterSpec message. E.g., "learning_rate".
typestring
scaleType
descriptionOptional. How the parameter should be scaled to the hypercube. Leave unset for categorical parameters. Some kind of scaling is strongly recommended for real or integral parameters (e.g., `UNIT_LINEAR_SCALE`).
enum
  • NONE
  • UNIT_LINEAR_SCALE
  • UNIT_LOG_SCALE
  • UNIT_REVERSE_LOG_SCALE
enumDescriptions
  • By default, no scaling is applied.
  • Scales the feasible space to (0, 1) linearly.
  • Scales the feasible space logarithmically to (0, 1). The entire feasible space must be strictly positive.
  • 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.
typestring
type
descriptionRequired. The type of the parameter.
enum
  • PARAMETER_TYPE_UNSPECIFIED
  • DOUBLE
  • INTEGER
  • CATEGORICAL
  • DISCRETE
enumDescriptions
  • You must specify a valid type. Using this unspecified type will result in an error.
  • Type for real-valued parameters.
  • Type for integral parameters.
  • The parameter is categorical, with a value chosen from the categories field.
  • The parameter is real valued, with a fixed set of feasible points. If `type==DISCRETE`, feasible_points must be provided, and {`min_value`, `max_value`} will be ignored.
typestring
typeobject
GoogleCloudMlV1__PredictRequest
descriptionRequest for predictions to be issued against a trained model.
idGoogleCloudMlV1__PredictRequest
properties
httpBody
$refGoogleApi__HttpBody
description Required. The prediction request body. Refer to the [request body details section](#request-body-details) for more information on how to structure your request.
typeobject
GoogleCloudMlV1__PredictionInput
descriptionRepresents input parameters for a prediction job.
idGoogleCloudMlV1__PredictionInput
properties
batchSize
descriptionOptional. Number of records per batch, defaults to 64. The service will buffer batch_size number of records in memory before invoking one Tensorflow prediction call internally. So take the record size and memory available into consideration when setting this parameter.
formatint64
typestring
dataFormat
descriptionRequired. The format of the input data files.
enum
  • DATA_FORMAT_UNSPECIFIED
  • JSON
  • TEXT
  • TF_RECORD
  • TF_RECORD_GZIP
  • CSV
enumDescriptions
  • Unspecified format.
  • Each line of the file is a JSON dictionary representing one record.
  • Deprecated. Use JSON instead.
  • The source file is a TFRecord file. Currently available only for input data.
  • The source file is a GZIP-compressed TFRecord file. Currently available only for input data.
  • Values are comma-separated rows, with keys in a separate file. Currently available only for output data.
typestring
inputPaths
descriptionRequired. The Cloud Storage location of the input data files. May contain wildcards.
items
typestring
typearray
maxWorkerCount
descriptionOptional. The maximum number of workers to be used for parallel processing. Defaults to 10 if not specified.
formatint64
typestring
modelName
descriptionUse this field if you want to use the default version for the specified model. The string must use the following format: `"projects/YOUR_PROJECT/models/YOUR_MODEL"`
typestring
outputDataFormat
descriptionOptional. Format of the output data files, defaults to JSON.
enum
  • DATA_FORMAT_UNSPECIFIED
  • JSON
  • TEXT
  • TF_RECORD
  • TF_RECORD_GZIP
  • CSV
enumDescriptions
  • Unspecified format.
  • Each line of the file is a JSON dictionary representing one record.
  • Deprecated. Use JSON instead.
  • The source file is a TFRecord file. Currently available only for input data.
  • The source file is a GZIP-compressed TFRecord file. Currently available only for input data.
  • Values are comma-separated rows, with keys in a separate file. Currently available only for output data.
typestring
outputPath
descriptionRequired. The output Google Cloud Storage location.
typestring
region
descriptionRequired. The Google Compute Engine region to run the prediction job in. See the available regions for AI Platform services.
typestring
runtimeVersion
descriptionOptional. The AI Platform runtime version to use for this batch prediction. If not set, AI Platform will pick the runtime version used during the CreateVersion request for this model version, or choose the latest stable version when model version information is not available such as when the model is specified by uri.
typestring
signatureName
descriptionOptional. The name of the signature defined in the SavedModel to use for this job. Please refer to [SavedModel](https://tensorflow.github.io/serving/serving_basic.html) for information about how to use signatures. Defaults to [DEFAULT_SERVING_SIGNATURE_DEF_KEY](https://www.tensorflow.org/api_docs/python/tf/saved_model/signature_constants) , which is "serving_default".
typestring
uri
descriptionUse this field if you want to specify a Google Cloud Storage path for the model to use.
typestring
versionName
descriptionUse this field if you want to specify a version of the model to use. The string is formatted the same way as `model_version`, with the addition of the version information: `"projects/YOUR_PROJECT/models/YOUR_MODEL/versions/YOUR_VERSION"`
typestring
typeobject
GoogleCloudMlV1__PredictionOutput
descriptionRepresents results of a prediction job.
idGoogleCloudMlV1__PredictionOutput
properties
errorCount
descriptionThe number of data instances which resulted in errors.
formatint64
typestring
nodeHours
descriptionNode hours used by the batch prediction job.
formatdouble
typenumber
outputPath
descriptionThe output Google Cloud Storage location provided at the job creation time.
typestring
predictionCount
descriptionThe number of generated predictions.
formatint64
typestring
typeobject
GoogleCloudMlV1__ReplicaConfig
descriptionRepresents the configuration for a replica in a cluster.
idGoogleCloudMlV1__ReplicaConfig
properties
acceleratorConfig
$refGoogleCloudMlV1__AcceleratorConfig
descriptionRepresents the type and number of accelerators used by the replica. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu)
containerArgs
descriptionArguments to the entrypoint command. The following rules apply for container_command and container_args: - If you do not supply command or args: The defaults defined in the Docker image are used. - If you supply a command but no args: The default EntryPoint and the default Cmd defined in the Docker image are ignored. Your command is run without any arguments. - If you supply only args: The default Entrypoint defined in the Docker image is run with the args that you supplied. - If you supply a command and args: The default Entrypoint and the default Cmd defined in the Docker image are ignored. Your command is run with your args. It cannot be set if custom container image is not provided. Note that this field and [TrainingInput.args] are mutually exclusive, i.e., both cannot be set at the same time.
items
typestring
typearray
containerCommand
descriptionThe command with which the replica's custom container is run. If provided, it will override default ENTRYPOINT of the docker image. If not provided, the docker image's ENTRYPOINT is used. It cannot be set if custom container image is not provided. Note that this field and [TrainingInput.args] are mutually exclusive, i.e., both cannot be set at the same time.
items
typestring
typearray
diskConfig
$refGoogleCloudMlV1__DiskConfig
descriptionRepresents the configuration of disk options.
imageUri
descriptionThe Docker image to run on the replica. This image must be in Container Registry. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers).
typestring
tpuTfVersion
descriptionThe AI Platform runtime version that includes a TensorFlow version matching the one used in the custom container. This field is required if the replica is a TPU worker that uses a custom container. Otherwise, do not specify this field. This must be a [runtime version that currently supports training with TPUs](/ml-engine/docs/tensorflow/runtime-version-list#tpu-support). Note that the version of TensorFlow included in a runtime version may differ from the numbering of the runtime version itself, because it may have a different [patch version](https://www.tensorflow.org/guide/version_compat#semantic_versioning_20). In this field, you must specify the runtime version (TensorFlow minor version). For example, if your custom container runs TensorFlow `1.x.y`, specify `1.x`.
typestring
typeobject
GoogleCloudMlV1__RequestLoggingConfig
descriptionConfiguration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs.
idGoogleCloudMlV1__RequestLoggingConfig
properties
bigqueryTableName
descriptionRequired. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE
typestring
samplingPercentage
descriptionPercentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0.
formatdouble
typenumber
typeobject
GoogleCloudMlV1__RouteMap
descriptionSpecifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements.
idGoogleCloudMlV1__RouteMap
properties
health
descriptionHTTP path on the container to send health checkss to. AI Platform Prediction 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](/ai-platform/prediction/docs/custom-container-requirements#checks). For example, if you set this field to `/bar`, then AI Platform Prediction intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/ MODEL/versions/VERSION The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID /models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
typestring
predict
descriptionHTTP path on the container to send prediction requests to. AI Platform Prediction forwards requests sent using projects.predict to this path on the container's IP address and port. AI Platform Prediction then returns the container's response in the API response. For example, if you set this field to `/foo`, then when AI Platform Prediction 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 Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/MODEL/versions/VERSION:predict The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID/models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
typestring
typeobject
GoogleCloudMlV1__SampledShapleyAttribution
descriptionAn 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.
idGoogleCloudMlV1__SampledShapleyAttribution
properties
numPaths
descriptionThe number of feature permutations to consider when approximating the Shapley values.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__Scheduling
descriptionAll parameters related to scheduling of training jobs.
idGoogleCloudMlV1__Scheduling
properties
maxRunningTime
descriptionOptional. The maximum job running time, expressed in seconds. The field can contain up to nine fractional digits, terminated by `s`. If not specified, this field defaults to `604800s` (seven days). If the training job is still running after this duration, AI Platform Training cancels it. The duration is measured from when the job enters the `RUNNING` state; therefore it does not overlap with the duration limited by Scheduling.max_wait_time. For example, if you want to ensure your job runs for no more than 2 hours, set this field to `7200s` (2 hours * 60 minutes / hour * 60 seconds / minute). If you submit your training job using the `gcloud` tool, you can [specify this field in a `config.yaml` file](/ai-platform/training/docs/training-jobs#formatting_your_configuration_parameters). For example: ```yaml trainingInput: scheduling: maxRunningTime: 7200s ```
formatgoogle-duration
typestring
maxWaitTime
descriptionOptional. The maximum job wait time, expressed in seconds. The field can contain up to nine fractional digits, terminated by `s`. If not specified, there is no limit to the wait time. The minimum for this field is `1800s` (30 minutes). If the training job has not entered the `RUNNING` state after this duration, AI Platform Training cancels it. After the job begins running, it can no longer be cancelled due to the maximum wait time. Therefore the duration limited by this field does not overlap with the duration limited by Scheduling.max_running_time. For example, if the job temporarily stops running and retries due to a [VM restart](/ai-platform/training/docs/overview#restarts), this cannot lead to a maximum wait time cancellation. However, independently of this constraint, AI Platform Training might stop a job if there are too many retries due to exhausted resources in a region. The following example describes how you might use this field: To cancel your job if it doesn't start running within 1 hour, set this field to `3600s` (1 hour * 60 minutes / hour * 60 seconds / minute). If the job is still in the `QUEUED` or `PREPARING` state after an hour of waiting, AI Platform Training cancels the job. If you submit your training job using the `gcloud` tool, you can [specify this field in a `config.yaml` file](/ai-platform/training/docs/training-jobs#formatting_your_configuration_parameters). For example: ```yaml trainingInput: scheduling: maxWaitTime: 3600s ```
formatgoogle-duration
typestring
priority
descriptionOptional. Job scheduling will be based on this priority, which in the range [0, 1000]. The bigger the number, the higher the priority. Default to 0 if not set. If there are multiple jobs requesting same type of accelerators, the high priority job will be scheduled prior to ones with low priority.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__SetDefaultVersionRequest
descriptionRequest message for the SetDefaultVersion request.
idGoogleCloudMlV1__SetDefaultVersionRequest
properties
typeobject
GoogleCloudMlV1__StopTrialRequest
idGoogleCloudMlV1__StopTrialRequest
properties
typeobject
GoogleCloudMlV1__Study
descriptionA message representing a Study.
idGoogleCloudMlV1__Study
properties
createTime
descriptionOutput only. Time at which the study was created.
formatgoogle-datetime
readOnlyTrue
typestring
inactiveReason
descriptionOutput only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
readOnlyTrue
typestring
name
descriptionOutput only. The name of a study.
readOnlyTrue
typestring
state
descriptionOutput only. The detailed state of a study.
enum
  • STATE_UNSPECIFIED
  • ACTIVE
  • INACTIVE
  • COMPLETED
enumDescriptions
  • The study state is unspecified.
  • The study is active.
  • The study is stopped due to an internal error.
  • The study is done when the service exhausts the parameter search space or max_trial_count is reached.
readOnlyTrue
typestring
studyConfig
$refGoogleCloudMlV1__StudyConfig
descriptionRequired. Configuration of the study.
typeobject
GoogleCloudMlV1__StudyConfig
descriptionRepresents configuration of a study.
idGoogleCloudMlV1__StudyConfig
properties
algorithm
descriptionThe search algorithm specified for the study.
enum
  • ALGORITHM_UNSPECIFIED
  • GAUSSIAN_PROCESS_BANDIT
  • GRID_SEARCH
  • RANDOM_SEARCH
enumDescriptions
  • The default algorithm used by the Cloud AI Platform Vizier service.
  • Gaussian Process Bandit.
  • Simple grid search within the feasible space. To use grid search, all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`.
  • Simple random search within the feasible space.
typestring
automatedStoppingConfig
$refGoogleCloudMlV1__AutomatedStoppingConfig
descriptionConfiguration for automated stopping of unpromising Trials.
metrics
descriptionMetric specs for the study.
items
$refGoogleCloudMlV1_StudyConfig_MetricSpec
typearray
parameters
descriptionRequired. The set of parameters to tune.
items
$refGoogleCloudMlV1_StudyConfig_ParameterSpec
typearray
typeobject
GoogleCloudMlV1__SuggestTrialsMetadata
descriptionMetadata field of a google.longrunning.Operation associated with a SuggestTrialsRequest.
idGoogleCloudMlV1__SuggestTrialsMetadata
properties
clientId
descriptionThe identifier of the client that is requesting the suggestion.
typestring
createTime
descriptionThe time operation was submitted.
formatgoogle-datetime
typestring
study
descriptionThe name of the study that the trial belongs to.
typestring
suggestionCount
descriptionThe number of suggestions requested.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__SuggestTrialsRequest
descriptionThe request message for the SuggestTrial service method.
idGoogleCloudMlV1__SuggestTrialsRequest
properties
clientId
descriptionRequired. 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.
typestring
suggestionCount
descriptionRequired. The number of suggestions requested.
formatint32
typeinteger
typeobject
GoogleCloudMlV1__SuggestTrialsResponse
descriptionThis message will be placed in the response field of a completed google.longrunning.Operation associated with a SuggestTrials request.
idGoogleCloudMlV1__SuggestTrialsResponse
properties
endTime
descriptionThe time at which operation processing completed.
formatgoogle-datetime
typestring
startTime
descriptionThe time at which the operation was started.
formatgoogle-datetime
typestring
studyState
descriptionThe state of the study.
enum
  • STATE_UNSPECIFIED
  • ACTIVE
  • INACTIVE
  • COMPLETED
enumDescriptions
  • The study state is unspecified.
  • The study is active.
  • The study is stopped due to an internal error.
  • The study is done when the service exhausts the parameter search space or max_trial_count is reached.
typestring
trials
descriptionA list of trials.
items
$refGoogleCloudMlV1__Trial
typearray
typeobject
GoogleCloudMlV1__TrainingInput
descriptionRepresents input parameters for a training job. When using the gcloud command to submit your training job, you can specify the input parameters as command-line arguments and/or in a YAML configuration file referenced from the --config command-line argument. For details, see the guide to [submitting a training job](/ai-platform/training/docs/training-jobs).
idGoogleCloudMlV1__TrainingInput
properties
args
descriptionOptional. Command-line arguments passed to the training application when it starts. If your job uses a custom container, then the arguments are passed to the container's `ENTRYPOINT` command.
items
typestring
typearray
enableWebAccess
descriptionOptional. Whether you want AI Platform Training to enable [interactive shell access](https://cloud.google.com/ai-platform/training/docs/monitor-debug-interactive-shell) to training containers. If set to `true`, you can access interactive shells at the URIs given by TrainingOutput.web_access_uris or HyperparameterOutput.web_access_uris (within TrainingOutput.trials).
typeboolean
encryptionConfig
$refGoogleCloudMlV1__EncryptionConfig
descriptionOptional. Options for using customer-managed encryption keys (CMEK) to protect resources created by a training job, instead of using Google's default encryption. If this is set, then all resources created by the training job will be encrypted with the customer-managed encryption key that you specify. [Learn how and when to use CMEK with AI Platform Training](/ai-platform/training/docs/cmek).
evaluatorConfig
$refGoogleCloudMlV1__ReplicaConfig
descriptionOptional. The configuration for evaluators. You should only set `evaluatorConfig.acceleratorConfig` if `evaluatorType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `evaluatorConfig.imageUri` only if you build a custom image for your evaluator. If `evaluatorConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers).
evaluatorCount
descriptionOptional. The number of evaluator replicas to use for the training job. Each replica in the cluster will be of the type specified in `evaluator_type`. This value can only be used when `scale_tier` is set to `CUSTOM`. If you set this value, you must also set `evaluator_type`. The default value is zero.
formatint64
typestring
evaluatorType
descriptionOptional. Specifies the type of virtual machine to use for your training job's evaluator nodes. The supported values are the same as those described in the entry for `masterType`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be Compute Engine machine types or both must be legacy machine types. This value must be present when `scaleTier` is set to `CUSTOM` and `evaluatorCount` is greater than zero.
typestring
hyperparameters
$refGoogleCloudMlV1__HyperparameterSpec
descriptionOptional. The set of Hyperparameters to tune.
jobDir
descriptionOptional. A Google Cloud Storage path in which to store training outputs and other data needed for training. This path is passed to your TensorFlow program as the '--job-dir' command-line argument. The benefit of specifying this field is that Cloud ML validates the path for use in training.
typestring
masterConfig
$refGoogleCloudMlV1__ReplicaConfig
descriptionOptional. The configuration for your master worker. You should only set `masterConfig.acceleratorConfig` if `masterType` is set to a Compute Engine machine type. Learn about [restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `masterConfig.imageUri` only if you build a custom image. Only one of `masterConfig.imageUri` and `runtimeVersion` should be set. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers).
masterType
descriptionOptional. Specifies the type of virtual machine to use for your training job's master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this field. See the [list of compatible Compute Engine machine types](/ai-platform/training/docs/machine-types#compute-engine-machine-types). Alternatively, you can use the certain legacy machine types in this field. See the [list of legacy machine types](/ai-platform/training/docs/machine-types#legacy-machine-types). Finally, if you want to use a TPU for training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for training with TPUs](/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
typestring
network
descriptionOptional. The full name of the [Compute Engine network](/vpc/docs/vpc) to which the Job is peered. For example, `projects/12345/global/networks/myVPC`. The format of this field is `projects/{project}/global/networks/{network}`, where {project} is a project number (like `12345`) and {network} is network name. Private services access must already be configured for the network. If left unspecified, the Job is not peered with any network. [Learn about using VPC Network Peering.](/ai-platform/training/docs/vpc-peering).
typestring
packageUris
descriptionRequired. The Google Cloud Storage location of the packages with the training program and any additional dependencies. The maximum number of package URIs is 100.
items
typestring
typearray
parameterServerConfig
$refGoogleCloudMlV1__ReplicaConfig
descriptionOptional. The configuration for parameter servers. You should only set `parameterServerConfig.acceleratorConfig` if `parameterServerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `parameterServerConfig.imageUri` only if you build a custom image for your parameter server. If `parameterServerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers).
parameterServerCount
descriptionOptional. The number of parameter server replicas to use for the training job. Each replica in the cluster will be of the type specified in `parameter_server_type`. This value can only be used when `scale_tier` is set to `CUSTOM`. If you set this value, you must also set `parameter_server_type`. The default value is zero.
formatint64
typestring
parameterServerType
descriptionOptional. Specifies the type of virtual machine to use for your training job's parameter server. The supported values are the same as those described in the entry for `master_type`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be Compute Engine machine types or both must be legacy machine types. This value must be present when `scaleTier` is set to `CUSTOM` and `parameter_server_count` is greater than zero.
typestring
pythonModule
descriptionRequired. The Python module name to run after installing the packages.
typestring
pythonVersion
descriptionOptional. The version of Python used in training. You must either specify this field or specify `masterConfig.imageUri`. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list).
typestring
region
descriptionRequired. The region to run the training job in. See the [available regions](/ai-platform/training/docs/regions) for AI Platform Training.
typestring
runtimeVersion
descriptionOptional. The AI Platform runtime version to use for training. You must either specify this field or specify `masterConfig.imageUri`. For more information, see the [runtime version list](/ai-platform/training/docs/runtime-version-list) and learn [how to manage runtime versions](/ai-platform/training/docs/versioning).
typestring
scaleTier
descriptionRequired. Specifies the machine types, the number of replicas for workers and parameter servers.
enum
  • BASIC
  • STANDARD_1
  • PREMIUM_1
  • BASIC_GPU
  • BASIC_TPU
  • CUSTOM
enumDescriptions
  • A single worker instance. This tier is suitable for learning how to use Cloud ML, and for experimenting with new models using small datasets.
  • Many workers and a few parameter servers.
  • A large number of workers with many parameter servers.
  • A single worker instance [with a GPU](/ai-platform/training/docs/using-gpus).
  • A single worker instance with a [Cloud TPU](/ml-engine/docs/tensorflow/using-tpus).
  • The CUSTOM tier is not a set tier, but rather enables you to use your own cluster specification. When you use this tier, set values to configure your processing cluster according to these guidelines: * You _must_ set `TrainingInput.masterType` to specify the type of machine to use for your master node. This is the only required setting. * You _may_ set `TrainingInput.workerCount` to specify the number of workers to use. If you specify one or more workers, you _must_ also set `TrainingInput.workerType` to specify the type of machine to use for your worker nodes. * You _may_ set `TrainingInput.parameterServerCount` to specify the number of parameter servers to use. If you specify one or more parameter servers, you _must_ also set `TrainingInput.parameterServerType` to specify the type of machine to use for your parameter servers. Note that all of your workers must use the same machine type, which can be different from your parameter server type and master type. Your parameter servers must likewise use the same machine type, which can be different from your worker type and master type.
typestring
scheduling
$refGoogleCloudMlV1__Scheduling
descriptionOptional. Scheduling options for a training job.
serviceAccount
descriptionOptional. The email address of a service account to use when running the training appplication. You must have the `iam.serviceAccounts.actAs` permission for the specified service account. In addition, the AI Platform Training Google-managed service account must have the `roles/iam.serviceAccountAdmin` role for the specified service account. [Learn more about configuring a service account.](/ai-platform/training/docs/custom-service-account) If not specified, the AI Platform Training Google-managed service account is used by default.
typestring
useChiefInTfConfig
descriptionOptional. Use `chief` instead of `master` in the `TF_CONFIG` environment variable when training with a custom container. Defaults to `false`. [Learn more about this field.](/ai-platform/training/docs/distributed-training-details#chief-versus-master) This field has no effect for training jobs that don't use a custom container.
typeboolean
workerConfig
$refGoogleCloudMlV1__ReplicaConfig
descriptionOptional. The configuration for workers. You should only set `workerConfig.acceleratorConfig` if `workerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `workerConfig.imageUri` only if you build a custom image for your worker. If `workerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers).
workerCount
descriptionOptional. The number of worker replicas to use for the training job. Each replica in the cluster will be of the type specified in `worker_type`. This value can only be used when `scale_tier` is set to `CUSTOM`. If you set this value, you must also set `worker_type`. The default value is zero.
formatint64
typestring
workerType
descriptionOptional. Specifies the type of virtual machine to use for your training job's worker nodes. The supported values are the same as those described in the entry for `masterType`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be Compute Engine machine types or both must be legacy machine types. If you use `cloud_tpu` for this value, see special instructions for [configuring a custom TPU machine](/ml-engine/docs/tensorflow/using-tpus#configuring_a_custom_tpu_machine). This value must be present when `scaleTier` is set to `CUSTOM` and `workerCount` is greater than zero.
typestring
typeobject
GoogleCloudMlV1__TrainingOutput
descriptionRepresents results of a training job. Output only.
idGoogleCloudMlV1__TrainingOutput
properties
builtInAlgorithmOutput
$refGoogleCloudMlV1__BuiltInAlgorithmOutput
descriptionDetails related to built-in algorithms jobs. Only set for built-in algorithms jobs.
completedTrialCount
descriptionThe number of hyperparameter tuning trials that completed successfully. Only set for hyperparameter tuning jobs.
formatint64
typestring
consumedMLUnits
descriptionThe amount of ML units consumed by the job.
formatdouble
typenumber
hyperparameterMetricTag
descriptionThe TensorFlow summary tag name used for optimizing hyperparameter tuning trials. See [`HyperparameterSpec.hyperparameterMetricTag`](#HyperparameterSpec.FIELDS.hyperparameter_metric_tag) for more information. Only set for hyperparameter tuning jobs.
typestring
isBuiltInAlgorithmJob
descriptionWhether this job is a built-in Algorithm job.
typeboolean
isHyperparameterTuningJob
descriptionWhether this job is a hyperparameter tuning job.
typeboolean
trials
descriptionResults for individual Hyperparameter trials. Only set for hyperparameter tuning jobs.
items
$refGoogleCloudMlV1__HyperparameterOutput
typearray
webAccessUris
additionalProperties
typestring
descriptionOutput only. URIs for accessing [interactive shells](https://cloud.google.com/ai-platform/training/docs/monitor-debug-interactive-shell) (one URI for each training node). Only available if training_input.enable_web_access is `true`. The keys are names of each node in the training job; for example, `master-replica-0` for the master node, `worker-replica-0` for the first worker, and `ps-replica-0` for the first parameter server. The values are the URIs for each node's interactive shell.
readOnlyTrue
typeobject
typeobject
GoogleCloudMlV1__Trial
descriptionA message representing a trial.
idGoogleCloudMlV1__Trial
properties
clientId
descriptionOutput only. The identifier of the client that originally requested this trial.
readOnlyTrue
typestring
endTime
descriptionOutput only. Time at which the trial's status changed to COMPLETED.
formatgoogle-datetime
readOnlyTrue
typestring
finalMeasurement
$refGoogleCloudMlV1__Measurement
descriptionThe final measurement containing the objective value.
infeasibleReason
descriptionOutput only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
readOnlyTrue
typestring
measurements
descriptionA list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
items
$refGoogleCloudMlV1__Measurement
typearray
name
descriptionOutput only. Name of the trial assigned by the service.
readOnlyTrue
typestring
parameters
descriptionThe parameters of the trial.
items
$refGoogleCloudMlV1_Trial_Parameter
typearray
startTime
descriptionOutput only. Time at which the trial was started.
formatgoogle-datetime
readOnlyTrue
typestring
state
descriptionThe detailed state of a trial.
enum
  • STATE_UNSPECIFIED
  • REQUESTED
  • ACTIVE
  • COMPLETED
  • STOPPING
enumDescriptions
  • The trial state is unspecified.
  • Indicates that a specific trial has been requested, but it has not yet been suggested by the service.
  • Indicates that the trial has been suggested.
  • Indicates that the trial is done, and either has a final_measurement set, or is marked as trial_infeasible.
  • Indicates that the trial should stop according to the service.
typestring
trialInfeasible
descriptionOutput only. If true, the parameters in this trial are not attempted again.
readOnlyTrue
typeboolean
typeobject
GoogleCloudMlV1__Version
descriptionRepresents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling projects.models.versions.list.
idGoogleCloudMlV1__Version
properties
acceleratorConfig
$refGoogleCloudMlV1__AcceleratorConfig
descriptionOptional. Accelerator config for using GPUs for online prediction (beta). Only specify this field if you have specified a Compute Engine (N1) machine type in the `machineType` field. Learn more about [using GPUs for online prediction](/ml-engine/docs/machine-types-online-prediction#gpus).
autoScaling
$refGoogleCloudMlV1__AutoScaling
descriptionAutomatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes.
container
$refGoogleCloudMlV1__ContainerSpec
descriptionOptional. Specifies a custom container to use for serving predictions. If you specify this field, then `machineType` is required. If you specify this field, then `deploymentUri` is optional. If you specify this field, then you must not specify `runtimeVersion`, `packageUris`, `framework`, `pythonVersion`, or `predictionClass`.
createTime
descriptionOutput only. The time the version was created.
formatgoogle-datetime
typestring
deploymentUri
descriptionThe Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the [guide to deploying models](/ai-platform/prediction/docs/deploying-models) for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn [how to use this field with a custom container](/ai-platform/prediction/docs/custom-container-requirements#artifacts).
typestring
description
descriptionOptional. The description specified for the version when it was created.
typestring
errorMessage
descriptionOutput only. The details of a failure or a cancellation.
typestring
etag
description`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetVersion`, and systems are expected to put that etag in the request to `UpdateVersion` to ensure that their change will be applied to the model as intended.
formatbyte
typestring
explanationConfig
$refGoogleCloudMlV1__ExplanationConfig
descriptionOptional. Configures explainability features on the model's version. Some explanation features require additional metadata to be loaded as part of the model payload.
framework
descriptionOptional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ai-platform/prediction/docs/custom-prediction-routines) or if you're using a [custom container](/ai-platform/prediction/docs/use-custom-container).
enum
  • FRAMEWORK_UNSPECIFIED
  • TENSORFLOW
  • SCIKIT_LEARN
  • XGBOOST
enumDescriptions
  • Unspecified framework. Assigns a value based on the file suffix.
  • Tensorflow framework.
  • Scikit-learn framework.
  • XGBoost framework.
typestring
isDefault
descriptionOutput only. If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault.
typeboolean
labels
additionalProperties
typestring
descriptionOptional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models.
typeobject
lastMigrationModelId
descriptionOutput only. The [AI Platform (Unified) `Model`](https://cloud.google.com/ai-platform-unified/docs/reference/rest/v1beta1/projects.locations.models) ID for the last [model migration](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform-unified).
readOnlyTrue
typestring
lastMigrationTime
descriptionOutput only. The last time this version was successfully [migrated to AI Platform (Unified)](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform-unified).
formatgoogle-datetime
readOnlyTrue
typestring
lastUseTime
descriptionOutput only. The time the version was last used for prediction.
formatgoogle-datetime
typestring
machineType
descriptionOptional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read [Choosing a machine type for online prediction](/ai-platform/prediction/docs/machine-types-online-prediction). If this field is not specified and you are using a [regional endpoint](/ai-platform/prediction/docs/regional-endpoints), then the machine type defaults to `n1-standard-2`. If this field is not specified and you are using the global endpoint (`ml.googleapis.com`), then the machine type defaults to `mls1-c1-m2`.
typestring
manualScaling
$refGoogleCloudMlV1__ManualScaling
descriptionManually select the number of nodes to use for serving the model. You should generally use `auto_scaling` with an appropriate `min_nodes` instead, but this option is available if you want more predictable billing. Beware that latency and error rates will increase if the traffic exceeds that capability of the system to serve it based on the selected number of nodes.
name
descriptionRequired. The name specified for the version when it was created. The version name must be unique within the model it is created in.
typestring
packageUris
descriptionOptional. Cloud Storage paths (`gs://…`) of packages for [custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines) or [scikit-learn pipelines with custom code](/ml-engine/docs/scikit/exporting-for-prediction#custom-pipeline-code). For a custom prediction routine, one of these packages must contain your Predictor class (see [`predictionClass`](#Version.FIELDS.prediction_class)). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected [runtime version](/ml-engine/docs/tensorflow/runtime-version-list). If you specify this field, you must also set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater.
items
typestring
typearray
predictionClass
descriptionOptional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines).
typestring
pythonVersion
descriptionRequired. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list).
typestring
requestLoggingConfig
$refGoogleCloudMlV1__RequestLoggingConfig
descriptionOptional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version.
routes
$refGoogleCloudMlV1__RouteMap
descriptionOptional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values.
runtimeVersion
descriptionRequired. The AI Platform runtime version to use for this deployment. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning).
typestring
serviceAccount
descriptionOptional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the `containerSpec` or the `predictionClass` field. Learn more about [using a custom service account](/ai-platform/prediction/docs/custom-service-account).
typestring
state
descriptionOutput only. The state of a version.
enum
  • UNKNOWN
  • READY
  • CREATING
  • FAILED
  • DELETING
  • UPDATING
enumDescriptions
  • The version state is unspecified.
  • The version is ready for prediction.
  • The version is being created. New UpdateVersion and DeleteVersion requests will fail if a version is in the CREATING state.
  • The version failed to be created, possibly cancelled. `error_message` should contain the details of the failure.
  • The version is being deleted. New UpdateVersion and DeleteVersion requests will fail if a version is in the DELETING state.
  • The version is being updated. New UpdateVersion and DeleteVersion requests will fail if a version is in the UPDATING state.
typestring
typeobject
GoogleCloudMlV1__XraiAttribution
descriptionAttributes credit by computing the XRAI taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Currently only implemented for models with natural image inputs.
idGoogleCloudMlV1__XraiAttribution
properties
numIntegralSteps
descriptionNumber 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.
formatint32
typeinteger
typeobject
GoogleIamV1__AuditConfig
descriptionSpecifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
idGoogleIamV1__AuditConfig
properties
auditLogConfigs
descriptionThe configuration for logging of each type of permission.
items
$refGoogleIamV1__AuditLogConfig
typearray
service
descriptionSpecifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
typestring
typeobject
GoogleIamV1__AuditLogConfig
descriptionProvides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
idGoogleIamV1__AuditLogConfig
properties
exemptedMembers
descriptionSpecifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
items
typestring
typearray
logType
descriptionThe log type that this config enables.
enum
  • LOG_TYPE_UNSPECIFIED
  • ADMIN_READ
  • DATA_WRITE
  • DATA_READ
enumDescriptions
  • Default case. Should never be this.
  • Admin reads. Example: CloudIAM getIamPolicy
  • Data writes. Example: CloudSQL Users create
  • Data reads. Example: CloudSQL Users list
typestring
typeobject
GoogleIamV1__Binding
descriptionAssociates `members`, or principals, with a `role`.
idGoogleIamV1__Binding
properties
condition
$refGoogleType__Expr
descriptionThe condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
members
descriptionSpecifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
items
typestring
typearray
role
descriptionRole that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
typestring
typeobject
GoogleIamV1__Policy
descriptionAn Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
idGoogleIamV1__Policy
properties
auditConfigs
descriptionSpecifies cloud audit logging configuration for this policy.
items
$refGoogleIamV1__AuditConfig
typearray
bindings
descriptionAssociates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
items
$refGoogleIamV1__Binding
typearray
etag
description`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
formatbyte
typestring
version
descriptionSpecifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
formatint32
typeinteger
typeobject
GoogleIamV1__SetIamPolicyRequest
descriptionRequest message for `SetIamPolicy` method.
idGoogleIamV1__SetIamPolicyRequest
properties
policy
$refGoogleIamV1__Policy
descriptionREQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
updateMask
descriptionOPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
formatgoogle-fieldmask
typestring
typeobject
GoogleIamV1__TestIamPermissionsRequest
descriptionRequest message for `TestIamPermissions` method.
idGoogleIamV1__TestIamPermissionsRequest
properties
permissions
descriptionThe set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
items
typestring
typearray
typeobject
GoogleIamV1__TestIamPermissionsResponse
descriptionResponse message for `TestIamPermissions` method.
idGoogleIamV1__TestIamPermissionsResponse
properties
permissions
descriptionA subset of `TestPermissionsRequest.permissions` that the caller is allowed.
items
typestring
typearray
typeobject
GoogleLongrunning__ListOperationsResponse
descriptionThe response message for Operations.ListOperations.
idGoogleLongrunning__ListOperationsResponse
properties
nextPageToken
descriptionThe standard List next-page token.
typestring
operations
descriptionA list of operations that matches the specified filter in the request.
items
$refGoogleLongrunning__Operation
typearray
typeobject
GoogleLongrunning__Operation
descriptionThis resource represents a long-running operation that is the result of a network API call.
idGoogleLongrunning__Operation
properties
done
descriptionIf the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
typeboolean
error
$refGoogleRpc__Status
descriptionThe error result of the operation in case of failure or cancellation.
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
typeobject
name
descriptionThe server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
typestring
response
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionThe normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
typeobject
typeobject
GoogleProtobuf__Empty
descriptionA generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
idGoogleProtobuf__Empty
properties
typeobject
GoogleRpc__Status
descriptionThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
idGoogleRpc__Status
properties
code
descriptionThe status code, which should be an enum value of google.rpc.Code.
formatint32
typeinteger
details
descriptionA list of messages that carry the error details. There is a common set of message types for APIs to use.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
message
descriptionA developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
typestring
typeobject
GoogleType__Expr
descriptionRepresents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
idGoogleType__Expr
properties
description
descriptionOptional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
typestring
expression
descriptionTextual representation of an expression in Common Expression Language syntax.
typestring
location
descriptionOptional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
typestring
title
descriptionOptional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
typestring
typeobject
root['title']
new_valueAI Platform Training & Prediction Private API
old_valueAI Platform Training & Prediction API
prod/mlkit-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/mlkit-pa-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/mlkit-pa-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/mlkit-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/mlkit-v1beta1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/mobilemlaccelerationcompatibility-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/mobilemlaccelerationcompatibility-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/mobilesdk-pa-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/mobilesdk-pa-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/modelarmor-
values_changed
root['revision']
new_value20250721
old_value20250709
prod/modelarmor-v1
values_changed
root['revision']
new_value20250721
old_value20250709
prod/modelarmor-v1alpha
values_changed
root['revision']
new_value20250721
old_value20250709
prod/modelarmor-v1beta
values_changed
root['revision']
new_value20250721
old_value20250709
prod/myphonenumbers-pa-
values_changed
root['revision']
new_value20250721
old_value20250716
iterable_item_added
root['schemas']['AnonymousFinishVerificationRequest']['properties']['applicationType']['enum'][28]LEAD_FORM_OTP
root['schemas']['AnonymousFinishVerificationRequest']['properties']['applicationType']['enumDescriptions'][28]Lead Form Ads Team Ref bug : b/420598399 Contacts: lead-form-ads@,vshrushti@
root['schemas']['AnonymousStartVerificationRequest']['properties']['applicationType']['enum'][28]LEAD_FORM_OTP
root['schemas']['AnonymousStartVerificationRequest']['properties']['applicationType']['enumDescriptions'][28]Lead Form Ads Team Ref bug : b/420598399 Contacts: lead-form-ads@,vshrushti@
root['schemas']['FinishVerificationRequest']['properties']['applicationType']['enum'][28]LEAD_FORM_OTP
root['schemas']['FinishVerificationRequest']['properties']['applicationType']['enumDescriptions'][28]Lead Form Ads Team Ref bug : b/420598399 Contacts: lead-form-ads@,vshrushti@
root['schemas']['StartVerificationRequest']['properties']['applicationType']['enum'][28]LEAD_FORM_OTP
root['schemas']['StartVerificationRequest']['properties']['applicationType']['enumDescriptions'][28]Lead Form Ads Team Ref bug : b/420598399 Contacts: lead-form-ads@,vshrushti@
prod/myphonenumbers-pa-v1
values_changed
root['revision']
new_value20250721
old_value20250716
iterable_item_added
root['schemas']['AnonymousFinishVerificationRequest']['properties']['applicationType']['enum'][28]LEAD_FORM_OTP
root['schemas']['AnonymousFinishVerificationRequest']['properties']['applicationType']['enumDescriptions'][28]Lead Form Ads Team Ref bug : b/420598399 Contacts: lead-form-ads@,vshrushti@
root['schemas']['AnonymousStartVerificationRequest']['properties']['applicationType']['enum'][28]LEAD_FORM_OTP
root['schemas']['AnonymousStartVerificationRequest']['properties']['applicationType']['enumDescriptions'][28]Lead Form Ads Team Ref bug : b/420598399 Contacts: lead-form-ads@,vshrushti@
root['schemas']['FinishVerificationRequest']['properties']['applicationType']['enum'][28]LEAD_FORM_OTP
root['schemas']['FinishVerificationRequest']['properties']['applicationType']['enumDescriptions'][28]Lead Form Ads Team Ref bug : b/420598399 Contacts: lead-form-ads@,vshrushti@
root['schemas']['StartVerificationRequest']['properties']['applicationType']['enum'][28]LEAD_FORM_OTP
root['schemas']['StartVerificationRequest']['properties']['applicationType']['enumDescriptions'][28]Lead Form Ads Team Ref bug : b/420598399 Contacts: lead-form-ads@,vshrushti@
prod/networkbuildingblocks-pa-
values_changed
root['revision']
new_value20250723
old_value20250718
prod/networkbuildingblocks-pa-v1beta1
values_changed
root['revision']
new_value20250723
old_value20250718
prod/northamerica-northeast1-connectgateway-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/northamerica-northeast1-connectgateway-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/northamerica-northeast1-connectgateway-v1beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/northamerica-northeast1-containerfilesystem-
values_changed
root['revision']
new_value20250719
old_value20250714
prod/northamerica-northeast1-containerfilesystem-v1
values_changed
root['revision']
new_value20250719
old_value20250714
prod/northamerica-northeast2-connectgateway-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/northamerica-northeast2-connectgateway-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/northamerica-northeast2-connectgateway-v1beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/notifications-pa-
values_changed
root['revision']
new_value20250722
old_value20250720
iterable_item_added
root['schemas']['AppsDynamite__ChimeNotificationPayload']['properties']['eventType']['enum'][8]MESSAGE_EDITED_NOTIFICATION
root['schemas']['AppsDynamite__ChimeNotificationPayload']['properties']['eventType']['enumDescriptions'][8]Notification for a message edit.
root['schemas']['WalletNotificationsRegistry_CountryConfig_CountryRule']['properties']['countryType']['enum'][5]THIRD_PARTY_POST_TRANSACTION_NOTIFICATION_COUNTRY
root['schemas']['WalletNotificationsRegistry_CountryConfig_CountryRule']['properties']['countryType']['enumDescriptions'][5]Country type for the 3p buyflow post transaction notification.
prod/notifications-pa-v1
values_changed
root['revision']
new_value20250722
old_value20250720
iterable_item_added
root['schemas']['AppsDynamite__ChimeNotificationPayload']['properties']['eventType']['enum'][8]MESSAGE_EDITED_NOTIFICATION
root['schemas']['AppsDynamite__ChimeNotificationPayload']['properties']['eventType']['enumDescriptions'][8]Notification for a message edit.
root['schemas']['WalletNotificationsRegistry_CountryConfig_CountryRule']['properties']['countryType']['enum'][5]THIRD_PARTY_POST_TRANSACTION_NOTIFICATION_COUNTRY
root['schemas']['WalletNotificationsRegistry_CountryConfig_CountryRule']['properties']['countryType']['enumDescriptions'][5]Country type for the 3p buyflow post transaction notification.
prod/opengallery-
values_changed
root['revision']
new_value20250720
old_value20250714
prod/opengallery-v1
values_changed
root['revision']
new_value20250720
old_value20250714
prod/opengallery-v1beta1
values_changed
root['revision']
new_value20250720
old_value20250714
prod/peoplestack-pa-
values_changed
root['revision']
new_value20250723
old_value20250721
iterable_item_added
root['resources']['autocomplete']['methods']['autocomplete']['parameters']['affinityType']['enum'][323]HERMES_AFFINITY
root['resources']['autocomplete']['methods']['warmup']['parameters']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackAutocompleteRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackBlockPersonRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackCreateGroupRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackDeleteGroupsRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackFlexorgsProtoInternalExternal']['properties']['application']['enum'][465]ATOM
root['schemas']['PeoplestackFlexorgsProtoInternalExternal']['properties']['application']['enumDescriptions'][465]Atom Team contact: atom-eng-team@google.com
root['schemas']['PeoplestackJoinGroupRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackLeaveGroupRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackLookupRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackMutateConnectionLabelRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackReadAllGroupsRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackReadGroupsRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackRecordShareReceivedRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackSmartAddressRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackUpdateGroupRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackWarmupRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['SocialClientsApplicationProto3Wrapper']['properties']['application']['enum'][465]ATOM
root['schemas']['SocialClientsApplicationProto3Wrapper']['properties']['application']['enumDescriptions'][465]Atom Team contact: atom-eng-team@google.com
prod/peoplestack-pa-v1
values_changed
root['revision']
new_value20250723
old_value20250721
iterable_item_added
root['resources']['autocomplete']['methods']['autocomplete']['parameters']['affinityType']['enum'][323]HERMES_AFFINITY
root['resources']['autocomplete']['methods']['warmup']['parameters']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackAutocompleteRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackBlockPersonRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackCreateGroupRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackDeleteGroupsRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackFlexorgsProtoInternalExternal']['properties']['application']['enum'][465]ATOM
root['schemas']['PeoplestackFlexorgsProtoInternalExternal']['properties']['application']['enumDescriptions'][465]Atom Team contact: atom-eng-team@google.com
root['schemas']['PeoplestackJoinGroupRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackLeaveGroupRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackLookupRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackMutateConnectionLabelRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackReadAllGroupsRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackReadGroupsRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackRecordShareReceivedRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackSmartAddressRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackUpdateGroupRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['PeoplestackWarmupRequest']['properties']['affinityType']['enum'][323]HERMES_AFFINITY
root['schemas']['SocialClientsApplicationProto3Wrapper']['properties']['application']['enum'][465]ATOM
root['schemas']['SocialClientsApplicationProto3Wrapper']['properties']['application']['enumDescriptions'][465]Atom Team contact: atom-eng-team@google.com
prod/performanceparameters-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/performanceparameters-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/policyremediator-
values_changed
root['revision']
new_value20250720
old_value20250713
prod/policyremediator-v1alpha
values_changed
root['revision']
new_value20250720
old_value20250713
prod/ppissuer-
values_changed
root['revision']
new_value20250724
old_value20250722
prod/ppissuer-v1
values_changed
root['revision']
new_value20250724
old_value20250722
prod/preprod-hangouts-
values_changed
root['revision']
new_value20250723
old_value20250720
prod/preprod-hangouts-v1
values_changed
root['revision']
new_value20250723
old_value20250720
prod/privacysandboxmaven-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/privacysandboxmaven-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/quantum-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/quantum-v1alpha1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/rbmopenmaap-
values_changed
root['revision']
new_value20250724
old_value20250721
prod/rbmopenmaap-v1
values_changed
root['revision']
new_value20250724
old_value20250721
prod/reach-pa-
dictionary_item_added
  • root['schemas']['CardsAlternative']['properties']['widescreenDeckKey']
values_changed
root['revision']
new_value20250724
old_value20250720
root['schemas']['CardsAlternative']['description']
new_valueA screen with tabs and cards. Used for Home, Personal info, etc. Next Id: 23
old_valueA screen with tabs and cards. Used for Home, Personal info, etc. Next Id: 22
prod/reach-pa-v1
dictionary_item_added
  • root['schemas']['CardsAlternative']['properties']['widescreenDeckKey']
values_changed
root['revision']
new_value20250724
old_value20250720
root['schemas']['CardsAlternative']['description']
new_valueA screen with tabs and cards. Used for Home, Personal info, etc. Next Id: 23
old_valueA screen with tabs and cards. Used for Home, Personal info, etc. Next Id: 22
prod/routeoptimization-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/routeoptimization-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/routes-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/routes-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/routespreferred-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/routespreferred-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/routespreferred-v1alpha
values_changed
root['revision']
new_value20250723
old_value20250721
prod/salesforceshopping-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/salesforceshopping-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/scone-pa-
values_changed
root['revision']
new_value20250723
old_value20250721
iterable_item_added
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][1159]b/425764480
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][1159]b/425764480
root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][86]b/427800806
root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][663]b/430034055
root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][1159]b/425764480
root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][86]b/427800806
root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][663]b/430034055
root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][1159]b/425764480
root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][86]b/427800806
root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][663]b/430034055
root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][1159]b/425764480
root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][1159]b/425764480
prod/scone-pa-v1
values_changed
root['revision']
new_value20250723
old_value20250721
iterable_item_added
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][1159]b/425764480
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][1159]b/425764480
root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][86]b/427800806
root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][663]b/430034055
root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][1159]b/425764480
root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][86]b/427800806
root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][663]b/430034055
root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][1159]b/425764480
root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][86]b/427800806
root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][663]b/430034055
root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][1159]b/425764480
root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][86]IDENTIFIER_ADS_TARGET_AUDIENCE
root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][663]IDENTIFIER_INACCURATE_IMAGERY_ISSUE
root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][1159]IDENTIFIER_TFR_SLA_SECONDS_LIVE_CHANNEL
root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][86]b/427800806
root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][663]b/430034055
root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][1159]b/425764480
prod/searchresearcherresults-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/searchresearcherresults-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/shoppingdataintegration-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/shoppingdataintegration-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/southamerica-east1-containerfilesystem-
values_changed
root['revision']
new_value20250719
old_value20250714
prod/southamerica-east1-containerfilesystem-v1
values_changed
root['revision']
new_value20250719
old_value20250714
prod/speechs3proto2-pa-
values_changed
root['revision']
new_value20250724
old_value20250722
prod/speechs3proto2-pa-v1
values_changed
root['revision']
new_value20250724
old_value20250722
prod/speechs3proto2-pa-v1alpha2
values_changed
root['revision']
new_value20250724
old_value20250722
prod/speechs3proto2-pa-v1beta1
values_changed
root['revision']
new_value20250724
old_value20250722
prod/staging-notifications-pa.sandbox-
dictionary_item_added
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__IntraAccountSharingEventData']
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['intraAccountSharingEventData']
dictionary_item_removed
  • root['schemas']['PhotosMediaClient__CurationData']['properties']['isHighlighted']
values_changed
root['revision']
new_value20250725
old_value20250722
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['description']
new_valueEvent sent by google native flows. Next id: 5
old_valueEvent sent by google native flows. Next id: 4
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][643]
new_valueNeed bundle type for Content Retrieval which fetches docIds with minimal filtering; go/discover-viewer-docid-cr
old_valueNeed bundle type for Content Retrieval which fetches docIds with minimal filtering; go/discover-viewer-docid-cr NextId: 4652
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][24]PIX_CLIPBOARD_DETECTION
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][36]CHANGE_CLOTHES
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][36]Change the clothes of the subject to a new clothes described by the text. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][644]LISTENS
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][644]Need bundle type for Listens in Discover. go/dl-responder
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1091]LISTENS
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enum'][5]NATIVE_EVENT_TYPE_INTRA_ACCOUNT_SHARING
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enumDescriptions'][5]Intra-account sharing event.
iterable_item_removed
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][4]NAME_GOOGLE_FAKE
prod/staging-notifications-pa.sandbox-v1
dictionary_item_added
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__IntraAccountSharingEventData']
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['intraAccountSharingEventData']
dictionary_item_removed
  • root['schemas']['PhotosMediaClient__CurationData']['properties']['isHighlighted']
values_changed
root['revision']
new_value20250725
old_value20250722
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['description']
new_valueEvent sent by google native flows. Next id: 5
old_valueEvent sent by google native flows. Next id: 4
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][643]
new_valueNeed bundle type for Content Retrieval which fetches docIds with minimal filtering; go/discover-viewer-docid-cr
old_valueNeed bundle type for Content Retrieval which fetches docIds with minimal filtering; go/discover-viewer-docid-cr NextId: 4652
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][24]PIX_CLIPBOARD_DETECTION
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][36]CHANGE_CLOTHES
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][36]Change the clothes of the subject to a new clothes described by the text. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][644]LISTENS
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][644]Need bundle type for Listens in Discover. go/dl-responder
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1091]LISTENS
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enum'][5]NATIVE_EVENT_TYPE_INTRA_ACCOUNT_SHARING
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enumDescriptions'][5]Intra-account sharing event.
iterable_item_removed
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][4]NAME_GOOGLE_FAKE
prod/staging-qual-qa-notifications-pa.sandbox-
dictionary_item_added
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__IntraAccountSharingEventData']
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['intraAccountSharingEventData']
dictionary_item_removed
  • root['schemas']['PhotosMediaClient__CurationData']['properties']['isHighlighted']
values_changed
root['revision']
new_value20250725
old_value20250722
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['description']
new_valueEvent sent by google native flows. Next id: 5
old_valueEvent sent by google native flows. Next id: 4
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][643]
new_valueNeed bundle type for Content Retrieval which fetches docIds with minimal filtering; go/discover-viewer-docid-cr
old_valueNeed bundle type for Content Retrieval which fetches docIds with minimal filtering; go/discover-viewer-docid-cr NextId: 4652
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][24]PIX_CLIPBOARD_DETECTION
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][36]CHANGE_CLOTHES
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][36]Change the clothes of the subject to a new clothes described by the text. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][644]LISTENS
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][644]Need bundle type for Listens in Discover. go/dl-responder
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1091]LISTENS
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enum'][5]NATIVE_EVENT_TYPE_INTRA_ACCOUNT_SHARING
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enumDescriptions'][5]Intra-account sharing event.
iterable_item_removed
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][4]NAME_GOOGLE_FAKE
prod/staging-qual-qa-notifications-pa.sandbox-v1
dictionary_item_added
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__IntraAccountSharingEventData']
  • root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['intraAccountSharingEventData']
dictionary_item_removed
  • root['schemas']['PhotosMediaClient__CurationData']['properties']['isHighlighted']
values_changed
root['revision']
new_value20250725
old_value20250722
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['description']
new_valueEvent sent by google native flows. Next id: 5
old_valueEvent sent by google native flows. Next id: 4
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][643]
new_valueNeed bundle type for Content Retrieval which fetches docIds with minimal filtering; go/discover-viewer-docid-cr
old_valueNeed bundle type for Content Retrieval which fetches docIds with minimal filtering; go/discover-viewer-docid-cr NextId: 4652
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][24]PIX_CLIPBOARD_DETECTION
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][36]CHANGE_CLOTHES
root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][36]Change the clothes of the subject to a new clothes described by the text. LINT.ThenChange(//depot/google3/photos/security/provenance/c2pa_write_helper.cc)
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][644]LISTENS
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][644]Need bundle type for Listens in Discover. go/dl-responder
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1091]LISTENS
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enum'][5]NATIVE_EVENT_TYPE_INTRA_ACCOUNT_SHARING
root['schemas']['WalletGooglepayBackendApiNotificationsDigitalcarkey__NativeRemoteEvent']['properties']['eventType']['enumDescriptions'][5]Intra-account sharing event.
iterable_item_removed
root['schemas']['WalletTapandpayCommonApiTransit__TransitAgencyInfo']['properties']['transitHubName']['enum'][4]NAME_GOOGLE_FAKE
prod/subscribewithgoogle-
values_changed
root['revision']
new_value20250723
old_value20250720
prod/subscribewithgoogle-v1
values_changed
root['revision']
new_value20250723
old_value20250720
prod/tenor-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/tenor-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/tenor-v2
values_changed
root['revision']
new_value20250723
old_value20250721
prod/tile-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/tile-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/transferappliance-v1alpha1
values_changed
root['revision']
new_value20250717
old_value20250710
prod/travelpartnerprices-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/travelpartnerprices-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/us-alpha-vision-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-alpha-vision-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-alpha-vision-v1p1beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-alpha-vision-v1p2beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-alpha-vision-v1p3beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-alpha-vision-v1p4beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-chronicle-
values_changed
root['revision']
new_value20250717
old_value20250710
iterable_item_added
root['schemas']['Metric']['properties']['dimensions']['items']['enum'][36]LOG_TYPE
root['schemas']['Metric']['properties']['dimensions']['items']['enumDescriptions'][36]Log type.
root['schemas']['Metric']['properties']['metricName']['enum'][39]UDM_DATA_PRESENCE_SUMMARY
root['schemas']['Metric']['properties']['metricName']['enumDescriptions'][39]UDM data summary tracking unique values of dimensions.
root['schemas']['UserError']['properties']['reason']['enum'][25]UNIQUE_FIELD_CONFLICT
root['schemas']['UserError']['properties']['reason']['enumDescriptions'][25]The resource that the user is trying to create already exists. Example ErrorInfo: { "reason": "UNIQUE_FIELD_CONFLICT", "metadata": { "conflicting_fields": "[{\"field_name\": \"display_name\", \"value\": \"display_name\"}]" } }
prod/us-chronicle-v1
values_changed
root['revision']
new_value20250717
old_value20250710
iterable_item_added
root['schemas']['Metric']['properties']['dimensions']['items']['enum'][36]LOG_TYPE
root['schemas']['Metric']['properties']['dimensions']['items']['enumDescriptions'][36]Log type.
root['schemas']['Metric']['properties']['metricName']['enum'][39]UDM_DATA_PRESENCE_SUMMARY
root['schemas']['Metric']['properties']['metricName']['enumDescriptions'][39]UDM data summary tracking unique values of dimensions.
root['schemas']['UserError']['properties']['reason']['enum'][25]UNIQUE_FIELD_CONFLICT
root['schemas']['UserError']['properties']['reason']['enumDescriptions'][25]The resource that the user is trying to create already exists. Example ErrorInfo: { "reason": "UNIQUE_FIELD_CONFLICT", "metadata": { "conflicting_fields": "[{\"field_name\": \"display_name\", \"value\": \"display_name\"}]" } }
prod/us-chronicle-v1alpha
dictionary_item_added
  • root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['cases']['methods']['getCaseOverviewData']
  • root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['cases']['resources']['caseAlerts']['methods']['getAlertOverviewData']
  • root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetDebugStepCaseData']
  • root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetOverviewTemplates']
  • root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetOverviewTemplate']['parameters']['templateIdentifier']
  • root['schemas']['AdvancedConfig']
  • root['schemas']['ApiActionParameter']
  • root['schemas']['ApiPlaybookCard']
  • root['schemas']['ApiSlaExpiration']
  • root['schemas']['ApiWorkflowInstanceCardDataModel']
  • root['schemas']['CaseInsightData']
  • root['schemas']['CertificateProvenance']
  • root['schemas']['ClientProvenance']
  • root['schemas']['Configuration']
  • root['schemas']['CustomFieldFormData']
  • root['schemas']['DailyScheduleDetails']
  • root['schemas']['DataDistributionSetting']
  • root['schemas']['EventData']
  • root['schemas']['HighlightFieldConfig']
  • root['schemas']['HtmlViewPreset']
  • root['schemas']['LegacyPlaybookActionWidgetTemplateResponse']
  • root['schemas']['LegacyPlaybookGetDebugStepCaseDataRequest']
  • root['schemas']['LegacyPlaybookGetDebugStepCaseDataResponse']
  • root['schemas']['LegacyPlaybookGetOverviewTemplateResponse']
  • root['schemas']['LegacyPlaybookGetPendingStepsUserRelatedResponse']
  • root['schemas']['MonthlyScheduleDetails']
  • root['schemas']['OneTimeScheduleDetails']
  • root['schemas']['OptionProvenance']
  • root['schemas']['OverviewData']
  • root['schemas']['OverviewWidgetMetadataResult']
  • root['schemas']['QuestionProvenance']
  • root['schemas']['QuickActionDataModel']
  • root['schemas']['ResourceRecordProvenance']
  • root['schemas']['ServerProvenance']
  • root['schemas']['TimeOfDay']
  • root['schemas']['UserAgentProtoProvenance']
  • root['schemas']['WeeklyScheduleDetails']
  • root['schemas']['WidgetApiActionDefinitionDataModel']
  • root['schemas']['WidgetApiDynamicResultMetadata']
  • root['schemas']['WidgetApiIntegrationInstanceDataModel']
  • root['schemas']['WidgetApiPendingStepInstanceDataModel']
  • root['schemas']['WidgetApiSecurityEntityDataModel']
  • root['schemas']['WidgetApiWorkflowStepInstanceDataModel']
  • root['schemas']['WidgetApiWorkflowStepParameterDataModel']
  • root['schemas']['WidgetCondition']
  • root['schemas']['WidgetConditionsGroup']
  • root['schemas']['WidgetPropertyValue']
  • root['schemas']['WorkflowInstance']
  • root['schemas']['WorkflowVersionLog']
  • root['schemas']['AccessPermissionProfileInfoOption']['properties']['role']['enum']
  • root['schemas']['AccessPermissionProfileInfoOption']['properties']['role']['enumDescriptions']
  • root['schemas']['AccessPermissionProfileInfoOption']['properties']['userType']['enum']
  • root['schemas']['AccessPermissionProfileInfoOption']['properties']['userType']['enumDescriptions']
  • root['schemas']['ApiPendingStepInstanceDataModel']['properties']['alertPriority']['enum']
  • root['schemas']['ApiPendingStepInstanceDataModel']['properties']['alertPriority']['enumDescriptions']
  • root['schemas']['ApiPendingStepInstanceDataModel']['properties']['casePriority']['enum']
  • root['schemas']['ApiPendingStepInstanceDataModel']['properties']['casePriority']['enumDescriptions']
  • root['schemas']['ApiWorkflowCategoryDataModel']['properties']['type']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['creationSource']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['defaultAccessLevel']['enum']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['defaultAccessLevel']['enumDescriptions']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['entityAccessLevel']['enum']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['entityAccessLevel']['enumDescriptions']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['playbookType']['enum']
  • root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['playbookType']['enumDescriptions']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['defaultAccessLevel']['enum']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['defaultAccessLevel']['enumDescriptions']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['entityAccessLevel']['enum']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['entityAccessLevel']['enumDescriptions']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['playbookType']['enum']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['playbookType']['enumDescriptions']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['status']['enum']
  • root['schemas']['ApiWorkflowInstanceDataModel']['properties']['status']['enumDescriptions']
  • root['schemas']['ApiWorkflowInstanceSummary']['properties']['retryPendingSteps']
  • root['schemas']['ApiWorkflowMenuCardDefinitionDataModel']['properties']['playbookType']['enum']
  • root['schemas']['ApiWorkflowMenuCardDefinitionDataModel']['properties']['playbookType']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepCardDataModel']['properties']['status']['enum']
  • root['schemas']['ApiWorkflowStepCardDataModel']['properties']['status']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepCardDataModel']['properties']['type']['enum']
  • root['schemas']['ApiWorkflowStepCardDataModel']['properties']['type']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepDataModel']['properties']['type']['enum']
  • root['schemas']['ApiWorkflowStepDataModel']['properties']['type']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepInstanceDataModel']['properties']['status']['enum']
  • root['schemas']['ApiWorkflowStepInstanceDataModel']['properties']['status']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepInstanceDataModel']['properties']['type']['enum']
  • root['schemas']['ApiWorkflowStepInstanceDataModel']['properties']['type']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepParameterDataModel']['properties']['type']['enum']
  • root['schemas']['ApiWorkflowStepParameterDataModel']['properties']['type']['enumDescriptions']
  • root['schemas']['ApiWorkflowStepRelationDataModel']['properties']['destinationActionStatus']['enum']
  • root['schemas']['ApiWorkflowStepRelationDataModel']['properties']['destinationActionStatus']['enumDescriptions']
  • root['schemas']['ApiWorkflowTriggerDataModel']['properties']['logicalOperator']['enum']
  • root['schemas']['ApiWorkflowTriggerDataModel']['properties']['logicalOperator']['enumDescriptions']
  • root['schemas']['ApiWorkflowTriggerDataModel']['properties']['type']['enum']
  • root['schemas']['ApiWorkflowTriggerDataModel']['properties']['type']['enumDescriptions']
  • root['schemas']['CaseSummaryFeedbackMetadata']['properties']['version']
  • root['schemas']['CaseWallRecord']['properties']['activityDataJson']
  • root['schemas']['CaseWallRecord']['properties']['activityKind']
  • root['schemas']['CaseWallRecord']['properties']['alertIdentifier']
  • root['schemas']['CaseWallRecord']['properties']['creatorFullName']
  • root['schemas']['ConnectorInstance']['properties']['integration']
  • root['schemas']['ContextGroupDataModel']['properties']['key']
  • root['schemas']['ContextGroupDataModel']['properties']['value']
  • root['schemas']['FavoriteRequest']['properties']['favorite']
  • root['schemas']['FtpProvenance']['properties']['command']
  • root['schemas']['IntegrationInstance']['properties']['identifier']
  • root['schemas']['IntegrationJobInstance']['properties']['advanced']
  • root['schemas']['IntegrationJobInstance']['properties']['advancedConfig']
  • root['schemas']['IntegrationJobInstance']['properties']['nextScheduledRunTime']
  • root['schemas']['LegacyFetchUdmSearchCsvRequest']['properties']['queryType']
  • root['schemas']['LegacyPlaybookAddOrUpdatePlaybookCategoryRequest']['properties']['type']
  • root['schemas']['LegacyPlaybookApiActionParameter']['properties']['type']['enum']
  • root['schemas']['LegacyPlaybookApiActionParameter']['properties']['type']['enumDescriptions']
  • root['schemas']['LegacyPlaybookApiSlaExpiration']['properties']['expirationStatus']['enum']
  • root['schemas']['LegacyPlaybookApiSlaExpiration']['properties']['expirationStatus']['enumDescriptions']
  • root['schemas']['LegacyPlaybookApiTriggerCondition']['properties']['matchType']['enum']
  • root['schemas']['LegacyPlaybookApiTriggerCondition']['properties']['matchType']['enumDescriptions']
  • root['schemas']['LegacyPlaybookApprovalLinkResult']['properties']['approvalLinkActionType']['enum']
  • root['schemas']['LegacyPlaybookApprovalLinkResult']['properties']['approvalLinkActionType']['enumDescriptions']
  • root['schemas']['LegacyPlaybookApprovalLinkResult']['properties']['status']['enum']
  • root['schemas']['LegacyPlaybookApprovalLinkResult']['properties']['status']['enumDescriptions']
  • root['schemas']['LegacyPlaybookCondition']['properties']['matchType']['enum']
  • root['schemas']['LegacyPlaybookCondition']['properties']['matchType']['enumDescriptions']
  • root['schemas']['LegacyPlaybookConditionsGroup']['properties']['logicalOperator']['enum']
  • root['schemas']['LegacyPlaybookConditionsGroup']['properties']['logicalOperator']['enumDescriptions']
  • root['schemas']['LegacyPlaybookGetWorkflowMenuCardsRequest']['properties']['legacyPayload']['items']['enum']
  • root['schemas']['LegacyPlaybookGetWorkflowMenuCardsRequest']['properties']['legacyPayload']['items']['enumDescriptions']
  • root['schemas']['LegacyPlaybookGetWorkflowMenuCardsWithEnvFilterRequest']['properties']['legacyPayload']['items']['enum']
  • root['schemas']['LegacyPlaybookGetWorkflowMenuCardsWithEnvFilterRequest']['properties']['legacyPayload']['items']['enumDescriptions']
  • root['schemas']['LegacyPlaybookGetWorkflowStepInstanceRequest']['properties']['parentWorkflowLoopIteration']
  • root['schemas']['LegacyPlaybookOverviewTemplateData']['properties']['type']['enum']
  • root['schemas']['LegacyPlaybookOverviewTemplateData']['properties']['type']['enumDescriptions']
  • root['schemas']['LegacyPlaybookPermissionsRequest']['properties']['defaultAccessLevel']['enum']
  • root['schemas']['LegacyPlaybookPermissionsRequest']['properties']['defaultAccessLevel']['enumDescriptions']
  • root['schemas']['LegacyPlaybookTemplateWidgetMetadata']['properties']['type']['enum']
  • root['schemas']['LegacyPlaybookTemplateWidgetMetadata']['properties']['type']['enumDescriptions']
  • root['schemas']['LegacyPlaybookTemplateWidgetMetadata']['properties']['width']['enum']
  • root['schemas']['LegacyPlaybookTemplateWidgetMetadata']['properties']['width']['enumDescriptions']
  • root['schemas']['LegacyPlaybookWorkflowAccessPermissions']['properties']['accessLevel']['enum']
  • root['schemas']['LegacyPlaybookWorkflowAccessPermissions']['properties']['accessLevel']['enumDescriptions']
  • root['schemas']['MalachiteFinding']['properties']['producerDetectionIds']
  • root['schemas']['QuickActionInstanceConfiguration']['properties']['isDynamicMode']
  • root['schemas']['SecurityEntityCard']['properties']['direction']['enum']
  • root['schemas']['SecurityEntityCard']['properties']['direction']['enumDescriptions']
  • root['schemas']['WorkbookAccessPermissionsItem']['properties']['accessLevel']['enum']
  • root['schemas']['WorkbookAccessPermissionsItem']['properties']['accessLevel']['enumDescriptions']
dictionary_item_removed
  • root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetOverviewTemplate']['request']
  • root['schemas']['CaseWallRecord']['properties']['activityData']
  • root['schemas']['CaseWallRecord']['properties']['alertId']
  • root['schemas']['InvestigationStep']['properties']['query']
  • root['schemas']['QuickActionButton']['properties']['buttonColor']['readOnly']
  • root['schemas']['QuickActionButton']['properties']['buttonName']['readOnly']
  • root['schemas']['QuickActionInstanceConfiguration']['properties']['isDynamicModel']
  • root['schemas']['QuickActionParameterValue']['properties']['actionParameterId']['readOnly']
  • root['schemas']['QuickActionParameterValue']['properties']['value']['readOnly']
  • root['schemas']['S3AuthV2']['properties']['awsIamRoleArn']
  • root['schemas']['SQSAuthV2']['properties']['awsIamRoleArn']
values_changed
root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['contentHub']['resources']['featuredContentRules']['methods']['list']['parameters']['filter']['description']
new_valueOptional. Only the following filters are allowed: Under HAS operator: Filtering through category names: - Singular: `category_name:""` - Multiple: `category_name:"" OR category_name:""` -- You can only use OR operator between multiple category_name filters. Filtering through policy names: - Singular: `policy_name:""` - Multiple: `policy_name:"" OR policy_name:""` -- You can only use OR operator between multiple policy_name filters. Filtering through rule IDs: - Singular: `rule_id:"ur_"` - Multiple: `rule_id:"ur_" OR rule_id:"ur_"` -- You can only use OR operator between multiple rule_id filters. Filtering through rule precision: `rule_precision:""` -- Rule precision values can be "Precise" or "Broad". If something else is passed, the rule precision will default to "Unknown". You can only filter by one rule precision value. Under MATCHES_REGEXP operator: Search through rule name or description (behaves like a string contains): This search is case-insensitive and filters through the rule metadata, specifically the rule_name and description keys. `search_rule_name_or_description=~" or "`. You can only filter by one rule name or description value. Multiple filters can also be used together: Ex 1: `category_name:"" AND policy_name:""` Ex 2: Since category_name and policy_name are repeated fields, we can also use multiple values for each: `(category_name:"" OR category_name:"") AND policy_name:""` -- Note that the AND operator has higher precedence than the OR operator. Additionally, parentheses must be used to create a valid filter. Requests using filter comparators other than HAS(:) or MATCHES_REGEXP(=~) will result in an InvalidArgument error.
old_valueOptional. Only the following filters are allowed: Under HAS operator: Filtering through category names: - Singular: `category_name:""` - Multiple: `category_name:"" OR category_name:""` -- You can only use OR operator between multiple category_name filters. Filtering through policy names: - Singular: `policy_name:""` - Multiple: `policy_name:"" OR policy_name:""` -- You can only use OR operator between multiple policy_name filters. Filtering through rule precision: `rule_precision:""` -- Rule precision values can be "Precise" or "Broad". If something else is passed, the rule precision will default to "Unknown". You can only filter by one rule precision value. Filtering through rule ID: `rule_id:"ur_"` -- You can only filter by one rule ID value. Under MATCHES_REGEXP operator: Search through rule name or description (behaves like a string contains): This search is case-insensitive and filters through the rule metadata, specifically the rule_name and description keys. `search_rule_name_or_description=~" or "`. You can only filter by one rule name or description value. Multiple filters can also be used together: Ex 1: `category_name:"" AND policy_name:""` Ex 2: Since category_name and policy_name are repeated fields, we can also use multiple values for each: `(category_name:"" OR category_name:"") AND policy_name:""` -- Note that the AND operator has higher precedence than the OR operator. Additionally, parentheses must be used to create a valid filter. Requests using filter comparators other than HAS(:) or MATCHES_REGEXP(=~) will result in an InvalidArgument error.
root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyActionWidgetTemplate']['response']['$ref']
new_valueLegacyPlaybookActionWidgetTemplateResponse
old_valueLegacyPlaybookTemplateWidgetDefinition
root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetOverviewTemplate']['description']
new_valueLegacyPlaybookGetOverviewTemplate returns the overview template by template identifier.
old_valueLegacyPlaybookGetOverviewTemplateByPlaybookIdentifier returns the overview template by playbook identifier.
root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetOverviewTemplate']['httpMethod']
new_valueGET
old_valuePOST
root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetPendingStepsUserRelated']['parameters']['sortBy']['description']
new_valueOptional. Possible options for sorting the pending steps: - TimeAscending - TimeDescending - PriorityAscending - PriorityDescending - TimeToResponseAscending - TimeToResponseDescending - SlaAscending - SlaDescending - Sort by field.
old_valueOptional. Sort by field. Possible values: TimeAscending = 0, TimeDescending = 1, PriorityAscending = 2, PriorityDescending = 3, TimeToResponseAscending = 4, TimeToResponseDescending = 5, SlaAscending = 6, SlaDescending = 7
root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['legacyPlaybooks']['methods']['legacyGetPendingStepsUserRelated']['response']['$ref']
new_valueLegacyPlaybookGetPendingStepsUserRelatedResponse
old_valueApiWorkflowStepInstanceDataModel
root['revision']
new_value20250717
old_value20250710
root['schemas']['AccessPermissionProfileInfoOption']['properties']['role']['description']
new_valueRequired. Role is the role of the user.
old_valueRequired. Role is the role of the user. Analyst role. ANALYST = 0; Administrator role. ADMIN = 1;
root['schemas']['AccessPermissionProfileInfoOption']['properties']['userType']['description']
new_valueRequired. UserType is the type of the user.
old_valueRequired. UserType is the type of the user. Windows user type. WINDOWS = 0; Internal user type. INTERNAL = 1; External user type. EXTERNAL = 2; Support user type. SUPPORT = 3; Incident manager user type. INCIDENT_MANAGER = 4;
root['schemas']['ApiPendingStepInstanceDataModel']['properties']['alertPriority']['description']
new_valueOptional. AlertPriority is the priority of the alert.
old_valueOptional. AlertPriority is the priority of the alert. Possible values: INFORMATAIVE = -1; UNCHANGED = 0; LOW = 40; MEDIUM = 60; HIGH = 80; CRITICAL = 100;
root['schemas']['ApiPendingStepInstanceDataModel']['properties']['casePriority']['description']
new_valueOptional. CasePriority is the priority of the case.
old_valueOptional. CasePriority is the priority of the case. Possible values: INFORMATAIVE = -1; UNCHANGED = 0; LOW = 40; MEDIUM = 60; HIGH = 80; CRITICAL = 100;
root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['defaultAccessLevel']['description']
new_valueRequired. DefaultAccessLevel is the default access level for the workflow.
old_valueRequired. DefaultAccessLevel is the default access level for the workflow. Possible values: WORKFLOW_ACCESS_UNSPECIFIED = 0; VIEW = 1; EDIT = 2; EXECUTE = 3;
root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['entityAccessLevel']['description']
new_valueRequired. EntityAccessLevel is the access level for entities.
old_valueRequired. EntityAccessLevel is the access level for entities. Possible values: WORKFLOW_ACCESS_UNSPECIFIED = 0; VIEW = 1; EDIT = 2; EXECUTE = 3;
root['schemas']['ApiWorkflowDefinitionDataModel']['properties']['playbookType']['description']
new_valueRequired. PlaybookType is the type of playbook.
old_valueRequired. PlaybookType is the type of playbook. Possible values: Regular playbook type. REGULAR = 0; Nested playbook type. NESTED = 1;
root['schemas']['ApiWorkflowInstanceDataModel']['properties']['defaultAccessLevel']['description']
new_valueRequired. DefaultAccessLevel is the default access level for the workflow.
old_valueRequired. DefaultAccessLevel is the default access level for the workflow. Possible values: WORKFLOW_ACCESS_UNSPECIFIED = 0; VIEW = 1; EDIT = 2; EXECUTE = 3;
root['schemas']['ApiWorkflowInstanceDataModel']['properties']['entityAccessLevel']['description']
new_valueRequired. EntityAccessLevel is the access level for entities.
old_valueRequired. EntityAccessLevel is the access level for entities. Possible values: WORKFLOW_ACCESS_UNSPECIFIED = 0; VIEW = 1; EDIT = 2; EXECUTE = 3;
root['schemas']['ApiWorkflowInstanceDataModel']['properties']['playbookType']['description']
new_valueRequired. PlaybookType is the type of playbook.
old_valueRequired. PlaybookType is the type of playbook. Possible values: Regular playbook type. REGULAR = 0; Nested playbook type. NESTED = 1;
root['schemas']['ApiWorkflowInstanceDataModel']['properties']['status']['description']
new_valueRequired. Status is the status of the workflow instance.
old_valueRequired. Status is the status of the workflow instance. Possible values: None = 0, InProgress = 1, Completed = 2, Failed = 3, Terminated = 4, PendingInQueue = 5, PendingForUser = 6
root['schemas']['ApiWorkflowMenuCardDefinitionDataModel']['properties']['playbookType']['description']
new_valueRequired. PlaybookType is the type of playbook.
old_valueRequired. PlaybookType is the type of playbook. Possible values: Regular playbook type. REGULAR = 0; Nested playbook type. NESTED = 1;
root['schemas']['ApiWorkflowStepCardDataModel']['properties']['status']['description']
new_valueRequired. Status is the status of the action.
old_valueRequired. Status is the status of the action. Possible values: NoStatus = -1, Faulted = 0, InProgress = 1, Completed = 2, PendingUserInput = 3, PendingPreviousSteps = 4, Started = 5, FaultedAndSkipped = 6, HandledTimedout = 7, UnhandledTimedout = 8, Terminated = 9, NotRunAndSkipped = 10, PendingActionTimeout = 11, PendingActionTimeoutAndSkipped = 12, PendingRetry = 13
root['schemas']['ApiWorkflowStepCardDataModel']['properties']['type']['description']
new_valueRequired. Type is the type of the step.
old_valueRequired. Type is the type of the step. Possible values: Action = 0, MultiChoiceQuestion = 1, PreviousAction = 2, CaseDataCondition = 3, Condition = 4, Block = 5, Output = 6, ParallelActionsContainer = 7, ForEachStartLoop = 8, ForEachEndLoop = 9
root['schemas']['ApiWorkflowStepDataModel']['properties']['type']['description']
new_valueRequired. Type is the type of the step.
old_valueRequired. Type is the type of the step. Possible values: ACTION = 0; MULTI_CHOICE_QUESTION = 1; PREVIOUS_ACTION = 2; CASE_DATA_CONDITION = 3; CONDITION = 4; BLOCK = 5; OUTPUT = 6; PARALLEL_ACTIONS_CONTAINER = 7; FOR_EACH_START_LOOP = 8; FOR_EACH_END_LOOP = 9;
root['schemas']['ApiWorkflowStepInstanceDataModel']['properties']['status']['description']
new_valueRequired. Status is the status of the step.
old_valueRequired. Status is the status of the step. Possible values: NO_STATUS = 0; RUNNING = 1; SUCCESS = 2; FAILED = 3; PENDING = 4; SKIPPED = 5; CANCELED = 6; QUEUED = 7;
root['schemas']['ApiWorkflowStepInstanceDataModel']['properties']['type']['description']
new_valueRequired. Type is the type of the step.
old_valueRequired. Type is the type of the step. Possible values: STEP_TYPE_UNSPECIFIED = 0; ACTION = 1; FLOW = 2; CONDITION = 3; BLOCK = 4;
root['schemas']['ApiWorkflowStepParameterDataModel']['properties']['type']['description']
new_valueOptional. Type is the type of the parameter.
old_valueOptional. Type is the type of the parameter. Possible values: STRING = 0; BOOLEAN = 1; WFS_REPOSITORY = 2; USER_REPOSITORY = 3; STAGES_REPOSITORY = 4; CLOSECASE_REASON_REPOSITORY = 5; CLOSECASE_ROOTCAUSE_REPOSITORY = 6; PRIORITIES_REPOSITORY = 7; EMAILCONTENT = 10; CONTENT = 11; PASSWORD = 12; ENTITY_TYPE = 13; MULTIVALUES = 14; LIST = 15; CODE = 16; TIMESPANSECONDS = 17; MULTIPLECHOICEPARAMETER = 21;
root['schemas']['ApiWorkflowStepRelationDataModel']['properties']['destinationActionStatus']['description']
new_valueRequired. DestinationActionStatus is the status of the destination action.
old_valueRequired. DestinationActionStatus is the status of the destination action. Possible values: NO_STATUS = -1; FAULTED = 0; IN_PROGRESS = 1; COMPLETED = 2; PENDING_USER_INPUT = 3; PENDING_PREVIOUS_STEPS = 4; STARTED = 5; FAULTED_AND_SKIPPED = 6; HANDLED_TIMEDOUT = 7; UNHANDLED_TIMEDOUT = 8; TERMINATED = 9; NOT_RUN_AND_SKIPPED = 10; PENDING_ACTION_TIMEOUT = 11; PENDING_ACTION_TIMEOUT_AND_SKIPPED = 12; PENDING_RETRY = 13;
root['schemas']['ApiWorkflowTriggerDataModel']['properties']['logicalOperator']['description']
new_valueRequired. LogicalOperator is the logical operator for the conditions.
old_valueRequired. LogicalOperator is the logical operator for the conditions. Possible values: AND = 0; OR = 1;
root['schemas']['ApiWorkflowTriggerDataModel']['properties']['type']['description']
new_valueRequired. Type is the type of the trigger.
old_valueRequired. Type is the type of the trigger. Possible values: VENDOR_NAME = 0; TAG_NAME = 1; RULE_NAME = 2; PRODUCT_NAME = 3; NETWORK_NAME = 4; ENTITY_DETAILS = 5; RELATION_DETAILS = 6; TRACKING_LIST = 7; ALL = 8; ALERT_TRIGGER_VALUE = 9; CASE_DATA = 10; GET_INPUTS = 11;
root['schemas']['ArtifactClientProvenance']['properties']
new_value
behaviors
items
$refFieldProvenance
typearray
proxies
items
$refFieldProvenance
typearray
old_value
root['schemas']['AzureV2WorkloadIdentityFederation']['properties']['subjectId']['description']
new_valueRequired. Subject ID of the Azure subscription.
old_valueSubject ID of the Azure subscription.
root['schemas']['CaseWallRecord']['properties']['createTime']['format']
new_valueint64
old_valuegoogle-datetime
root['schemas']['CaseWallRecord']['properties']['updateTime']['format']
new_valueint64
old_valuegoogle-datetime
root['schemas']['DhcpProvenance']['properties']
new_value
chaddr
$refFieldProvenance
ciaddr
$refFieldProvenance
clientHostname
$refFieldProvenance
clientIdentifier
$refFieldProvenance
clientIdentifierString
$refFieldProvenance
file
$refFieldProvenance
flags
$refFieldProvenance
giaddr
$refFieldProvenance
hlen
$refFieldProvenance
hops
$refFieldProvenance
htype
$refFieldProvenance
leaseTimeSeconds
$refFieldProvenance
opcode
$refFieldProvenance
options
items
$refOptionProvenance
typearray
requestedAddress
$refFieldProvenance
seconds
$refFieldProvenance
siaddr
$refFieldProvenance
sname
$refFieldProvenance
transactionId
$refFieldProvenance
type
$refFieldProvenance
yiaddr
$refFieldProvenance
old_value
root['schemas']['DnsProvenance']['properties']
new_value
additional
items
$refResourceRecordProvenance
typearray
answers
items
$refResourceRecordProvenance
typearray
authoritative
$refFieldProvenance
authority
items
$refResourceRecordProvenance
typearray
id
$refFieldProvenance
opcode
$refFieldProvenance
questions
items
$refQuestionProvenance
typearray
recursionAvailable
$refFieldProvenance
recursionDesired
$refFieldProvenance
response
$refFieldProvenance
responseCode
$refFieldProvenance
truncated
$refFieldProvenance
old_value
root['schemas']['EmailProvenance']['properties']
new_value
bcc
items
$refFieldProvenance
typearray
bounceAddress
$refFieldProvenance
cc
items
$refFieldProvenance
typearray
from
$refFieldProvenance
mailId
$refFieldProvenance
replyTo
$refFieldProvenance
subject
items
$refFieldProvenance
typearray
to
items
$refFieldProvenance
typearray
old_value
root['schemas']['HttpProvenance']['properties']
new_value
method
$refFieldProvenance
parsedUserAgent
$refUserAgentProtoProvenance
referralUrl
$refFieldProvenance
responseCode
$refFieldProvenance
userAgent
$refFieldProvenance
old_value
root['schemas']['LegacyPlaybookApiActionParameter']['properties']['type']['description']
new_valueRequired. Type is the type of the parameter.
old_valueRequired. Type is the type of the parameter. Possible values: STRING = 0; BOOLEAN = 1; WFS_REPOSITORY = 2; USER_REPOSITORY = 3; STAGES_REPOSITORY = 4; CLOSECASE_REASON_REPOSITORY = 5; CLOSECASE_ROOTCAUSE_REPOSITORY = 6; PRIORITIES_REPOSITORY = 7; EMAILCONTENT = 10; CONTENT = 11; PASSWORD = 12; ENTITY_TYPE = 13; MULTIVALUES = 14; LIST = 15; CODE = 16; TIMESPANSECONDS = 17; MULTIPLECHOICEPARAMETER = 21;
root['schemas']['LegacyPlaybookApiSlaExpiration']['properties']['expirationStatus']['description']
new_valueRequired. ExpirationStatus is the expiration status.
old_valueRequired. ExpirationStatus is the expiration status. Possible values: PASSED_DUE = 0; OPEN_SLA = 1; NO_SLA = 2; CRITICAL_EXPIRED = 3; PAUSED = 4;
root['schemas']['LegacyPlaybookApiTriggerCondition']['properties']['matchType']['description']
new_valueRequired. MatchType is the operator to use for comparison.
old_valueRequired. MatchType is the operator to use for comparison. Possible values: EQUAL = 0; CONTAINS = 1; STARTS_WITH = 2; GREATER_THAN = 3; LESSER_THAN = 4; NOT_EQUAL = 5; NOT_CONTAINS = 6; IS_EMPTY = 7; IS_NOT_EMPTY = 8;
root['schemas']['LegacyPlaybookApprovalLinkResult']['properties']['approvalLinkActionType']['description']
new_valueRequired. The type of the approval link action.
old_valueRequired. The type of the approval link action. Approve. APPROVE = 0; Decline. DECLINE = 1; MultiChoiceAnswer. MULTI_CHOICE_ANSWER = 2;
root['schemas']['LegacyPlaybookApprovalLinkResult']['properties']['status']['description']
new_valueRequired. The status of the approval link.
old_valueRequired. The status of the approval link. Approval link skip/execute successfully completed. SUCCESS = 0; Approval link step not found. STEP_NOT_FOUND = 1; The approval link step already excepted. STEP_ALREADY_EXECUTED = 2; The approval link step to response expired. STEP_TIME_TO_RESPONSE_EXPIRED = 3; The approval link step is not pending yet. STEP_NOT_PENDING = 4; Approval link execution requires another click from the user. CLICK_REQUIRED = 5;
root['schemas']['LegacyPlaybookCondition']['properties']['matchType']['description']
new_valueRequired. MatchType is the operator to use for comparison.
old_valueRequired. MatchType is the operator to use for comparison. Possible values: EQUAL = 0; CONTAINS = 1; STARTS_WITH = 2; GREATER_THAN = 3; LESSER_THAN = 4; NOT_EQUAL = 5; NOT_CONTAINS = 6; IS_EMPTY = 7; IS_NOT_EMPTY = 8;
root['schemas']['LegacyPlaybookConditionsGroup']['properties']['logicalOperator']['description']
new_valueRequired. LogicalOperator is the logical operator for the conditions.
old_valueRequired. LogicalOperator is the logical operator for the conditions. Possible values: AND = 0; OR = 1;
root['schemas']['LegacyPlaybookDuplicateNestedWorkflowsResponse']['properties']['payload']['items']
new_value
$refApiWorkflowDefinitionDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookDuplicateWorkflowsResponse']['properties']['payload']['items']
new_value
$refApiWorkflowDefinitionDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetEnabledWFCardsResponse']['properties']['payload']['items']
new_value
$refApiPlaybookCard
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetHtmlViewPresetsResponse']['properties']['payload']['items']
new_value
$refHtmlViewPreset
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetNestedPlaybooksAsStepsResponse']['properties']['payload']['items']
new_value
$refApiWorkflowStepDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetNestedPlaybooksByEnvironmentsAsStepsResponse']['properties']['payload']['items']
new_value
$refApiWorkflowStepDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetNestedWorkflowDefaultInputsResponse']['properties']
new_value
payload
descriptionOptional. The payload is a list of trigger conditions.
items
$refLegacyPlaybookApiTriggerCondition
typearray
old_value
fieldName
descriptionRequired. FieldName is the name of the field to check.
typestring
matchType
descriptionRequired. MatchType is the operator to use for comparison. Equals operator. EQUAL = 0; Contains operator. CONTAINS = 1; Starts With operator. STARTS_WITH = 2; Greater Than operator. GREATER_THAN = 3; Lesser Than operator. LESSER_THAN = 4; Not Equals operator. NOT_EQUAL = 5; Not Contains operator. NOT_CONTAINS = 6; Is Empty operator. IS_EMPTY = 7; Is Not Empty operator. IS_NOT_EMPTY = 8;
typestring
value
descriptionRequired. Value is the value to compare against.
typestring
root['schemas']['LegacyPlaybookGetPlaybookSimulationEnrichmentResponse']['properties']['payload']['items']
new_value
$refContextGroupDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetWorkFlowVersionLogsResponse']['properties']['payload']['description']
new_valueOptional. The workflow version logs.
old_valueOptional. The workflow version logs. The Struct will contain the following fields: work_flow_identifier: Guid workflow_name: string creation_time_unix_time_in_ms: long version_creator: string version_comment: string
root['schemas']['LegacyPlaybookGetWorkFlowVersionLogsResponse']['properties']['payload']['items']
new_value
$refWorkflowVersionLog
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetWorkflowCategoriesResponse']['properties']['payload']['items']
new_value
$refApiWorkflowCategoryDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetWorkflowInstancesCardsResponse']['properties']['payload']['description']
new_valueOptional. The workflow instances cards.
old_valueOptional. The workflow instances cards. The Struct will contain the following fields: status: WorkflowInstanceStatusEnum name: string definition_identifier: Guid original_workflow_definition_identifier: Guid description: string position_in_queue: int is_debug_mode: bool run_count: long
root['schemas']['LegacyPlaybookGetWorkflowInstancesCardsResponse']['properties']['payload']['items']
new_value
$refApiWorkflowInstanceCardDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetWorkflowMenuCardsRequest']['properties']['legacyPayload']['description']
new_valueRequired. Playbook types to filter the workflow menu cards by.
old_valueRequired. Playbook types to filter the workflow menu cards by. Possible values: Regular playbook type. REGULAR = 0; Nested playbook type. NESTED = 1;
root['schemas']['LegacyPlaybookGetWorkflowMenuCardsResponse']['properties']['payload']['items']
new_value
$refApiWorkflowMenuCardDefinitionDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookGetWorkflowMenuCardsWithEnvFilterRequest']['properties']['legacyPayload']['description']
new_valueRequired. Playbook types to filter the workflow menu cards by.
old_valueRequired. Playbook types to filter the workflow menu cards by. Possible values: Regular playbook type. REGULAR = 0; Nested playbook type. NESTED = 1;
root['schemas']['LegacyPlaybookGetWorkflowMenuCardsWithEnvFilterResponse']['properties']['payload']['items']
new_value
$refApiWorkflowMenuCardDefinitionDataModel
old_value
additionalProperties
descriptionProperties of the object.
typeany
typeobject
root['schemas']['LegacyPlaybookOverviewTemplateData']['properties']['type']['description']
new_valueRequired. Type is the type of the overview template.
old_valueRequired. Type is the type of the overview template. Possible values: PLAYBOOK_DEFAULT = 0; REGULAR = 1; SYSTEM_ALERT = 2; SYSTEM_CASE = 3; ALERT_TYPE = 4;
root['schemas']['LegacyPlaybookPermissionsRequest']['properties']['defaultAccessLevel']['description']
new_valueOptional. The default access level.
old_valueOptional. The default access level. No access. NO_ACCESS = 0; View access. VIEW = 1; Edit access. EDIT = 2;
root['schemas']['LegacyPlaybookRerunBlockResponse']['properties']['payload']
new_value
$refWorkflowInstance
descriptionOptional. The response is a workflow instance.
old_value
additionalProperties
descriptionProperties of the object.
typeany
descriptionOptional. The response is a workflow instance.
typeobject
root['schemas']['LegacyPlaybookRerunPlaybookResponse']['properties']['payload']
new_value
$refWorkflowInstance
descriptionOptional. The workflow instance.
old_value
additionalProperties
descriptionProperties of the object.
typeany
descriptionOptional. The workflow instance.
typeobject
root['schemas']['LegacyPlaybookTemplateWidgetMetadata']['properties']['type']['description']
new_valueRequired. Type is the type of the widget.
old_valueRequired. Type is the type of the widget. Possible values: WIDGET_TEMPLATE_TYPE_UNSPECIFIED = 0; ACTION = 1; CASE_OVERVIEW = 2; ENTITY_GRAPH = 3; EVENTS_TABLE = 4; INSIGHTS = 5; JSON = 6; MULTI_CHOICE_QUESTION = 7; PARALLEL_ACTIONS_CONTAINER = 8; PREVIOUS_ACTION = 9; STATIC_TEXT = 10; VISUAL_REPORT = 11; WEB_PAGE = 12; IFRAME = 13; TABLE = 14; MARKDOWN = 15; FILE = 16; IMAGE = 17; BUTTON = 18; GROUP = 19; CUSTOM = 20;
root['schemas']['LegacyPlaybookTemplateWidgetMetadata']['properties']['width']['description']
new_valueRequired. Width is the width of the widget.
old_valueRequired. Width is the width of the widget. Possible values: ONE = 0; TWO = 1; THREE = 2; FOUR = 3;
root['schemas']['LegacyPlaybookWorkflowAccessPermissions']['properties']['accessLevel']['description']
new_valueRequired. AccessLevel is the access level for the user.
old_valueRequired. AccessLevel is the access level for the user. Possible values: NO_ACCESS = 0; VIEW = 1; EDIT = 2;
root['schemas']['ProxyInfoProvenance']['properties']
new_value
anonymous
$refFieldProvenance
anonymousVpn
$refFieldProvenance
hostingProvider
$refFieldProvenance
proxyOverVpn
$refFieldProvenance
publicProxy
$refFieldProvenance
relayProxy
$refFieldProvenance
residentialProxy
$refFieldProvenance
smartDnsProxy
$refFieldProvenance
torExitNode
$refFieldProvenance
vpnDatacenter
$refFieldProvenance
vpnServiceName
$refFieldProvenance
old_value
root['schemas']['QuickActionButton']['description']
new_valueQuickActionButton
old_valueQuick button.
root['schemas']['QuickActionButton']['properties']['buttonColor']['description']
new_valueThe button color.
old_valueOutput only. The button color.
root['schemas']['QuickActionButton']['properties']['buttonName']['description']
new_valueThe button name.
old_valueOutput only. The button name.
root['schemas']['QuickActionInstanceConfiguration']['description']
new_valueThe configuration of the quick action instance.
old_valueQuick action instance configuration.
root['schemas']['QuickActionParameterValue']['description']
new_valueQuickActionParameterValue
old_valueQuick action parameter value.
root['schemas']['QuickActionParameterValue']['properties']['actionParameterId']['description']
new_valueThe action parameter id.
old_valueOutput only. The parameter id.
root['schemas']['QuickActionParameterValue']['properties']['value']['description']
new_valueThe action parameter value.
old_valueOutput only. The parameter value.
root['schemas']['RemoveDependencyResponse']['properties']
new_value
error
descriptionOptional. An error message in case of an error.
typestring
successful
descriptionRequired. True if the removal was successful.
typeboolean
old_value
root['schemas']['SQSAuthV2']['properties']['awsIamRoleAuth']['description']
new_valueRequired. AWS IAM Role for Identity Federation.
old_valueAWS IAM Role for Identity Federation.
root['schemas']['ScriptResultEntityData']['description']
new_valueThe result entity data of the API action.
old_valueThe result entity data of the pending step.
root['schemas']['ScriptResultEntityData']['properties']['attachments']['description']
new_valueOutput only. The attachments of the result entity data.
old_valueOutput only. The additional properties of the result entity data.
root['schemas']['ScriptResultEntityData']['properties']['isForEntity']['type']
new_valueboolean
old_valuestring
root['schemas']['SecurityEntityCard']['properties']['direction']['description']
new_valueOptional. Direction is the direction of the entity.
old_valueOptional. Direction is the direction of the entity. Possible values: None = 0, Inbound = 10, Outbound = 20, Both = 30,
root['schemas']['SetLogsCollectionResponse']['properties']
new_value
logEnableExpirationTime
descriptionOutput only. The connector instance logging enabled time until unix ms
formatint64
readOnlyTrue
typestring
old_value
lastLoggingEnabledTime
descriptionOutput only. The connector instance logging enabled time until unix ms
formatint64
readOnlyTrue
typestring
root['schemas']['SmtpProvenance']['properties']
new_value
helo
$refFieldProvenance
isTls
$refFieldProvenance
isWebmail
$refFieldProvenance
mailFrom
$refFieldProvenance
messagePath
$refFieldProvenance
rcptTo
items
$refFieldProvenance
typearray
serverResponse
items
$refFieldProvenance
typearray
old_value
root['schemas']['TlsProvenance']['properties']
new_value
cipher
$refFieldProvenance
client
$refClientProvenance
curve
$refFieldProvenance
established
$refFieldProvenance
nextProtocol
$refFieldProvenance
resumed
$refFieldProvenance
server
$refServerProvenance
version
$refFieldProvenance
versionProtocol
$refFieldProvenance
old_value
root['schemas']['TunnelsProvenance']['properties']
new_value
provider
$refFieldProvenance
type
$refFieldProvenance
old_value
root['schemas']['WorkbookAccessPermissionsItem']['properties']['accessLevel']['description']
new_valueRequired. AccessLevel is the access level for the user.
old_valueRequired. AccessLevel is the access level for the user. No access. NO_ACCESS = 0; View access. VIEW = 1; Edit access. EDIT = 2;
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][9]
new_valueCASE_EXTERNAL_CHANNEL_MESSAGE
old_valueWALL_ACTIVITY_TYPE_CASE_EXTERNAL_CHANNEL_MESSAGE
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][9]
new_valueCASE_EXTERNAL_CHANNEL_MESSAGE
old_valueWALL_ACTIVITY_TYPE_CASE_EXTERNAL_CHANNEL_MESSAGE
root['schemas']['LegacyPlaybookAddOrUpdatePlaybookCategoryRequest']['properties']['categoryState']['enumDescriptions'][2]
new_valueThe category state is full.
old_valueFull state from restricted environment.
root['schemas']['QuickActionButton']['properties']['buttonColor']['enumDescriptions'][2]
new_valueThe button color is orange.
old_valueThe color is green.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][6]
new_valueCASE_COMMENT
old_valueWALL_ACTIVITY_TYPE_CASE_COMMENT
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][6]
new_valueCASE_COMMENT
old_valueWALL_ACTIVITY_TYPE_CASE_COMMENT
root['schemas']['ApiWorkflowCategoryDataModel']['properties']['categoryState']['enumDescriptions'][1]
new_valueThe category state is empty.
old_valueFull state.
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][5]
new_valueCASE_EVIDENCE
old_valueWALL_ACTIVITY_TYPE_CASE_EVIDENCE
root['schemas']['LegacyPlaybookAddOrUpdatePlaybookCategoryRequest']['properties']['categoryState']['enumDescriptions'][1]
new_valueThe category state is empty.
old_valueFull state.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][3]
new_valueCASE_TASK
old_valueWALL_ACTIVITY_TYPE_CASE_TASK
root['schemas']['LegacyPlaybookAddOrUpdatePlaybookCategoryRequest']['properties']['categoryState']['enumDescriptions'][0]
new_valueThe category state is unspecified.
old_valueEmpty state.
root['schemas']['FavoriteRequest']['properties']['activityType']['enumDescriptions'][1]
new_valueCase alert data activity type.
old_valueAlert data activity type.
root['schemas']['CaseWallRecord']['properties']['activityType']['enumDescriptions'][0]
new_valueUnspecified wall activity type.
old_valueUnspecified activity type.
root['schemas']['FavoriteRequest']['properties']['activityType']['enumDescriptions'][0]
new_valueUnspecified wall activity type.
old_valueUnspecified activity type.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][4]
new_valueCASE_ACTION
old_valueWALL_ACTIVITY_TYPE_CASE_ACTION
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][4]
new_valueCASE_ACTION
old_valueWALL_ACTIVITY_TYPE_CASE_ACTION
root['schemas']['QuickActionButton']['properties']['buttonColor']['enumDescriptions'][1]
new_valueThe button color is yellow.
old_valueThe color is blue.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][10]
new_valuePINNED_CASE_CHAT_MESSAGE
old_valueWALL_ACTIVITY_TYPE_PINNED_CASE_CHAT_MESSAGE
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][2]
new_valueCASE_STATUS_CHANGE
old_valueWALL_ACTIVITY_TYPE_CASE_STATUS_CHANGE
root['schemas']['QuickActionButton']['properties']['buttonColor']['enumDescriptions'][0]
new_valueThe button color is blue.
old_valueThe color is unspecified.
root['schemas']['CaseWallRecord']['properties']['activityType']['enumDescriptions'][10]
new_valuePinned case chat message activity type.
old_valueCase pinned chat message activity type.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][2]
new_valueCASE_STATUS_CHANGE
old_valueWALL_ACTIVITY_TYPE_CASE_STATUS_CHANGE
root['schemas']['ApiWorkflowCategoryDataModel']['properties']['categoryState']['enumDescriptions'][0]
new_valueThe category state is unspecified.
old_valueEmpty state.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][11]
new_valueCASE_LINK
old_valueWALL_ACTIVITY_TYPE_CASE_LINK
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][5]
new_valueCASE_EVIDENCE
old_valueWALL_ACTIVITY_TYPE_CASE_EVIDENCE
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][7]
new_valueCASE_INSIGHT
old_valueWALL_ACTIVITY_TYPE_CASE_INSIGHT
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][7]
new_valueCASE_INSIGHT
old_valueWALL_ACTIVITY_TYPE_CASE_INSIGHT
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][11]
new_valueCASE_LINK
old_valueWALL_ACTIVITY_TYPE_CASE_LINK
root['schemas']['ApiWorkflowCategoryDataModel']['properties']['categoryState']['enumDescriptions'][2]
new_valueThe category state is full.
old_valueFull state from restricted environment.
root['schemas']['FavoriteRequest']['properties']['activityType']['enumDescriptions'][10]
new_valuePinned case chat message activity type.
old_valueCase pinned chat message activity type.
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][8]
new_valueCASE_CREATION
old_valueWALL_ACTIVITY_TYPE_CASE_CREATION
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][1]
new_valueCASE_ALERT_DATA
old_valueWALL_ACTIVITY_TYPE_CASE_ALERT_DATA
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][10]
new_valuePINNED_CASE_CHAT_MESSAGE
old_valueWALL_ACTIVITY_TYPE_PINNED_CASE_CHAT_MESSAGE
root['schemas']['CaseWallRecord']['properties']['activityType']['enum'][1]
new_valueCASE_ALERT_DATA
old_valueWALL_ACTIVITY_TYPE_CASE_ALERT_DATA
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][8]
new_valueCASE_CREATION
old_valueWALL_ACTIVITY_TYPE_CASE_CREATION
root['schemas']['FavoriteRequest']['properties']['activityType']['enum'][3]
new_valueCASE_TASK
old_valueWALL_ACTIVITY_TYPE_CASE_TASK
root['schemas']['CaseWallRecord']['properties']['activityType']['enumDescriptions'][1]
new_valueCase alert data activity type.
old_valueAlert data activity type.
iterable_item_added
root['schemas']['AnalyticValue']['properties']['dimensions']['items']['enum'][36]LOG_TYPE
root['schemas']['AnalyticValue']['properties']['dimensions']['items']['enumDescriptions'][36]Log type.
root['schemas']['ApiWorkflowCategoryDataModel']['properties']['categoryState']['enum'][0]API_CATEGORY_STATE_UNSPECIFIED
root['schemas']['ApiWorkflowCategoryDataModel']['properties']['categoryState']['enumDescriptions'][3]The category state is full from a restricted environment.
root['schemas']['FavoriteRequest']['properties']['activityKind']['enum'][20]CUSTOM_FORM_CHANGES
root['schemas']['FavoriteRequest']['properties']['activityKind']['enum'][21]PLAYBOOK_ATTACHED
root['schemas']['FavoriteRequest']['properties']['activityKind']['enum'][22]ENTITY_ADDED
root['schemas']['FavoriteRequest']['properties']['activityKind']['enum'][23]PLAYBOOK_RERUN
root['schemas']['FavoriteRequest']['properties']['activityKind']['enum'][24]BLOCK_RERUN
root['schemas']['FavoriteRequest']['properties']['activityKind']['enumDescriptions'][20]Custom form changes activity kind.
root['schemas']['FavoriteRequest']['properties']['activityKind']['enumDescriptions'][21]Playbook attached activity kind.
root['schemas']['FavoriteRequest']['properties']['activityKind']['enumDescriptions'][22]Entity added activity kind.
root['schemas']['FavoriteRequest']['properties']['activityKind']['enumDescriptions'][23]Playbook rerun activity kind.
root['schemas']['FavoriteRequest']['properties']['activityKind']['enumDescriptions'][24]Block rerun activity kind.
root['schemas']['FieldProvenance']['properties']['logType']['enum'][1774]FORTINET_FORTINDR
root['schemas']['FieldProvenance']['properties']['logType']['enum'][2192]TORQ_AUDIT_LOGS
root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][1774]FORTINET_FORTINDR
root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2192]TORQ_AUDIT_LOGS
root['schemas']['LegacyPlaybookAddOrUpdatePlaybookCategoryRequest']['properties']['categoryState']['enum'][0]API_CATEGORY_STATE_UNSPECIFIED
root['schemas']['LegacyPlaybookAddOrUpdatePlaybookCategoryRequest']['properties']['categoryState']['enumDescriptions'][3]The category state is full from a restricted environment.
root['schemas']['MalachiteEnrichmentSource']['properties']['logType']['enum'][1774]FORTINET_FORTINDR
root['schemas']['MalachiteEnrichmentSource']['properties']['logType']['enum'][2192]TORQ_AUDIT_LOGS
root['schemas']['Metric']['properties']['dimensions']['items']['enum'][36]LOG_TYPE
root['schemas']['Metric']['properties']['dimensions']['items']['enumDescriptions'][36]Log type.
root['schemas']['Metric']['properties']['metricName']['enum'][39]UDM_DATA_PRESENCE_SUMMARY
root['schemas']['Metric']['properties']['metricName']['enumDescriptions'][39]UDM data summary tracking unique values of dimensions.
root['schemas']['RawLog']['properties']['type']['enum'][1774]FORTINET_FORTINDR
root['schemas']['RawLog']['properties']['type']['enum'][2192]TORQ_AUDIT_LOGS
root['schemas']['SIEventData']['properties']['rawLogType']['enum'][1774]FORTINET_FORTINDR
root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2192]TORQ_AUDIT_LOGS
root['schemas']['UserError']['properties']['reason']['enum'][25]UNIQUE_FIELD_CONFLICT
root['schemas']['UserError']['properties']['reason']['enumDescriptions'][25]The resource that the user is trying to create already exists. Example ErrorInfo: { "reason": "UNIQUE_FIELD_CONFLICT", "metadata": { "conflicting_fields": "[{\"field_name\": \"display_name\", \"value\": \"display_name\"}]" } }
iterable_item_removed
root['schemas']['QuickActionButton']['properties']['buttonColor']['enum'][0]QUICK_ACTION_BUTTON_COLOR_UNSPECIFIED
root['schemas']['QuickActionButton']['properties']['buttonColor']['enumDescriptions'][3]The color is red.
prod/us-chronicle-v1beta
values_changed
root['revision']
new_value20250717
old_value20250710
iterable_item_added
root['schemas']['Metric']['properties']['dimensions']['items']['enum'][36]LOG_TYPE
root['schemas']['Metric']['properties']['dimensions']['items']['enumDescriptions'][36]Log type.
root['schemas']['Metric']['properties']['metricName']['enum'][39]UDM_DATA_PRESENCE_SUMMARY
root['schemas']['Metric']['properties']['metricName']['enumDescriptions'][39]UDM data summary tracking unique values of dimensions.
root['schemas']['UserError']['properties']['reason']['enum'][25]UNIQUE_FIELD_CONFLICT
root['schemas']['UserError']['properties']['reason']['enumDescriptions'][25]The resource that the user is trying to create already exists. Example ErrorInfo: { "reason": "UNIQUE_FIELD_CONFLICT", "metadata": { "conflicting_fields": "[{\"field_name\": \"display_name\", \"value\": \"display_name\"}]" } }
prod/us-east4-connectgateway-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-east4-connectgateway-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-east4-connectgateway-v1beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-east4-containerfilesystem-
values_changed
root['revision']
new_value20250719
old_value20250714
prod/us-east4-containerfilesystem-v1
values_changed
root['revision']
new_value20250719
old_value20250714
prod/us-rbmopenmaap-
values_changed
root['revision']
new_value20250724
old_value20250721
prod/us-rbmopenmaap-v1
values_changed
root['revision']
new_value20250724
old_value20250721
prod/us-west1-connectgateway-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-west1-connectgateway-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-west1-connectgateway-v1beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-west1-containerfilesystem-
values_changed
root['revision']
new_value20250719
old_value20250714
prod/us-west1-containerfilesystem-v1
values_changed
root['revision']
new_value20250719
old_value20250714
prod/us-west2-dataproccontrol-
values_changed
root['revision']
new_value20250717
old_value20250624
prod/us-west2-dataproccontrol-v1
values_changed
root['revision']
new_value20250717
old_value20250624
prod/us-west3-containerfilesystem-
values_changed
root['revision']
new_value20250719
old_value20250714
prod/us-west3-containerfilesystem-v1
values_changed
root['revision']
new_value20250719
old_value20250714
prod/us-west3-dataproccontrol-
values_changed
root['revision']
new_value20250717
old_value20250624
prod/us-west4-connectgateway-
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-west4-connectgateway-v1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-west4-connectgateway-v1beta1
values_changed
root['revision']
new_value20250718
old_value20250711
prod/us-west4-containerfilesystem-
values_changed
root['revision']
new_value20250719
old_value20250714
prod/us-west4-containerfilesystem-v1
values_changed
root['revision']
new_value20250719
old_value20250714
prod/userlocation-
values_changed
root['revision']
new_value20250722
old_value20250715
prod/userlocation-v1
values_changed
root['revision']
new_value20250722
old_value20250715
prod/vectortile-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/vectortile-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/workflow-
values_changed
root['revision']
new_value20250723
old_value20250721
prod/workflow-v1
values_changed
root['revision']
new_value20250723
old_value20250721
prod/workloadcertificate-
values_changed
root['revision']
new_value20240103
old_value20240117
prod/workspaceui-pa-
values_changed
root['revision']
new_value20250721
old_value20250716
prod/workspaceui-pa-v1
values_changed
root['revision']
new_value20250721
old_value20250716
prod/workspacevideo-pa-
values_changed
root['revision']
new_value20250723
old_value20250720
prod/workspacevideo-pa-v1
values_changed
root['revision']
new_value20250723
old_value20250720
prod/youtubeembeddedplayer-
dictionary_item_added
  • root['schemas']['GoogleYoutubeEmbeddedplayerV1beta1VerifyHostAppRequest']['properties']['enableEncEnforcementForNocookieOnYt']
  • root['schemas']['GoogleYoutubeEmbeddedplayerV1beta1VerifyHostAppRequest']['properties']['enableDataBindingEnforcement']['deprecated']
  • root['schemas']['GoogleYoutubeEmbeddedplayerV1beta1VerifyHostAppRequest']['properties']['enableEncEnforcementForSharePanel']['deprecated']
values_changed
root['revision']
new_value20250723
old_value20250716
root['schemas']['GoogleYoutubeEmbeddedplayerV1beta1VerifyHostAppRequest']['description']
new_valueRequest message for YouTubeWatchEmbeddedPlayerService.VerifyHostApp. NEXT ID: 39
old_valueRequest message for YouTubeWatchEmbeddedPlayerService.VerifyHostApp. NEXT ID: 38
prod/youtubeembeddedplayer-v1beta1
dictionary_item_added
  • root['schemas']['GoogleYoutubeEmbeddedplayerV1beta1VerifyHostAppRequest']['properties']['enableEncEnforcementForNocookieOnYt']
  • root['schemas']['GoogleYoutubeEmbeddedplayerV1beta1VerifyHostAppRequest']['properties']['enableDataBindingEnforcement']['deprecated']
  • root['schemas']['GoogleYoutubeEmbeddedplayerV1beta1VerifyHostAppRequest']['properties']['enableEncEnforcementForSharePanel']['deprecated']
values_changed
root['revision']
new_value20250723
old_value20250716
root['schemas']['GoogleYoutubeEmbeddedplayerV1beta1VerifyHostAppRequest']['description']
new_valueRequest message for YouTubeWatchEmbeddedPlayerService.VerifyHostApp. NEXT ID: 39
old_valueRequest message for YouTubeWatchEmbeddedPlayerService.VerifyHostApp. NEXT ID: 38
prod/youtubeoembed-
values_changed
root['revision']
new_value20250723
old_value20250716
prod/youtubeoembed-v1
values_changed
root['revision']
new_value20250723
old_value20250716