snippet_metadata.google.cloud.secretmanager.v1.json

{
  "clientLibrary": {
    "name": "cloud.google.com/go/secretmanager/apiv1",
    "version": "1.4.0",
    "language": "GO",
    "apis": [
      {
        "id": "google.cloud.secretmanager.v1",
        "version": "v1"
      }
    ]
  },
  "snippets": [
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_AccessSecretVersion_sync",
      "title": "secretmanager AccessSecretVersion Sample",
      "description": "AccessSecretVersion accesses a SecretVersion. This call returns the secret data.\n\nprojects/*/secrets/*/versions/latest is an alias to the most recently\ncreated SecretVersion.",
      "file": "Client/AccessSecretVersion/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "AccessSecretVersion",
        "fullName": "google.cloud.secretmanager.v1.Client.AccessSecretVersion",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "secretmanagerpb.AccessSecretVersionRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "secretmanagerpb.AccessSecretVersionResponse",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "AccessSecretVersion",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_AddSecretVersion_sync",
      "title": "secretmanager AddSecretVersion Sample",
      "description": "AddSecretVersion creates a new SecretVersion containing secret data and attaches\nit to an existing Secret.",
      "file": "Client/AddSecretVersion/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "AddSecretVersion",
        "fullName": "google.cloud.secretmanager.v1.Client.AddSecretVersion",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "secretmanagerpb.AddSecretVersionRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "secretmanagerpb.SecretVersion",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "AddSecretVersion",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_CreateSecret_sync",
      "title": "secretmanager CreateSecret Sample",
      "description": "CreateSecret creates a new Secret containing no SecretVersions.",
      "file": "Client/CreateSecret/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "CreateSecret",
        "fullName": "google.cloud.secretmanager.v1.Client.CreateSecret",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "secretmanagerpb.CreateSecretRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "secretmanagerpb.Secret",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "CreateSecret",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.CreateSecret",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_DeleteSecret_sync",
      "title": "secretmanager DeleteSecret Sample",
      "description": "DeleteSecret deletes a Secret.",
      "file": "Client/DeleteSecret/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "DeleteSecret",
        "fullName": "google.cloud.secretmanager.v1.Client.DeleteSecret",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "secretmanagerpb.DeleteSecretRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "DeleteSecret",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.DeleteSecret",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 45,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_DestroySecretVersion_sync",
      "title": "secretmanager DestroySecretVersion Sample",
      "description": "DestroySecretVersion destroys a SecretVersion.\n\nSets the state of the SecretVersion to\nDESTROYED and irrevocably destroys the\nsecret data.",
      "file": "Client/DestroySecretVersion/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "DestroySecretVersion",
        "fullName": "google.cloud.secretmanager.v1.Client.DestroySecretVersion",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "secretmanagerpb.DestroySecretVersionRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "secretmanagerpb.SecretVersion",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "DestroySecretVersion",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersion",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_DisableSecretVersion_sync",
      "title": "secretmanager DisableSecretVersion Sample",
      "description": "DisableSecretVersion disables a SecretVersion.\n\nSets the state of the SecretVersion to\nDISABLED.",
      "file": "Client/DisableSecretVersion/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "DisableSecretVersion",
        "fullName": "google.cloud.secretmanager.v1.Client.DisableSecretVersion",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "secretmanagerpb.DisableSecretVersionRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "secretmanagerpb.SecretVersion",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "DisableSecretVersion",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersion",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_EnableSecretVersion_sync",
      "title": "secretmanager EnableSecretVersion Sample",
      "description": "EnableSecretVersion enables a SecretVersion.\n\nSets the state of the SecretVersion to\nENABLED.",
      "file": "Client/EnableSecretVersion/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "EnableSecretVersion",
        "fullName": "google.cloud.secretmanager.v1.Client.EnableSecretVersion",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "secretmanagerpb.EnableSecretVersionRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "secretmanagerpb.SecretVersion",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "EnableSecretVersion",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersion",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_GetIamPolicy_sync",
      "title": "secretmanager GetIamPolicy Sample",
      "description": "GetIamPolicy gets the access control policy for a secret.\nReturns empty policy if the secret exists and does not have a policy set.",
      "file": "Client/GetIamPolicy/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "GetIamPolicy",
        "fullName": "google.cloud.secretmanager.v1.Client.GetIamPolicy",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "iampb.GetIamPolicyRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "iampb.Policy",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "GetIamPolicy",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.GetIamPolicy",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_GetSecret_sync",
      "title": "secretmanager GetSecret Sample",
      "description": "GetSecret gets metadata for a given Secret.",
      "file": "Client/GetSecret/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "GetSecret",
        "fullName": "google.cloud.secretmanager.v1.Client.GetSecret",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "secretmanagerpb.GetSecretRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "secretmanagerpb.Secret",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "GetSecret",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.GetSecret",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_GetSecretVersion_sync",
      "title": "secretmanager GetSecretVersion Sample",
      "description": "GetSecretVersion gets metadata for a SecretVersion.\n\nprojects/*/secrets/*/versions/latest is an alias to the most recently\ncreated SecretVersion.",
      "file": "Client/GetSecretVersion/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "GetSecretVersion",
        "fullName": "google.cloud.secretmanager.v1.Client.GetSecretVersion",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "secretmanagerpb.GetSecretVersionRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "secretmanagerpb.SecretVersion",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "GetSecretVersion",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersion",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_ListSecretVersions_sync",
      "title": "secretmanager ListSecretVersions Sample",
      "description": "ListSecretVersions lists SecretVersions. This call does not return secret\ndata.",
      "file": "Client/ListSecretVersions/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "ListSecretVersions",
        "fullName": "google.cloud.secretmanager.v1.Client.ListSecretVersions",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "secretmanagerpb.ListSecretVersionsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "SecretVersionIterator",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "ListSecretVersions",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 54,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_ListSecrets_sync",
      "title": "secretmanager ListSecrets Sample",
      "description": "ListSecrets lists Secrets.",
      "file": "Client/ListSecrets/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "ListSecrets",
        "fullName": "google.cloud.secretmanager.v1.Client.ListSecrets",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "secretmanagerpb.ListSecretsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "SecretIterator",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "ListSecrets",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.ListSecrets",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 54,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_SetIamPolicy_sync",
      "title": "secretmanager SetIamPolicy Sample",
      "description": "SetIamPolicy sets the access control policy on the specified secret. Replaces any\nexisting policy.\n\nPermissions on SecretVersions are enforced according\nto the policy set on the associated Secret.",
      "file": "Client/SetIamPolicy/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "SetIamPolicy",
        "fullName": "google.cloud.secretmanager.v1.Client.SetIamPolicy",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "iampb.SetIamPolicyRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "iampb.Policy",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "SetIamPolicy",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.SetIamPolicy",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_TestIamPermissions_sync",
      "title": "secretmanager TestIamPermissions Sample",
      "description": "TestIamPermissions returns permissions that a caller has for the specified secret.\nIf the secret does not exist, this call returns an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay “fail open” without warning.",
      "file": "Client/TestIamPermissions/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "TestIamPermissions",
        "fullName": "google.cloud.secretmanager.v1.Client.TestIamPermissions",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "iampb.TestIamPermissionsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "iampb.TestIamPermissionsResponse",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "TestIamPermissions",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.TestIamPermissions",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "secretmanager_v1_generated_SecretManagerService_UpdateSecret_sync",
      "title": "secretmanager UpdateSecret Sample",
      "description": "UpdateSecret updates metadata of an existing Secret.",
      "file": "Client/UpdateSecret/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "UpdateSecret",
        "fullName": "google.cloud.secretmanager.v1.Client.UpdateSecret",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "secretmanagerpb.UpdateSecretRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "secretmanagerpb.Secret",
        "client": {
          "shortName": "Client",
          "fullName": "google.cloud.secretmanager.v1.Client"
        },
        "method": {
          "shortName": "UpdateSecret",
          "fullName": "google.cloud.secretmanager.v1.SecretManagerService.UpdateSecret",
          "service": {
            "shortName": "SecretManagerService",
            "fullName": "google.cloud.secretmanager.v1.SecretManagerService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    }
  ]
}