snippet_metadata.google.api.apikeys.v2.json

{
  "clientLibrary": {
    "name": "cloud.google.com/go/apikeys/apiv2",
    "version": "1.1.1",
    "language": "GO",
    "apis": [
      {
        "id": "google.api.apikeys.v2",
        "version": "v2"
      }
    ]
  },
  "snippets": [
    {
      "regionTag": "apikeys_v2_generated_ApiKeys_CreateKey_sync",
      "title": "apikeys CreateKey Sample",
      "description": "CreateKey creates a new API key.\n\nNOTE: Key is a global resource; hence the only supported value for\nlocation is `global`.",
      "file": "Client/CreateKey/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "CreateKey",
        "fullName": "google.api.apikeys.v2.Client.CreateKey",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "apikeyspb.CreateKeyRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "CreateKeyOperation",
        "client": {
          "shortName": "Client",
          "fullName": "google.api.apikeys.v2.Client"
        },
        "method": {
          "shortName": "CreateKey",
          "fullName": "google.api.apikeys.v2.ApiKeys.CreateKey",
          "service": {
            "shortName": "ApiKeys",
            "fullName": "google.api.apikeys.v2.ApiKeys"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 58,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "apikeys_v2_generated_ApiKeys_DeleteKey_sync",
      "title": "apikeys DeleteKey Sample",
      "description": "DeleteKey deletes an API key. Deleted key can be retrieved within 30 days of\ndeletion. Afterward, key will be purged from the project.\n\nNOTE: Key is a global resource; hence the only supported value for\nlocation is `global`.",
      "file": "Client/DeleteKey/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "DeleteKey",
        "fullName": "google.api.apikeys.v2.Client.DeleteKey",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "apikeyspb.DeleteKeyRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "DeleteKeyOperation",
        "client": {
          "shortName": "Client",
          "fullName": "google.api.apikeys.v2.Client"
        },
        "method": {
          "shortName": "DeleteKey",
          "fullName": "google.api.apikeys.v2.ApiKeys.DeleteKey",
          "service": {
            "shortName": "ApiKeys",
            "fullName": "google.api.apikeys.v2.ApiKeys"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 58,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "apikeys_v2_generated_ApiKeys_GetKey_sync",
      "title": "apikeys GetKey Sample",
      "description": "GetKey gets the metadata for an API key. The key string of the API key\nisn't included in the response.\n\nNOTE: Key is a global resource; hence the only supported value for\nlocation is `global`.",
      "file": "Client/GetKey/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "GetKey",
        "fullName": "google.api.apikeys.v2.Client.GetKey",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "apikeyspb.GetKeyRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*apikeyspb.Key",
        "client": {
          "shortName": "Client",
          "fullName": "google.api.apikeys.v2.Client"
        },
        "method": {
          "shortName": "GetKey",
          "fullName": "google.api.apikeys.v2.ApiKeys.GetKey",
          "service": {
            "shortName": "ApiKeys",
            "fullName": "google.api.apikeys.v2.ApiKeys"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "apikeys_v2_generated_ApiKeys_GetKeyString_sync",
      "title": "apikeys GetKeyString Sample",
      "description": "GetKeyString get the key string for an API key.\n\nNOTE: Key is a global resource; hence the only supported value for\nlocation is `global`.",
      "file": "Client/GetKeyString/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "GetKeyString",
        "fullName": "google.api.apikeys.v2.Client.GetKeyString",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "apikeyspb.GetKeyStringRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*apikeyspb.GetKeyStringResponse",
        "client": {
          "shortName": "Client",
          "fullName": "google.api.apikeys.v2.Client"
        },
        "method": {
          "shortName": "GetKeyString",
          "fullName": "google.api.apikeys.v2.ApiKeys.GetKeyString",
          "service": {
            "shortName": "ApiKeys",
            "fullName": "google.api.apikeys.v2.ApiKeys"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "apikeys_v2_generated_ApiKeys_GetOperation_sync",
      "title": "apikeys GetOperation Sample",
      "description": "GetOperation is a utility method from google.longrunning.Operations.",
      "file": "Client/GetOperation/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "GetOperation",
        "fullName": "google.api.apikeys.v2.Client.GetOperation",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "longrunningpb.GetOperationRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*longrunningpb.Operation",
        "client": {
          "shortName": "Client",
          "fullName": "google.api.apikeys.v2.Client"
        },
        "method": {
          "shortName": "GetOperation",
          "fullName": "google.longrunning.Operations.GetOperation",
          "service": {
            "shortName": "Operations",
            "fullName": "google.longrunning.Operations"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "apikeys_v2_generated_ApiKeys_ListKeys_sync",
      "title": "apikeys ListKeys Sample",
      "description": "ListKeys lists the API keys owned by a project. The key string of the API key\nisn't included in the response.\n\nNOTE: Key is a global resource; hence the only supported value for\nlocation is `global`.",
      "file": "Client/ListKeys/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "ListKeys",
        "fullName": "google.api.apikeys.v2.Client.ListKeys",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "apikeyspb.ListKeysRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "KeyIterator",
        "client": {
          "shortName": "Client",
          "fullName": "google.api.apikeys.v2.Client"
        },
        "method": {
          "shortName": "ListKeys",
          "fullName": "google.api.apikeys.v2.ApiKeys.ListKeys",
          "service": {
            "shortName": "ApiKeys",
            "fullName": "google.api.apikeys.v2.ApiKeys"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 60,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "apikeys_v2_generated_ApiKeys_LookupKey_sync",
      "title": "apikeys LookupKey Sample",
      "description": "LookupKey find the parent project and resource name of the API\nkey that matches the key string in the request. If the API key has been\npurged, resource name will not be set.\nThe service account must have the `apikeys.keys.lookup` permission\non the parent project.",
      "file": "Client/LookupKey/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "LookupKey",
        "fullName": "google.api.apikeys.v2.Client.LookupKey",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "apikeyspb.LookupKeyRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*apikeyspb.LookupKeyResponse",
        "client": {
          "shortName": "Client",
          "fullName": "google.api.apikeys.v2.Client"
        },
        "method": {
          "shortName": "LookupKey",
          "fullName": "google.api.apikeys.v2.ApiKeys.LookupKey",
          "service": {
            "shortName": "ApiKeys",
            "fullName": "google.api.apikeys.v2.ApiKeys"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "apikeys_v2_generated_ApiKeys_UndeleteKey_sync",
      "title": "apikeys UndeleteKey Sample",
      "description": "UndeleteKey undeletes an API key which was deleted within 30 days.\n\nNOTE: Key is a global resource; hence the only supported value for\nlocation is `global`.",
      "file": "Client/UndeleteKey/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "UndeleteKey",
        "fullName": "google.api.apikeys.v2.Client.UndeleteKey",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "apikeyspb.UndeleteKeyRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "UndeleteKeyOperation",
        "client": {
          "shortName": "Client",
          "fullName": "google.api.apikeys.v2.Client"
        },
        "method": {
          "shortName": "UndeleteKey",
          "fullName": "google.api.apikeys.v2.ApiKeys.UndeleteKey",
          "service": {
            "shortName": "ApiKeys",
            "fullName": "google.api.apikeys.v2.ApiKeys"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 58,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "apikeys_v2_generated_ApiKeys_UpdateKey_sync",
      "title": "apikeys UpdateKey Sample",
      "description": "UpdateKey patches the modifiable fields of an API key.\nThe key string of the API key isn't included in the response.\n\nNOTE: Key is a global resource; hence the only supported value for\nlocation is `global`.",
      "file": "Client/UpdateKey/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "UpdateKey",
        "fullName": "google.api.apikeys.v2.Client.UpdateKey",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "apikeyspb.UpdateKeyRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "UpdateKeyOperation",
        "client": {
          "shortName": "Client",
          "fullName": "google.api.apikeys.v2.Client"
        },
        "method": {
          "shortName": "UpdateKey",
          "fullName": "google.api.apikeys.v2.ApiKeys.UpdateKey",
          "service": {
            "shortName": "ApiKeys",
            "fullName": "google.api.apikeys.v2.ApiKeys"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 58,
          "type": "FULL"
        }
      ]
    }
  ]
}