-
Notifications
You must be signed in to change notification settings - Fork 604
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(samples): include metadata file, add exclusions for samples to h…
…andwritten libraries (#247) - [ ] Regenerate this pull request now. PiperOrigin-RevId: 429395631 Source-Link: googleapis/googleapis@84594b3 Source-Link: googleapis/googleapis-gen@ed74f97 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWQ3NGY5NzBmZDgyOTE0ODc0ZTZiMjdiMDQ3NjNjZmE2NmJhZmU5YiJ9
- Loading branch information
1 parent
a8a3984
commit ecde411
Showing
9 changed files
with
362 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 7 additions & 2 deletions
9
...s/google-monitoring-dashboard/samples/generated/v1/dashboards_service.create_dashboard.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 7 additions & 2 deletions
9
...s/google-monitoring-dashboard/samples/generated/v1/dashboards_service.delete_dashboard.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 7 additions & 2 deletions
9
...ages/google-monitoring-dashboard/samples/generated/v1/dashboards_service.get_dashboard.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 7 additions & 2 deletions
9
...es/google-monitoring-dashboard/samples/generated/v1/dashboards_service.list_dashboards.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 7 additions & 2 deletions
9
...s/google-monitoring-dashboard/samples/generated/v1/dashboards_service.update_dashboard.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
235 changes: 235 additions & 0 deletions
235
...oring-dashboard/samples/generated/v1/snippet_metadata.google.monitoring.dashboard.v1.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,235 @@ | ||
{ | ||
"clientLibrary": { | ||
"name": "nodejs-dashboard", | ||
"version": "0.1.0", | ||
"language": "TYPESCRIPT", | ||
"apis": [ | ||
{ | ||
"id": "google.monitoring.dashboard.v1", | ||
"version": "v1" | ||
} | ||
] | ||
}, | ||
"snippets": [ | ||
{ | ||
"regionTag": "monitoring_v1_generated_DashboardsService_CreateDashboard_async", | ||
"title": "DashboardsService createDashboard Sample", | ||
"origin": "API_DEFINITION", | ||
"description": " Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see [Managing dashboards by API](https://cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](https://cloud.google.com/iam).", | ||
"canonical": true, | ||
"file": "dashboards_service.create_dashboard.js", | ||
"language": "JAVASCRIPT", | ||
"segments": [ | ||
{ | ||
"start": 25, | ||
"end": 62, | ||
"type": "FULL" | ||
} | ||
], | ||
"clientMethod": { | ||
"shortName": "CreateDashboard", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService.CreateDashboard", | ||
"async": true, | ||
"parameters": [ | ||
{ | ||
"name": "parent", | ||
"type": "TYPE_STRING" | ||
}, | ||
{ | ||
"name": "dashboard", | ||
"type": ".google.monitoring.dashboard.v1.Dashboard" | ||
}, | ||
{ | ||
"name": "validate_only", | ||
"type": "TYPE_BOOL" | ||
} | ||
], | ||
"resultType": ".google.monitoring.dashboard.v1.Dashboard", | ||
"client": { | ||
"shortName": "DashboardsServiceClient", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsServiceClient" | ||
}, | ||
"method": { | ||
"shortName": "CreateDashboard", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService.CreateDashboard", | ||
"service": { | ||
"shortName": "DashboardsService", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService" | ||
} | ||
} | ||
} | ||
}, | ||
{ | ||
"regionTag": "monitoring_v1_generated_DashboardsService_ListDashboards_async", | ||
"title": "DashboardsService listDashboards Sample", | ||
"origin": "API_DEFINITION", | ||
"description": " Lists the existing dashboards. This method requires the `monitoring.dashboards.list` permission on the specified project. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).", | ||
"canonical": true, | ||
"file": "dashboards_service.list_dashboards.js", | ||
"language": "JAVASCRIPT", | ||
"segments": [ | ||
{ | ||
"start": 25, | ||
"end": 64, | ||
"type": "FULL" | ||
} | ||
], | ||
"clientMethod": { | ||
"shortName": "ListDashboards", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService.ListDashboards", | ||
"async": true, | ||
"parameters": [ | ||
{ | ||
"name": "parent", | ||
"type": "TYPE_STRING" | ||
}, | ||
{ | ||
"name": "page_size", | ||
"type": "TYPE_INT32" | ||
}, | ||
{ | ||
"name": "page_token", | ||
"type": "TYPE_STRING" | ||
} | ||
], | ||
"resultType": ".google.monitoring.dashboard.v1.ListDashboardsResponse", | ||
"client": { | ||
"shortName": "DashboardsServiceClient", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsServiceClient" | ||
}, | ||
"method": { | ||
"shortName": "ListDashboards", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService.ListDashboards", | ||
"service": { | ||
"shortName": "DashboardsService", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService" | ||
} | ||
} | ||
} | ||
}, | ||
{ | ||
"regionTag": "monitoring_v1_generated_DashboardsService_GetDashboard_async", | ||
"title": "DashboardsService getDashboard Sample", | ||
"origin": "API_DEFINITION", | ||
"description": " Fetches a specific dashboard. This method requires the `monitoring.dashboards.get` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).", | ||
"canonical": true, | ||
"file": "dashboards_service.get_dashboard.js", | ||
"language": "JAVASCRIPT", | ||
"segments": [ | ||
{ | ||
"start": 25, | ||
"end": 53, | ||
"type": "FULL" | ||
} | ||
], | ||
"clientMethod": { | ||
"shortName": "GetDashboard", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService.GetDashboard", | ||
"async": true, | ||
"parameters": [ | ||
{ | ||
"name": "name", | ||
"type": "TYPE_STRING" | ||
} | ||
], | ||
"resultType": ".google.monitoring.dashboard.v1.Dashboard", | ||
"client": { | ||
"shortName": "DashboardsServiceClient", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsServiceClient" | ||
}, | ||
"method": { | ||
"shortName": "GetDashboard", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService.GetDashboard", | ||
"service": { | ||
"shortName": "DashboardsService", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService" | ||
} | ||
} | ||
} | ||
}, | ||
{ | ||
"regionTag": "monitoring_v1_generated_DashboardsService_DeleteDashboard_async", | ||
"title": "DashboardsService deleteDashboard Sample", | ||
"origin": "API_DEFINITION", | ||
"description": " Deletes an existing custom dashboard. This method requires the `monitoring.dashboards.delete` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).", | ||
"canonical": true, | ||
"file": "dashboards_service.delete_dashboard.js", | ||
"language": "JAVASCRIPT", | ||
"segments": [ | ||
{ | ||
"start": 25, | ||
"end": 51, | ||
"type": "FULL" | ||
} | ||
], | ||
"clientMethod": { | ||
"shortName": "DeleteDashboard", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService.DeleteDashboard", | ||
"async": true, | ||
"parameters": [ | ||
{ | ||
"name": "name", | ||
"type": "TYPE_STRING" | ||
} | ||
], | ||
"resultType": ".google.protobuf.Empty", | ||
"client": { | ||
"shortName": "DashboardsServiceClient", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsServiceClient" | ||
}, | ||
"method": { | ||
"shortName": "DeleteDashboard", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService.DeleteDashboard", | ||
"service": { | ||
"shortName": "DashboardsService", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService" | ||
} | ||
} | ||
} | ||
}, | ||
{ | ||
"regionTag": "monitoring_v1_generated_DashboardsService_UpdateDashboard_async", | ||
"title": "DashboardsService updateDashboard Sample", | ||
"origin": "API_DEFINITION", | ||
"description": " Replaces an existing custom dashboard with a new definition. This method requires the `monitoring.dashboards.update` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).", | ||
"canonical": true, | ||
"file": "dashboards_service.update_dashboard.js", | ||
"language": "JAVASCRIPT", | ||
"segments": [ | ||
{ | ||
"start": 25, | ||
"end": 55, | ||
"type": "FULL" | ||
} | ||
], | ||
"clientMethod": { | ||
"shortName": "UpdateDashboard", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService.UpdateDashboard", | ||
"async": true, | ||
"parameters": [ | ||
{ | ||
"name": "dashboard", | ||
"type": ".google.monitoring.dashboard.v1.Dashboard" | ||
}, | ||
{ | ||
"name": "validate_only", | ||
"type": "TYPE_BOOL" | ||
} | ||
], | ||
"resultType": ".google.monitoring.dashboard.v1.Dashboard", | ||
"client": { | ||
"shortName": "DashboardsServiceClient", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsServiceClient" | ||
}, | ||
"method": { | ||
"shortName": "UpdateDashboard", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService.UpdateDashboard", | ||
"service": { | ||
"shortName": "DashboardsService", | ||
"fullName": "google.monitoring.dashboard.v1.DashboardsService" | ||
} | ||
} | ||
} | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.