From 3af1f66c5322e33b0d6d79ec98b5b9a5b956156b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 20 Sep 2023 19:36:44 +0000 Subject: [PATCH] feat(workloadmanager): update the API #### workloadmanager:v1 The following keys were added: - schemas.SapDiscovery.properties.systemId.readOnly The following keys were changed: - schemas.Insight.properties.sapDiscovery.description - schemas.Insight.properties.sapValidation.description - schemas.Operation.properties.response.description - schemas.SapDiscovery.description - schemas.SapDiscovery.properties.applicationLayer.description - schemas.SapDiscovery.properties.databaseLayer.description - schemas.SapDiscovery.properties.metadata.description - schemas.SapDiscovery.properties.systemId.description - schemas.SapDiscovery.properties.updateTime.description - schemas.SapDiscoveryComponent.properties.hostProject.description - schemas.SapDiscoveryComponent.properties.resources.description - schemas.SapDiscoveryComponent.properties.sid.description - schemas.SapDiscoveryComponentApplicationProperties.properties.ascsUri.description - schemas.SapDiscoveryMetadata.properties.customerRegion.description - schemas.SapDiscoveryMetadata.properties.definedSystem.description - schemas.SapDiscoveryMetadata.properties.environmentType.description - schemas.SapDiscoveryMetadata.properties.sapProduct.description - schemas.SapDiscoveryResource.properties.relatedResources.description - schemas.SapDiscoveryResource.properties.resourceUri.description - schemas.SapDiscoveryResource.properties.updateTime.description - schemas.SapValidation.properties.validationDetails.description - schemas.SapValidationValidationDetail.properties.details.description - schemas.SapValidationValidationDetail.properties.sapValidationType.description - schemas.SapValidationValidationDetail.properties.sapValidationType.enum - schemas.SapValidationValidationDetail.properties.sapValidationType.enumDescriptions - schemas.SqlserverValidation.properties.agentVersion.description - schemas.SqlserverValidation.properties.validationDetails.description - schemas.SqlserverValidationValidationDetail.properties.type.description - schemas.SqlserverValidationValidationDetail.properties.type.enum - schemas.SqlserverValidationValidationDetail.properties.type.enumDescriptions --- discovery/workloadmanager-v1.json | 81 ++++++++++++++++++------------- src/apis/workloadmanager/v1.ts | 52 ++++++++++---------- 2 files changed, 72 insertions(+), 61 deletions(-) diff --git a/discovery/workloadmanager-v1.json b/discovery/workloadmanager-v1.json index e9b2bd0723..76b7c0ba63 100644 --- a/discovery/workloadmanager-v1.json +++ b/discovery/workloadmanager-v1.json @@ -707,7 +707,7 @@ } } }, - "revision": "20230724", + "revision": "20230907", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -915,11 +915,11 @@ }, "sapDiscovery": { "$ref": "SapDiscovery", - "description": "The insights data for sap system discovery. This is a copy of SAP System proto and should get updated whenever that one changes." + "description": "The insights data for SAP system discovery. This is a copy of SAP System proto and should get updated whenever that one changes." }, "sapValidation": { "$ref": "SapValidation", - "description": "The insights data for the sap workload validation." + "description": "The insights data for the SAP workload validation." }, "sentTime": { "description": "Output only. [Output only] Create time stamp", @@ -1137,7 +1137,7 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. 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`.", + "description": "The 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`.", "type": "object" } }, @@ -1337,27 +1337,28 @@ "type": "object" }, "SapDiscovery": { - "description": "LINT.IfChange The schema of SAP system discovery data.", + "description": "The schema of SAP system discovery data.", "id": "SapDiscovery", "properties": { "applicationLayer": { "$ref": "SapDiscoveryComponent", - "description": "An SAP system may run without an application layer." + "description": "Optional. An SAP system may run without an application layer." }, "databaseLayer": { "$ref": "SapDiscoveryComponent", - "description": "An SAP System must have a database." + "description": "Required. An SAP System must have a database." }, "metadata": { "$ref": "SapDiscoveryMetadata", - "description": "The metadata for SAP system discovery data." + "description": "Optional. The metadata for SAP system discovery data." }, "systemId": { - "description": "A combination of database SID, database instance URI and tenant DB name to make a unique identifier per-system.", + "description": "Output only. A combination of database SID, database instance URI and tenant DB name to make a unique identifier per-system.", + "readOnly": true, "type": "string" }, "updateTime": { - "description": "Unix timestamp this system has been updated last.", + "description": "Required. Unix timestamp this system has been updated last.", "format": "google-datetime", "type": "string" } @@ -1377,18 +1378,18 @@ "description": "Optional. The component is a SAP database." }, "hostProject": { - "description": "Pantheon Project in which the resources reside.", + "description": "Required. Pantheon Project in which the resources reside.", "type": "string" }, "resources": { - "description": "The resources in a component.", + "description": "Optional. The resources in a component.", "items": { "$ref": "SapDiscoveryResource" }, "type": "array" }, "sid": { - "description": "The sap identifier, used by the SAP software and helps differentiate systems for customers.", + "description": "Optional. The SAP identifier, used by the SAP software and helps differentiate systems for customers.", "type": "string" } }, @@ -1411,7 +1412,7 @@ "type": "string" }, "ascsUri": { - "description": "Required. Resource URI of the recognized ASCS host of the application.", + "description": "Optional. Resource URI of the recognized ASCS host of the application.", "type": "string" }, "nfsUri": { @@ -1457,19 +1458,19 @@ "id": "SapDiscoveryMetadata", "properties": { "customerRegion": { - "description": "Customer region string for customer's use. Does not represent GCP region.", + "description": "Optional. Customer region string for customer's use. Does not represent GCP region.", "type": "string" }, "definedSystem": { - "description": "Customer defined, something like \"E-commerce pre prod\"", + "description": "Optional. Customer defined, something like \"E-commerce pre prod\"", "type": "string" }, "environmentType": { - "description": "Should be \"prod\", \"QA\", \"dev\", \"staging\", etc.", + "description": "Optional. Should be \"prod\", \"QA\", \"dev\", \"staging\", etc.", "type": "string" }, "sapProduct": { - "description": "This sap product name", + "description": "Optional. This SAP product name", "type": "string" } }, @@ -1480,7 +1481,7 @@ "id": "SapDiscoveryResource", "properties": { "relatedResources": { - "description": "A list of resource URIs related to this resource.", + "description": "Optional. A list of resource URIs related to this resource.", "items": { "type": "string" }, @@ -1535,11 +1536,11 @@ "type": "string" }, "resourceUri": { - "description": "URI of the resource, includes project, location, and name.", + "description": "Required. URI of the resource, includes project, location, and name.", "type": "string" }, "updateTime": { - "description": "Unix timestamp of when this resource last had its discovery data updated.", + "description": "Required. Unix timestamp of when this resource last had its discovery data updated.", "format": "google-datetime", "type": "string" } @@ -1551,7 +1552,7 @@ "id": "SapValidation", "properties": { "validationDetails": { - "description": "A list of SAP validation metrics data.", + "description": "Optional. A list of SAP validation metrics data.", "items": { "$ref": "SapValidationValidationDetail" }, @@ -1568,26 +1569,30 @@ "additionalProperties": { "type": "string" }, - "description": "The pairs of metrics data: field name & field value.", + "description": "Optional. The pairs of metrics data: field name & field value.", "type": "object" }, "sapValidationType": { - "description": "The SAP system that the validation data is from.", + "description": "Optional. The SAP system that the validation data is from.", "enum": [ "SAP_VALIDATION_TYPE_UNSPECIFIED", "SYSTEM", "COROSYNC", "PACEMAKER", "HANA", - "NETWEAVER" + "NETWEAVER", + "HANA_SECURITY", + "CUSTOM" ], "enumDescriptions": [ "Unspecified type.", - "The SAP system named SYSTEM.", - "The SAP system named COROSYNC.", - "The SAP system named PACEMAKER.", - "The SAP system named HANA.", - "The SAP system named NETWEAVER." + "The SYSTEM validation type collects underlying system data from the VM.", + "The COROSYNC validation type collects Corosync configuration and runtime data. Corosync enables servers to interact as a HA cluster.", + "The PACEMAKER validation type collects Pacemaker configuration data. Pacemaker is a high-availability cluster resource manager.", + "The HANA validation type collects HANA configuration data. SAP HANA is an in-memory, column-oriented, relational database management system.", + "The NETWEAVER validation type collects NetWeaver configuration data. SAP NetWeaver is a software stack for many of SAP SE's applications.", + "The HANA_SECURITY validation type collects HANA configuration data as it relates to SAP security best practices.", + "The CUSTOM validation type collects any customer-defined data that does not fall into any of the other categories of validations." ], "type": "string" } @@ -1610,7 +1615,7 @@ "id": "SqlserverValidation", "properties": { "agentVersion": { - "description": "The agent version collected this data point", + "description": "Optional. The agent version collected this data point", "type": "string" }, "instance": { @@ -1622,7 +1627,7 @@ "type": "string" }, "validationDetails": { - "description": "A list of SqlServer validation metrics data.", + "description": "Optional. A list of SqlServer validation metrics data.", "items": { "$ref": "SqlserverValidationValidationDetail" }, @@ -1657,7 +1662,7 @@ "type": "array" }, "type": { - "description": "The Sqlserver system that the validation data is from.", + "description": "Optional. The Sqlserver system that the validation data is from.", "enum": [ "SQLSERVER_VALIDATION_TYPE_UNSPECIFIED", "OS", @@ -1668,7 +1673,10 @@ "DB_VIRTUAL_LOG_FILE_COUNT", "DB_BUFFER_POOL_EXTENSION", "DB_MAX_SERVER_MEMORY", - "INSTANCE_METRICS" + "INSTANCE_METRICS", + "DB_INDEX_FRAGMENTATION", + "DB_TABLE_INDEX_COMPRESSION", + "DB_BACKUP_POLICY" ], "enumDescriptions": [ "Unspecified type.", @@ -1680,7 +1688,10 @@ "The VIRTUAL_LOG_FILE_COUNT table.", "The BUFFER_POOL_EXTENSION table.", "The MAX_SERVER_MEMORY table.", - "The INSTANCE_METRICS table." + "The INSTANCE_METRICS table.", + "The DB_INDEX_FRAGMENTATION table.", + "The DB_TABLE_INDEX_COMPRESSION table.", + "The DB_BACKUP_POLICY table." ], "type": "string" } diff --git a/src/apis/workloadmanager/v1.ts b/src/apis/workloadmanager/v1.ts index 990bfa936d..156acfe7b9 100644 --- a/src/apis/workloadmanager/v1.ts +++ b/src/apis/workloadmanager/v1.ts @@ -265,11 +265,11 @@ export namespace workloadmanager_v1 { */ instanceId?: string | null; /** - * The insights data for sap system discovery. This is a copy of SAP System proto and should get updated whenever that one changes. + * The insights data for SAP system discovery. This is a copy of SAP System proto and should get updated whenever that one changes. */ sapDiscovery?: Schema$SapDiscovery; /** - * The insights data for the sap workload validation. + * The insights data for the SAP workload validation. */ sapValidation?: Schema$SapValidation; /** @@ -426,7 +426,7 @@ export namespace workloadmanager_v1 { */ name?: string | null; /** - * The normal response of the operation in case of success. 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`. + * The 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`. */ response?: {[key: string]: any} | null; } @@ -577,27 +577,27 @@ export namespace workloadmanager_v1 { requestId?: string | null; } /** - * LINT.IfChange The schema of SAP system discovery data. + * The schema of SAP system discovery data. */ export interface Schema$SapDiscovery { /** - * An SAP system may run without an application layer. + * Optional. An SAP system may run without an application layer. */ applicationLayer?: Schema$SapDiscoveryComponent; /** - * An SAP System must have a database. + * Required. An SAP System must have a database. */ databaseLayer?: Schema$SapDiscoveryComponent; /** - * The metadata for SAP system discovery data. + * Optional. The metadata for SAP system discovery data. */ metadata?: Schema$SapDiscoveryMetadata; /** - * A combination of database SID, database instance URI and tenant DB name to make a unique identifier per-system. + * Output only. A combination of database SID, database instance URI and tenant DB name to make a unique identifier per-system. */ systemId?: string | null; /** - * Unix timestamp this system has been updated last. + * Required. Unix timestamp this system has been updated last. */ updateTime?: string | null; } @@ -614,15 +614,15 @@ export namespace workloadmanager_v1 { */ databaseProperties?: Schema$SapDiscoveryComponentDatabaseProperties; /** - * Pantheon Project in which the resources reside. + * Required. Pantheon Project in which the resources reside. */ hostProject?: string | null; /** - * The resources in a component. + * Optional. The resources in a component. */ resources?: Schema$SapDiscoveryResource[]; /** - * The sap identifier, used by the SAP software and helps differentiate systems for customers. + * Optional. The SAP identifier, used by the SAP software and helps differentiate systems for customers. */ sid?: string | null; } @@ -635,7 +635,7 @@ export namespace workloadmanager_v1 { */ applicationType?: string | null; /** - * Required. Resource URI of the recognized ASCS host of the application. + * Optional. Resource URI of the recognized ASCS host of the application. */ ascsUri?: string | null; /** @@ -665,19 +665,19 @@ export namespace workloadmanager_v1 { */ export interface Schema$SapDiscoveryMetadata { /** - * Customer region string for customer's use. Does not represent GCP region. + * Optional. Customer region string for customer's use. Does not represent GCP region. */ customerRegion?: string | null; /** - * Customer defined, something like "E-commerce pre prod" + * Optional. Customer defined, something like "E-commerce pre prod" */ definedSystem?: string | null; /** - * Should be "prod", "QA", "dev", "staging", etc. + * Optional. Should be "prod", "QA", "dev", "staging", etc. */ environmentType?: string | null; /** - * This sap product name + * Optional. This SAP product name */ sapProduct?: string | null; } @@ -686,7 +686,7 @@ export namespace workloadmanager_v1 { */ export interface Schema$SapDiscoveryResource { /** - * A list of resource URIs related to this resource. + * Optional. A list of resource URIs related to this resource. */ relatedResources?: string[] | null; /** @@ -698,11 +698,11 @@ export namespace workloadmanager_v1 { */ resourceType?: string | null; /** - * URI of the resource, includes project, location, and name. + * Required. URI of the resource, includes project, location, and name. */ resourceUri?: string | null; /** - * Unix timestamp of when this resource last had its discovery data updated. + * Required. Unix timestamp of when this resource last had its discovery data updated. */ updateTime?: string | null; } @@ -711,7 +711,7 @@ export namespace workloadmanager_v1 { */ export interface Schema$SapValidation { /** - * A list of SAP validation metrics data. + * Optional. A list of SAP validation metrics data. */ validationDetails?: Schema$SapValidationValidationDetail[]; } @@ -720,11 +720,11 @@ export namespace workloadmanager_v1 { */ export interface Schema$SapValidationValidationDetail { /** - * The pairs of metrics data: field name & field value. + * Optional. The pairs of metrics data: field name & field value. */ details?: {[key: string]: string} | null; /** - * The SAP system that the validation data is from. + * Optional. The SAP system that the validation data is from. */ sapValidationType?: string | null; } @@ -742,7 +742,7 @@ export namespace workloadmanager_v1 { */ export interface Schema$SqlserverValidation { /** - * The agent version collected this data point + * Optional. The agent version collected this data point */ agentVersion?: string | null; /** @@ -754,7 +754,7 @@ export namespace workloadmanager_v1 { */ projectId?: string | null; /** - * A list of SqlServer validation metrics data. + * Optional. A list of SqlServer validation metrics data. */ validationDetails?: Schema$SqlserverValidationValidationDetail[]; } @@ -776,7 +776,7 @@ export namespace workloadmanager_v1 { */ details?: Schema$SqlserverValidationDetails[]; /** - * The Sqlserver system that the validation data is from. + * Optional. The Sqlserver system that the validation data is from. */ type?: string | null; }