diff --git a/discovery/workloadmanager-v1.json b/discovery/workloadmanager-v1.json index fbaa2d0f87..9cdf61eb6f 100644 --- a/discovery/workloadmanager-v1.json +++ b/discovery/workloadmanager-v1.json @@ -772,7 +772,7 @@ } } }, - "revision": "20240821", + "revision": "20241016", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "AgentCommand": { @@ -793,42 +793,6 @@ }, "type": "object" }, - "AssetLocation": { - "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", - "id": "AssetLocation", - "properties": { - "ccfeRmsPath": { - "description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", - "type": "string" - }, - "expected": { - "$ref": "IsolationExpectations", - "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." - }, - "extraParameters": { - "description": "Defines extra parameters required for specific asset types.", - "items": { - "$ref": "ExtraParameter" - }, - "type": "array" - }, - "locationData": { - "description": "Contains all kinds of physical location definitions for this asset.", - "items": { - "$ref": "LocationData" - }, - "type": "array" - }, - "parentAsset": { - "description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", - "items": { - "$ref": "CloudAsset" - }, - "type": "array" - } - }, - "type": "object" - }, "BigQueryDestination": { "description": "Message describing big query destination", "id": "BigQueryDestination", @@ -844,49 +808,12 @@ }, "type": "object" }, - "BlobstoreLocation": { - "description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", - "id": "BlobstoreLocation", - "properties": { - "policyId": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, - "CloudAsset": { - "id": "CloudAsset", - "properties": { - "assetName": { - "type": "string" - }, - "assetType": { - "type": "string" - } - }, - "type": "object" - }, - "CloudAssetComposition": { - "id": "CloudAssetComposition", - "properties": { - "childAsset": { - "items": { - "$ref": "CloudAsset" - }, - "type": "array" - } - }, - "type": "object" - }, "Command": { "description": "* Command specifies the type of command to execute.", "id": "Command", @@ -902,18 +829,6 @@ }, "type": "object" }, - "DirectLocationAssignment": { - "id": "DirectLocationAssignment", - "properties": { - "location": { - "items": { - "$ref": "LocationAssignment" - }, - "type": "array" - } - }, - "type": "object" - }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -1029,6 +944,22 @@ "description": "The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}", "type": "string" }, + "notices": { + "description": "Output only. Additional information generated by the execution", + "items": { + "$ref": "Notice" + }, + "readOnly": true, + "type": "array" + }, + "ruleResults": { + "description": "Output only. execution result summary per rule", + "items": { + "$ref": "RuleExecutionResult" + }, + "readOnly": true, + "type": "array" + }, "runType": { "description": "type represent whether the execution executed directly by user or scheduled according evaluation.schedule field.", "enum": [ @@ -1096,6 +1027,20 @@ "description": "The severity of violation.", "type": "string" }, + "type": { + "description": "Execution result type of the scanned resource", + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_PASSED", + "TYPE_VIOLATED" + ], + "enumDescriptions": [ + "Unknown state", + "resource successfully passed the rule", + "resource violated the rule" + ], + "type": "string" + }, "violationDetails": { "$ref": "ViolationDetails", "description": "The details of violation in an evaluation result." @@ -1138,17 +1083,6 @@ }, "type": "object" }, - "ExtraParameter": { - "description": "Defines parameters that should only be used for specific asset types.", - "id": "ExtraParameter", - "properties": { - "regionalMigDistributionPolicy": { - "$ref": "RegionalMigDistributionPolicy", - "description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." - } - }, - "type": "object" - }, "GceInstanceFilter": { "description": "Message describing compute engine instance filter", "id": "GceInstanceFilter", @@ -1192,131 +1126,6 @@ }, "type": "object" }, - "IsolationExpectations": { - "id": "IsolationExpectations", - "properties": { - "requirementOverride": { - "$ref": "RequirementOverride", - "description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." - }, - "ziOrgPolicy": { - "enum": [ - "ZI_UNSPECIFIED", - "ZI_UNKNOWN", - "ZI_NOT_REQUIRED", - "ZI_PREFERRED", - "ZI_REQUIRED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "", - "" - ], - "type": "string" - }, - "ziRegionPolicy": { - "enum": [ - "ZI_REGION_POLICY_UNSPECIFIED", - "ZI_REGION_POLICY_UNKNOWN", - "ZI_REGION_POLICY_NOT_SET", - "ZI_REGION_POLICY_FAIL_OPEN", - "ZI_REGION_POLICY_FAIL_CLOSED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "", - "" - ], - "type": "string" - }, - "ziRegionState": { - "enum": [ - "ZI_REGION_UNSPECIFIED", - "ZI_REGION_UNKNOWN", - "ZI_REGION_NOT_ENABLED", - "ZI_REGION_ENABLED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "" - ], - "type": "string" - }, - "zoneIsolation": { - "deprecated": true, - "description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", - "enum": [ - "ZI_UNSPECIFIED", - "ZI_UNKNOWN", - "ZI_NOT_REQUIRED", - "ZI_PREFERRED", - "ZI_REQUIRED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "", - "" - ], - "type": "string" - }, - "zoneSeparation": { - "deprecated": true, - "description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", - "enum": [ - "ZS_UNSPECIFIED", - "ZS_UNKNOWN", - "ZS_NOT_REQUIRED", - "ZS_REQUIRED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "" - ], - "type": "string" - }, - "zsOrgPolicy": { - "enum": [ - "ZS_UNSPECIFIED", - "ZS_UNKNOWN", - "ZS_NOT_REQUIRED", - "ZS_REQUIRED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "" - ], - "type": "string" - }, - "zsRegionState": { - "enum": [ - "ZS_REGION_UNSPECIFIED", - "ZS_REGION_UNKNOWN", - "ZS_REGION_NOT_ENABLED", - "ZS_REGION_ENABLED" - ], - "enumDescriptions": [ - "", - "To be used if tracking of the asset ZS-bit is not available", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, "ListEvaluationsResponse": { "description": "Message for response to listing Evaluations", "id": "ListEvaluationsResponse", @@ -1491,64 +1300,18 @@ }, "type": "object" }, - "LocationAssignment": { - "id": "LocationAssignment", + "Notice": { + "description": "Message for additional information generated by the execution", + "id": "Notice", "properties": { - "location": { - "type": "string" - }, - "locationType": { - "enum": [ - "UNSPECIFIED", - "CLUSTER", - "POP", - "CLOUD_ZONE", - "CLOUD_REGION", - "MULTI_REGION_GEO", - "MULTI_REGION_JURISDICTION", - "GLOBAL", - "OTHER" - ], - "enumDescriptions": [ - "", - "1-10: Physical failure domains.", - "", - "11-20: Logical failure domains.", - "", - "", - "", - "", - "" - ], + "message": { + "description": "Output only. Message of the notice", + "readOnly": true, "type": "string" } }, "type": "object" }, - "LocationData": { - "id": "LocationData", - "properties": { - "blobstoreLocation": { - "$ref": "BlobstoreLocation" - }, - "childAssetLocation": { - "$ref": "CloudAssetComposition" - }, - "directLocation": { - "$ref": "DirectLocationAssignment" - }, - "gcpProjectProxy": { - "$ref": "TenantProjectProxy" - }, - "placerLocation": { - "$ref": "PlacerLocation" - }, - "spannerLocation": { - "$ref": "SpannerLocation" - } - }, - "type": "object" - }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -1628,74 +1391,6 @@ }, "type": "object" }, - "PlacerLocation": { - "description": "Message describing that the location of the customer resource is tied to placer allocations", - "id": "PlacerLocation", - "properties": { - "placerConfig": { - "description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", - "type": "string" - } - }, - "type": "object" - }, - "RegionalMigDistributionPolicy": { - "description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", - "id": "RegionalMigDistributionPolicy", - "properties": { - "targetShape": { - "description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", - "format": "int32", - "type": "integer" - }, - "zones": { - "description": "Cloud zones used by regional MIG to create instances.", - "items": { - "$ref": "ZoneConfiguration" - }, - "type": "array" - } - }, - "type": "object" - }, - "RequirementOverride": { - "id": "RequirementOverride", - "properties": { - "ziOverride": { - "enum": [ - "ZI_UNSPECIFIED", - "ZI_UNKNOWN", - "ZI_NOT_REQUIRED", - "ZI_PREFERRED", - "ZI_REQUIRED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "", - "" - ], - "type": "string" - }, - "zsOverride": { - "enum": [ - "ZS_UNSPECIFIED", - "ZS_UNKNOWN", - "ZS_NOT_REQUIRED", - "ZS_REQUIRED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, "Resource": { "description": "Message represent resource in execution result", "id": "Resource", @@ -1833,6 +1528,48 @@ }, "type": "object" }, + "RuleExecutionResult": { + "description": "Message for execution result summary per rule", + "id": "RuleExecutionResult", + "properties": { + "message": { + "description": "Execution message, if any", + "type": "string" + }, + "resultCount": { + "description": "Number of violations", + "format": "int64", + "type": "string" + }, + "rule": { + "description": "rule name", + "type": "string" + }, + "scannedResourceCount": { + "description": "Number of total scanned resources", + "format": "int64", + "type": "string" + }, + "state": { + "description": "Output only. The execution status", + "enum": [ + "STATE_UNSPECIFIED", + "STATE_SUCCESS", + "STATE_FAILURE", + "STATE_SKIPPED" + ], + "enumDescriptions": [ + "Unknown state", + "execution completed successfully", + "execution completed with failures", + "execution was not executed" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "RunEvaluationRequest": { "description": "Message for creating a Execution", "id": "RunEvaluationRequest", @@ -2204,6 +1941,10 @@ ], "type": "string" }, + "isDrSite": { + "description": "Optional. Instance is part of a DR site.", + "type": "boolean" + }, "virtualHostname": { "description": "Optional. A virtual hostname of the instance if it has one.", "type": "string" @@ -2384,26 +2125,6 @@ }, "type": "object" }, - "SpannerLocation": { - "id": "SpannerLocation", - "properties": { - "backupName": { - "description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", - "items": { - "type": "string" - }, - "type": "array" - }, - "dbName": { - "description": "Set of databases used by the resource in format /span//", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "SqlserverValidation": { "description": "A presentation of SQLServer workload insight. The schema of SqlServer workloads validation related data.", "id": "SqlserverValidation", @@ -2519,18 +2240,6 @@ }, "type": "object" }, - "TenantProjectProxy": { - "id": "TenantProjectProxy", - "properties": { - "projectNumbers": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "ViolationDetails": { "description": "Message describing the violation in an evaluation result.", "id": "ViolationDetails", @@ -2577,15 +2286,6 @@ "id": "WriteInsightResponse", "properties": {}, "type": "object" - }, - "ZoneConfiguration": { - "id": "ZoneConfiguration", - "properties": { - "zone": { - "type": "string" - } - }, - "type": "object" } }, "servicePath": "", diff --git a/src/apis/workloadmanager/v1.ts b/src/apis/workloadmanager/v1.ts index deb479ccaf..6493efd1ac 100644 --- a/src/apis/workloadmanager/v1.ts +++ b/src/apis/workloadmanager/v1.ts @@ -137,31 +137,6 @@ export namespace workloadmanager_v1 { */ parameters?: {[key: string]: string} | null; } - /** - * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. - */ - export interface Schema$AssetLocation { - /** - * Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata. - */ - ccfeRmsPath?: string | null; - /** - * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. - */ - expected?: Schema$IsolationExpectations; - /** - * Defines extra parameters required for specific asset types. - */ - extraParameters?: Schema$ExtraParameter[]; - /** - * Contains all kinds of physical location definitions for this asset. - */ - locationData?: Schema$LocationData[]; - /** - * Defines parents assets if any in order to allow later generation of child_asset_location data via child assets. - */ - parentAsset?: Schema$CloudAsset[]; - } /** * Message describing big query destination */ @@ -175,23 +150,10 @@ export namespace workloadmanager_v1 { */ destinationDataset?: string | null; } - /** - * Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains - */ - export interface Schema$BlobstoreLocation { - policyId?: string[] | null; - } /** * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} - export interface Schema$CloudAsset { - assetName?: string | null; - assetType?: string | null; - } - export interface Schema$CloudAssetComposition { - childAsset?: Schema$CloudAsset[]; - } /** * * Command specifies the type of command to execute. */ @@ -205,9 +167,6 @@ export namespace workloadmanager_v1 { */ shellCommand?: Schema$ShellCommand; } - export interface Schema$DirectLocationAssignment { - location?: Schema$LocationAssignment[]; - } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ @@ -293,6 +252,14 @@ export namespace workloadmanager_v1 { * The name of execution resource. The format is projects/{project\}/locations/{location\}/evaluations/{evaluation\}/executions/{execution\} */ name?: string | null; + /** + * Output only. Additional information generated by the execution + */ + notices?: Schema$Notice[]; + /** + * Output only. execution result summary per rule + */ + ruleResults?: Schema$RuleExecutionResult[]; /** * type represent whether the execution executed directly by user or scheduled according evaluation.schedule field. */ @@ -330,6 +297,10 @@ export namespace workloadmanager_v1 { * The severity of violation. */ severity?: string | null; + /** + * Execution result type of the scanned resource + */ + type?: string | null; /** * The details of violation in an evaluation result. */ @@ -360,15 +331,6 @@ export namespace workloadmanager_v1 { */ uri?: string | null; } - /** - * Defines parameters that should only be used for specific asset types. - */ - export interface Schema$ExtraParameter { - /** - * Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances. - */ - regionalMigDistributionPolicy?: Schema$RegionalMigDistributionPolicy; - } /** * Message describing compute engine instance filter */ @@ -403,25 +365,6 @@ export namespace workloadmanager_v1 { */ sqlserverValidation?: Schema$SqlserverValidation; } - export interface Schema$IsolationExpectations { - /** - * Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic. - */ - requirementOverride?: Schema$RequirementOverride; - ziOrgPolicy?: string | null; - ziRegionPolicy?: string | null; - ziRegionState?: string | null; - /** - * Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location. - */ - zoneIsolation?: string | null; - /** - * Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location. - */ - zoneSeparation?: string | null; - zsOrgPolicy?: string | null; - zsRegionState?: string | null; - } /** * Message for response to listing Evaluations */ @@ -546,17 +489,14 @@ export namespace workloadmanager_v1 { */ name?: string | null; } - export interface Schema$LocationAssignment { - location?: string | null; - locationType?: string | null; - } - export interface Schema$LocationData { - blobstoreLocation?: Schema$BlobstoreLocation; - childAssetLocation?: Schema$CloudAssetComposition; - directLocation?: Schema$DirectLocationAssignment; - gcpProjectProxy?: Schema$TenantProjectProxy; - placerLocation?: Schema$PlacerLocation; - spannerLocation?: Schema$SpannerLocation; + /** + * Message for additional information generated by the execution + */ + export interface Schema$Notice { + /** + * Output only. Message of the notice + */ + message?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -616,32 +556,6 @@ export namespace workloadmanager_v1 { */ verb?: string | null; } - /** - * Message describing that the location of the customer resource is tied to placer allocations - */ - export interface Schema$PlacerLocation { - /** - * Directory with a config related to it in placer (e.g. "/placer/prod/home/my-root/my-dir") - */ - placerConfig?: string | null; - } - /** - * To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances - */ - export interface Schema$RegionalMigDistributionPolicy { - /** - * The shape in which the group converges around distribution of resources. Instance of proto2 enum - */ - targetShape?: number | null; - /** - * Cloud zones used by regional MIG to create instances. - */ - zones?: Schema$ZoneConfiguration[]; - } - export interface Schema$RequirementOverride { - ziOverride?: string | null; - zsOverride?: string | null; - } /** * Message represent resource in execution result */ @@ -742,6 +656,31 @@ export namespace workloadmanager_v1 { */ uri?: string | null; } + /** + * Message for execution result summary per rule + */ + export interface Schema$RuleExecutionResult { + /** + * Execution message, if any + */ + message?: string | null; + /** + * Number of violations + */ + resultCount?: string | null; + /** + * rule name + */ + rule?: string | null; + /** + * Number of total scanned resources + */ + scannedResourceCount?: string | null; + /** + * Output only. The execution status + */ + state?: string | null; + } /** * Message for creating a Execution */ @@ -965,6 +904,10 @@ export namespace workloadmanager_v1 { * Optional. Bitmask of instance role, a resource may have multiple roles at once. */ instanceRole?: string | null; + /** + * Optional. Instance is part of a DR site. + */ + isDrSite?: boolean | null; /** * Optional. A virtual hostname of the instance if it has one. */ @@ -1094,16 +1037,6 @@ export namespace workloadmanager_v1 { */ timeoutSeconds?: number | null; } - export interface Schema$SpannerLocation { - /** - * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata - */ - backupName?: string[] | null; - /** - * Set of databases used by the resource in format /span// - */ - dbName?: string[] | null; - } /** * A presentation of SQLServer workload insight. The schema of SqlServer workloads validation related data. */ @@ -1164,9 +1097,6 @@ export namespace workloadmanager_v1 { */ message?: string | null; } - export interface Schema$TenantProjectProxy { - projectNumbers?: string[] | null; - } /** * Message describing the violation in an evaluation result. */ @@ -1205,9 +1135,6 @@ export namespace workloadmanager_v1 { * The response for write insights request. */ export interface Schema$WriteInsightResponse {} - export interface Schema$ZoneConfiguration { - zone?: string | null; - } export class Resource$Projects { context: APIRequestContext;