diff --git a/packages/google-cloud-servicehealth/README.md b/packages/google-cloud-servicehealth/README.md index 9b25b971fd0..977586fab96 100644 --- a/packages/google-cloud-servicehealth/README.md +++ b/packages/google-cloud-servicehealth/README.md @@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained]. 1. [Select or create a Cloud Platform project][projects]. 1. [Enable billing for your project][billing]. 1. [Enable the Service Health API API][enable_api]. -1. [Set up authentication with a service account][auth] so you can access the +1. [Set up authentication][auth] so you can access the API from your local workstation. ### Installing the client library @@ -215,4 +215,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE) [projects]: https://console.cloud.google.com/project [billing]: https://support.google.com/cloud/answer/6293499#enable-billing [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=servicehealth.googleapis.com -[auth]: https://cloud.google.com/docs/authentication/getting-started +[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local diff --git a/packages/google-cloud-servicehealth/protos/google/cloud/servicehealth/v1/event_resources.proto b/packages/google-cloud-servicehealth/protos/google/cloud/servicehealth/v1/event_resources.proto index 2c045b23de0..9bcf816a073 100644 --- a/packages/google-cloud-servicehealth/protos/google/cloud/servicehealth/v1/event_resources.proto +++ b/packages/google-cloud-servicehealth/protos/google/cloud/servicehealth/v1/event_resources.proto @@ -451,6 +451,7 @@ message Asset { string asset_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } +// Message for requesting list of events. message ListEventsRequest { // Required. Parent value using the form // `projects/{project_id}/locations/{location}/events`. @@ -484,7 +485,8 @@ message ListEventsRequest { // response. The expression takes the following forms:
// * field=value for `category` and `state`
// * field <, >, <=, or >= value for `update_time`
- // Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00` + // Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`, + // `event_impacts.product.product_name:"Eventarc"` //
// // Multiple filter queries are separated by spaces. Example: @@ -494,13 +496,14 @@ message ListEventsRequest { // AND and OR expressions explicitly. // // Filter is supported for the following fields: `category`, `state`, - // `update_time` + // `update_time`, `event_impacts.product.product_name` string filter = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. Event fields to include in response. EventView view = 6 [(google.api.field_behavior) = OPTIONAL]; } +// Message for response to listing events. message ListEventsResponse { // Output only. List of events. repeated Event events = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -516,7 +519,7 @@ message ListEventsResponse { repeated string unreachable = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Message for getting an event +// Message for getting an event. message GetEventRequest { // Required. Unique name of the event in this scope including project // and location using the form @@ -533,6 +536,7 @@ message GetEventRequest { ]; } +// Message for requesting list of organization events. message ListOrganizationEventsRequest { // Required. Parent value using the form // `organizations/{organization_id}/locations/{location}/organizationEvents`. @@ -573,7 +577,7 @@ message ListOrganizationEventsRequest { // * field=value for `category` and `state` // * field <, >, <=, or >= value for `update_time` // - // Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00` + // Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"` // // Multiple filter queries are space-separated. Example: // `category=INCIDENT state=ACTIVE`. @@ -589,6 +593,7 @@ message ListOrganizationEventsRequest { OrganizationEventView view = 6 [(google.api.field_behavior) = OPTIONAL]; } +// Message for response to listing organization events. message ListOrganizationEventsResponse { // Output only. List of organization events affecting an organization. repeated OrganizationEvent organization_events = 1 @@ -605,6 +610,7 @@ message ListOrganizationEventsResponse { repeated string unreachable = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } +// Message for getting an organization event. message GetOrganizationEventRequest { // Required. Unique name of the event in this scope including organization and // event ID using the form @@ -623,7 +629,7 @@ message GetOrganizationEventRequest { ]; } -// Message for requesting list of OrganizationImpacts +// Message for requesting list of organization impacts. message ListOrganizationImpactsRequest { // Required. Parent value using the form // `organizations/{organization_id}/locations/{location}/organizationImpacts`. @@ -677,6 +683,7 @@ message ListOrganizationImpactsRequest { string filter = 4 [(google.api.field_behavior) = OPTIONAL]; } +// Message for response to listing organization impacts. message ListOrganizationImpactsResponse { // Output only. List of // [impacts](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact) @@ -695,6 +702,7 @@ message ListOrganizationImpactsResponse { repeated string unreachable = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } +// Message for getting an organization impact. message GetOrganizationImpactRequest { // Required. Name of the resource using the form // `organizations/{organization_id}/locations/global/organizationImpacts/{organization_impact_id}`. diff --git a/packages/google-cloud-servicehealth/protos/protos.json b/packages/google-cloud-servicehealth/protos/protos.json index 85bb6af9617..f469cf5f91c 100644 --- a/packages/google-cloud-servicehealth/protos/protos.json +++ b/packages/google-cloud-servicehealth/protos/protos.json @@ -1,4 +1,7 @@ { + "options": { + "syntax": "proto3" + }, "nested": { "google": { "nested": { diff --git a/packages/google-cloud-servicehealth/samples/generated/v1/service_health.list_events.js b/packages/google-cloud-servicehealth/samples/generated/v1/service_health.list_events.js index 9bf1b72b5a4..15b94ac0e0f 100644 --- a/packages/google-cloud-servicehealth/samples/generated/v1/service_health.list_events.js +++ b/packages/google-cloud-servicehealth/samples/generated/v1/service_health.list_events.js @@ -58,14 +58,15 @@ function main(parent) { * response. The expression takes the following forms:
* * field=value for `category` and `state`
* * field <, >, <=, or >= value for `update_time`
- * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00` + * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`, + * `event_impacts.product.product_name:"Eventarc"` *
* Multiple filter queries are separated by spaces. Example: * `category=INCIDENT state=ACTIVE`. * By default, each expression is an AND expression. However, you can include * AND and OR expressions explicitly. * Filter is supported for the following fields: `category`, `state`, - * `update_time` + * `update_time`, `event_impacts.product.product_name` */ // const filter = 'abc123' /** diff --git a/packages/google-cloud-servicehealth/samples/generated/v1/service_health.list_organization_events.js b/packages/google-cloud-servicehealth/samples/generated/v1/service_health.list_organization_events.js index 7714b4bc5bc..f2f11bf7a6f 100644 --- a/packages/google-cloud-servicehealth/samples/generated/v1/service_health.list_organization_events.js +++ b/packages/google-cloud-servicehealth/samples/generated/v1/service_health.list_organization_events.js @@ -61,7 +61,7 @@ function main(parent) { * response. The expression takes the following forms: * * field=value for `category` and `state` * * field <, >, <=, or >= value for `update_time` - * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00` + * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"` * Multiple filter queries are space-separated. Example: * `category=INCIDENT state=ACTIVE`. * By default, each expression is an AND expression. However, you can include diff --git a/packages/google-cloud-servicehealth/samples/generated/v1/snippet_metadata_google.cloud.servicehealth.v1.json b/packages/google-cloud-servicehealth/samples/generated/v1/snippet_metadata_google.cloud.servicehealth.v1.json index 5f0f7d1449f..6a2b984d66f 100644 --- a/packages/google-cloud-servicehealth/samples/generated/v1/snippet_metadata_google.cloud.servicehealth.v1.json +++ b/packages/google-cloud-servicehealth/samples/generated/v1/snippet_metadata_google.cloud.servicehealth.v1.json @@ -22,7 +22,7 @@ "segments": [ { "start": 25, - "end": 95, + "end": 96, "type": "FULL" } ], diff --git a/packages/google-cloud-servicehealth/src/v1/service_health_client.ts b/packages/google-cloud-servicehealth/src/v1/service_health_client.ts index c7da5f46b6e..26a7354a95b 100644 --- a/packages/google-cloud-servicehealth/src/v1/service_health_client.ts +++ b/packages/google-cloud-servicehealth/src/v1/service_health_client.ts @@ -739,7 +739,8 @@ export class ServiceHealthClient { * response. The expression takes the following forms:
* * field=value for `category` and `state`
* * field <, >, <=, or >= value for `update_time`
- * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00` + * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`, + * `event_impacts.product.product_name:"Eventarc"` *
* * Multiple filter queries are separated by spaces. Example: @@ -749,7 +750,7 @@ export class ServiceHealthClient { * AND and OR expressions explicitly. * * Filter is supported for the following fields: `category`, `state`, - * `update_time` + * `update_time`, `event_impacts.product.product_name` * @param {google.cloud.servicehealth.v1.EventView} [request.view] * Optional. Event fields to include in response. * @param {object} [options] @@ -868,7 +869,8 @@ export class ServiceHealthClient { * response. The expression takes the following forms:
* * field=value for `category` and `state`
* * field <, >, <=, or >= value for `update_time`
- * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00` + * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`, + * `event_impacts.product.product_name:"Eventarc"` *
* * Multiple filter queries are separated by spaces. Example: @@ -878,7 +880,7 @@ export class ServiceHealthClient { * AND and OR expressions explicitly. * * Filter is supported for the following fields: `category`, `state`, - * `update_time` + * `update_time`, `event_impacts.product.product_name` * @param {google.cloud.servicehealth.v1.EventView} [request.view] * Optional. Event fields to include in response. * @param {object} [options] @@ -945,7 +947,8 @@ export class ServiceHealthClient { * response. The expression takes the following forms:
* * field=value for `category` and `state`
* * field <, >, <=, or >= value for `update_time`
- * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00` + * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`, + * `event_impacts.product.product_name:"Eventarc"` *
* * Multiple filter queries are separated by spaces. Example: @@ -955,7 +958,7 @@ export class ServiceHealthClient { * AND and OR expressions explicitly. * * Filter is supported for the following fields: `category`, `state`, - * `update_time` + * `update_time`, `event_impacts.product.product_name` * @param {google.cloud.servicehealth.v1.EventView} [request.view] * Optional. Event fields to include in response. * @param {object} [options] @@ -1028,7 +1031,7 @@ export class ServiceHealthClient { * * field=value for `category` and `state` * * field <, >, <=, or >= value for `update_time` * - * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00` + * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"` * * Multiple filter queries are space-separated. Example: * `category=INCIDENT state=ACTIVE`. @@ -1167,7 +1170,7 @@ export class ServiceHealthClient { * * field=value for `category` and `state` * * field <, >, <=, or >= value for `update_time` * - * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00` + * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"` * * Multiple filter queries are space-separated. Example: * `category=INCIDENT state=ACTIVE`. @@ -1250,7 +1253,7 @@ export class ServiceHealthClient { * * field=value for `category` and `state` * * field <, >, <=, or >= value for `update_time` * - * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00` + * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"` * * Multiple filter queries are space-separated. Example: * `category=INCIDENT state=ACTIVE`.