internal/generated/snippets/monitoring/dashboard/apiv1/snippet_metadata.google.monitoring.dashboard.v1.json

{
  "clientLibrary": {
    "name": "cloud.google.com/go/monitoring/dashboard/apiv1",
    "version": "1.18.2",
    "language": "GO",
    "apis": [
      {
        "id": "google.monitoring.dashboard.v1",
        "version": "v1"
      }
    ]
  },
  "snippets": [
    {
      "regionTag": "monitoring_v1_generated_DashboardsService_CreateDashboard_sync",
      "title": "monitoring CreateDashboard Sample",
      "description": "CreateDashboard creates a new custom dashboard. For examples on how you can use this API to\ncreate dashboards, see [Managing dashboards by\nAPI](https: //cloud.google.com/monitoring/dashboards/api-dashboard). This\nmethod requires the `monitoring.dashboards.create` permission on the\nspecified project. For more information about permissions, see [Cloud\nIdentity and Access Management](https: //cloud.google.com/iam).",
      "file": "DashboardsClient/CreateDashboard/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "CreateDashboard",
        "fullName": "google.monitoring.dashboard.v1.DashboardsClient.CreateDashboard",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "dashboardpb.CreateDashboardRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*dashboardpb.Dashboard",
        "client": {
          "shortName": "DashboardsClient",
          "fullName": "google.monitoring.dashboard.v1.DashboardsClient"
        },
        "method": {
          "shortName": "CreateDashboard",
          "fullName": "google.monitoring.dashboard.v1.DashboardsService.CreateDashboard",
          "service": {
            "shortName": "DashboardsService",
            "fullName": "google.monitoring.dashboard.v1.DashboardsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "monitoring_v1_generated_DashboardsService_DeleteDashboard_sync",
      "title": "monitoring DeleteDashboard Sample",
      "description": "DeleteDashboard deletes an existing custom dashboard.\n\nThis method requires the `monitoring.dashboards.delete` permission\non the specified dashboard. For more information, see\n[Cloud Identity and Access Management](https: //cloud.google.com/iam).",
      "file": "DashboardsClient/DeleteDashboard/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "DeleteDashboard",
        "fullName": "google.monitoring.dashboard.v1.DashboardsClient.DeleteDashboard",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "dashboardpb.DeleteDashboardRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "client": {
          "shortName": "DashboardsClient",
          "fullName": "google.monitoring.dashboard.v1.DashboardsClient"
        },
        "method": {
          "shortName": "DeleteDashboard",
          "fullName": "google.monitoring.dashboard.v1.DashboardsService.DeleteDashboard",
          "service": {
            "shortName": "DashboardsService",
            "fullName": "google.monitoring.dashboard.v1.DashboardsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 51,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "monitoring_v1_generated_DashboardsService_GetDashboard_sync",
      "title": "monitoring GetDashboard Sample",
      "description": "GetDashboard fetches a specific dashboard.\n\nThis method requires the `monitoring.dashboards.get` permission\non the specified dashboard. For more information, see\n[Cloud Identity and Access Management](https: //cloud.google.com/iam).",
      "file": "DashboardsClient/GetDashboard/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "GetDashboard",
        "fullName": "google.monitoring.dashboard.v1.DashboardsClient.GetDashboard",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "dashboardpb.GetDashboardRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*dashboardpb.Dashboard",
        "client": {
          "shortName": "DashboardsClient",
          "fullName": "google.monitoring.dashboard.v1.DashboardsClient"
        },
        "method": {
          "shortName": "GetDashboard",
          "fullName": "google.monitoring.dashboard.v1.DashboardsService.GetDashboard",
          "service": {
            "shortName": "DashboardsService",
            "fullName": "google.monitoring.dashboard.v1.DashboardsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "monitoring_v1_generated_DashboardsService_ListDashboards_sync",
      "title": "monitoring ListDashboards Sample",
      "description": "ListDashboards lists the existing dashboards.\n\nThis method requires the `monitoring.dashboards.list` permission\non the specified project. For more information, see\n[Cloud Identity and Access Management](https: //cloud.google.com/iam).",
      "file": "DashboardsClient/ListDashboards/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "ListDashboards",
        "fullName": "google.monitoring.dashboard.v1.DashboardsClient.ListDashboards",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "dashboardpb.ListDashboardsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "DashboardIterator",
        "client": {
          "shortName": "DashboardsClient",
          "fullName": "google.monitoring.dashboard.v1.DashboardsClient"
        },
        "method": {
          "shortName": "ListDashboards",
          "fullName": "google.monitoring.dashboard.v1.DashboardsService.ListDashboards",
          "service": {
            "shortName": "DashboardsService",
            "fullName": "google.monitoring.dashboard.v1.DashboardsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 66,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "monitoring_v1_generated_DashboardsService_UpdateDashboard_sync",
      "title": "monitoring UpdateDashboard Sample",
      "description": "UpdateDashboard replaces an existing custom dashboard with a new definition.\n\nThis method requires the `monitoring.dashboards.update` permission\non the specified dashboard. For more information, see\n[Cloud Identity and Access Management](https: //cloud.google.com/iam).",
      "file": "DashboardsClient/UpdateDashboard/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "UpdateDashboard",
        "fullName": "google.monitoring.dashboard.v1.DashboardsClient.UpdateDashboard",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "dashboardpb.UpdateDashboardRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*dashboardpb.Dashboard",
        "client": {
          "shortName": "DashboardsClient",
          "fullName": "google.monitoring.dashboard.v1.DashboardsClient"
        },
        "method": {
          "shortName": "UpdateDashboard",
          "fullName": "google.monitoring.dashboard.v1.DashboardsService.UpdateDashboard",
          "service": {
            "shortName": "DashboardsService",
            "fullName": "google.monitoring.dashboard.v1.DashboardsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    }
  ]
}