internal/generated/snippets/resourcesettings/apiv1/snippet_metadata.google.cloud.resourcesettings.v1.json

{
  "clientLibrary": {
    "name": "cloud.google.com/go/resourcesettings/apiv1",
    "version": "1.5.0",
    "language": "GO",
    "apis": [
      {
        "id": "google.cloud.resourcesettings.v1",
        "version": "v1"
      }
    ]
  },
  "snippets": [
    {
      "regionTag": "resourcesettings_v1_generated_ResourceSettingsService_GetSetting_sync",
      "title": "resourcesettings GetSetting Sample",
      "description": "GetSetting gets a setting.\n\nReturns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the\nsetting does not exist.",
      "file": "Client/GetSetting/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "GetSetting",
        "fullName": "google.cloud.resourcesettings.v1.Client.GetSetting",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "resourcesettingspb.GetSettingRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "resourcesettingspb.Setting",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.resourcesettings.v1.Client"
        },
        "method": {
          "shortName": "GetSetting",
          "fullName": "google.cloud.resourcesettings.v1.ResourceSettingsService.GetSetting",
          "service": {
            "shortName": "ResourceSettingsService",
            "fullName": "google.cloud.resourcesettings.v1.ResourceSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "resourcesettings_v1_generated_ResourceSettingsService_ListSettings_sync",
      "title": "resourcesettings ListSettings Sample",
      "description": "ListSettings lists all the settings that are available on the Cloud resource parent.",
      "file": "Client/ListSettings/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "ListSettings",
        "fullName": "google.cloud.resourcesettings.v1.Client.ListSettings",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "resourcesettingspb.ListSettingsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "SettingIterator",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.resourcesettings.v1.Client"
        },
        "method": {
          "shortName": "ListSettings",
          "fullName": "google.cloud.resourcesettings.v1.ResourceSettingsService.ListSettings",
          "service": {
            "shortName": "ResourceSettingsService",
            "fullName": "google.cloud.resourcesettings.v1.ResourceSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 60,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "resourcesettings_v1_generated_ResourceSettingsService_UpdateSetting_sync",
      "title": "resourcesettings UpdateSetting Sample",
      "description": "UpdateSetting updates a setting.\n\nReturns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the\nsetting does not exist.\nReturns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if\nthe setting is flagged as read only.\nReturns a google.rpc.Status with google.rpc.Code.ABORTED if the etag\nsupplied in the request does not match the persisted etag of the setting\nvalue.\n\nOn success, the response will contain only name, local_value and\netag.  The metadata and effective_value cannot be updated through\nthis API.\n\nNote: the supplied setting will perform a full overwrite of the\nlocal_value field.",
      "file": "Client/UpdateSetting/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "UpdateSetting",
        "fullName": "google.cloud.resourcesettings.v1.Client.UpdateSetting",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "resourcesettingspb.UpdateSettingRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "resourcesettingspb.Setting",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.resourcesettings.v1.Client"
        },
        "method": {
          "shortName": "UpdateSetting",
          "fullName": "google.cloud.resourcesettings.v1.ResourceSettingsService.UpdateSetting",
          "service": {
            "shortName": "ResourceSettingsService",
            "fullName": "google.cloud.resourcesettings.v1.ResourceSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    }
  ]
}