Console
    Contact Us Start free

    View parameter details

    This page describes how to view the metadata of a specific parameter. Metadata can include the following:

    • The parameter name.
    • Timestamp indicating when the parameter was created and updated.
    • The format in which the parameter value is stored (for example, YAML).
    • The system-generated unique ID representing the built-in identity of the parameter.

    Required roles

    To get the permissions that you need to view parameter details, ask your administrator to grant you the Parameter Manager Parameter Viewer ( roles/parametermanager.parameterViewer ) IAM role on the project, folder, or organization. For more information about granting roles, see Manage access to projects, folders, and organizations .

    You might also be able to get the required permissions through custom roles or other predefined roles .

    View parameter details

    To view the details of a specific parameter, use one of the following methods:

    Global parameters

    Console

    1. In the Google Cloud console, go to the Secret Manager page.

      Go to Secret Manager

    2. Click Parameter Manager to go to the Parameter Manager page. You'll see the list of parameters for that project.

    3. Click the name of the parameter to view its details.

    4. On the parameter details page, click the Overview tab. This tab displays the general details and metadata associated with the parameter.

    gcloud

    Before using any of the command data below, make the following replacements:

    • PARAMETER_ID : the name of the parameter

    Execute the following command:

    Linux, macOS, or Cloud Shell

    gcloud  
parametermanager  
parameters  
describe  
 PARAMETER_ID 
  
--location = 
global

    Windows (PowerShell)

    gcloud  
parametermanager  
parameters  
describe  
 PARAMETER_ID 
  
--location = 
global

    Windows (cmd.exe)

    gcloud  
parametermanager  
parameters  
describe  
 PARAMETER_ID 
  
--location = 
global

    You should receive a response similar to the following:

    createTime: '2024-11-14T06:07:35.529019883Z'
format: UNFORMATTED
name: projects/production-1/locations/global/parameters/app_config
policyMember:
  iamPolicyUidPrincipal: principal://parametermanager.googleapis.com/projects/567445493557/uid/locations/global/parameters/307fa2aa-c769-496f-9362-f908d14bac71
updateTime: '2024-11-14T06:07:35.992040677Z'

    REST

    Before using any of the request data, make the following replacements:

    • PROJECT_ID : the Google Cloud project ID
    • PARAMETER_ID : the name of the parameter

    HTTP method and URL:

    GET https://parametermanager.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/parameters/ PARAMETER_ID

    Request JSON body:

    {}

    To send your request, choose one of these options:

    curl

    Save the request body in a file named request.json , and execute the following command:

    curl -X GET \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -d @request.json \
    "https://parametermanager.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/parameters/ PARAMETER_ID 
"

    PowerShell

    Save the request body in a file named request.json , and execute the following command:

    $cred = gcloud auth print-access-token
    $headers = @{ "Authorization" = "Bearer $cred" }

    Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://parametermanager.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/parameters/ PARAMETER_ID 
" | Select-Object -Expand Content

    You should receive a JSON response similar to the following:

    {
  "name": "projects/production-1/locations/global/parameters/app_config",
  "createTime": "2024-10-15T08:39:05.191747694Z",
  "updateTime": "2024-10-15T08:39:05.530311092Z",
  "format": "YAML",
  "policyMember": {
    "iamPolicyUidPrincipal": "principal://parametermanager.googleapis.com/projects/567445493557/uid/locations/global/parameters/c86ca5bc-f4c2-439d-b62c-d578b4b78b12"
  }
}

    C#

    To run this code, first set up a C# development environment and install the Parameter Manager C# SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      using 
  
  Google.Cloud.ParameterManager.V1 
 
 ; 
 public 
  
 class 
  
 GetParameterSample 
 { 
  
 /// <summary> 
  
 /// This function retrieves a parameter using the Parameter Manager SDK for GCP. 
  
 /// </summary> 
  
 /// <param name="projectId">The ID of the project where the parameter is located.</param> 
  
 /// <param name="parameterId">The ID of the parameter to be retrieved.</param> 
  
 /// <returns>The retrieved Parameter object.</returns> 
  
 public 
  
 Parameter 
  
 GetParameter 
 ( 
  
 string 
  
 projectId 
 , 
  
 string 
  
 parameterId 
 ) 
  
 { 
  
 // Create the client. 
  
  ParameterManagerClient 
 
  
 client 
  
 = 
  
  ParameterManagerClient 
 
 . 
  Create 
 
 (); 
  
 // Build the resource name for the parameter. 
  
  ParameterName 
 
  
 parameterName 
  
 = 
  
 new 
  
  ParameterName 
 
 ( 
 projectId 
 , 
  
 "global" 
 , 
  
 parameterId 
 ); 
  
 // Call the API to get the parameter. 
  
 Parameter 
  
 parameter 
  
 = 
  
 client 
 . 
  GetParameter 
 
 ( 
 parameterName 
 ); 
  
 // Print the retrieved parameter name. 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Found the parameter {parameter. Name 
} with format {parameter. Format 
}" 
 ); 
  
 // Return the retrieved parameter. 
  
 return 
  
 parameter 
 ; 
  
 } 
 }

    Go

    To run this code, first set up a Go development environment and install the Parameter Manager Go SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 parametermanager 
  
 "cloud.google.com/go/parametermanager/apiv1" 
  
 parametermanagerpb 
  
 "cloud.google.com/go/parametermanager/apiv1/parametermanagerpb" 
 ) 
 // getParam get parameter using the Parameter Manager SDK for GCP. 
 // 
 // w: The io.Writer object used to write the output. 
 // projectID: The ID of the project where the parameter is located. 
 // parameterID: The ID of the parameter to retrieved. 
 // 
 // The function returns an error if the parameter retrieval fails. 
 func 
  
 getParam 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 parameterID 
  
 string 
 ) 
  
 error 
  
 { 
  
 // Create a context and a Parameter Manager client. 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 parametermanager 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "failed to create Parameter Manager client: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
  Close 
 
 () 
  
 // Construct the name of the parameter to get parameter. 
  
 name 
  
 := 
  
 fmt 
 . 
 Sprintf 
 ( 
 "projects/%s/locations/global/parameters/%s" 
 , 
  
 projectID 
 , 
  
 parameterID 
 ) 
  
 // Build the request to get parameter. 
  
 req 
  
 := 
  
& parametermanagerpb 
 . 
 GetParameterRequest 
 { 
  
 Name 
 : 
  
 name 
 , 
  
 } 
  
 // Call the API to get parameter. 
  
 param 
 , 
  
 err 
  
 := 
  
 client 
 . 
 GetParameter 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "failed to get parameter: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 // Find more details for the Parameter object here: 
  
 // https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters#Parameter 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Found parameter %s with format %s\n" 
 , 
  
 param 
 . 
 Name 
 , 
  
 param 
 . 
 Format 
 . 
 String 
 ()) 
  
 return 
  
 nil 
 }

    Java

    To run this code, first set up a Java development environment and install the Parameter Manager Java SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      import 
  
 com.google.cloud.parametermanager.v1. Parameter 
 
 ; 
 import 
  
 com.google.cloud.parametermanager.v1. ParameterManagerClient 
 
 ; 
 import 
  
 com.google.cloud.parametermanager.v1. ParameterName 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 /** This class demonstrates how to get a parameter using the Parameter Manager SDK for GCP. */ 
 public 
  
 class 
 GetParam 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ; 
  
 String 
  
 parameterId 
  
 = 
  
 "your-parameter-id" 
 ; 
  
 // Call the method to get a parameter. 
  
 getParam 
 ( 
 projectId 
 , 
  
 parameterId 
 ); 
  
 } 
  
 // This is an example snippet for getting a parameter. 
  
 public 
  
 static 
  
  Parameter 
 
  
 getParam 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 parameterId 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // Initialize the client that will be used to send requests. This client only 
  
 // needs to be created once, and can be reused for multiple requests. 
  
 try 
  
 ( 
  ParameterManagerClient 
 
  
 client 
  
 = 
  
  ParameterManagerClient 
 
 . 
 create 
 ()) 
  
 { 
  
 String 
  
 locationId 
  
 = 
  
 "global" 
 ; 
  
 // Build the parameter name. 
  
  ParameterName 
 
  
 parameterName 
  
 = 
  
  ParameterName 
 
 . 
 of 
 ( 
 projectId 
 , 
  
 locationId 
 , 
  
 parameterId 
 ); 
  
 // Get the parameter. 
  
  Parameter 
 
  
 parameter 
  
 = 
  
 client 
 . 
 getParameter 
 ( 
 parameterName 
 . 
  toString 
 
 ()); 
  
 // Find more details for the Parameter object here: 
  
 // https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters#Parameter 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
  
 "Found the parameter %s with format: %s\n" 
 , 
  
 parameter 
 . 
  getName 
 
 (), 
  
 parameter 
 . 
  getFormat 
 
 ()); 
  
 return 
  
 parameter 
 ; 
  
 } 
  
 } 
 }

    Node.js

    To run this code, first set up a Node.js development environment and install the Parameter Manager Node.js SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      /** 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
 // const projectId = 'my-project'; 
 // const parameterId = 'my-parameter'; 
 // Imports the Parameter Manager library 
 const 
  
 { 
 ParameterManagerClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/parametermanager 
' 
 ); 
 // Instantiates a client 
 const 
  
 client 
  
 = 
  
 new 
  
  ParameterManagerClient 
 
 (); 
 async 
  
 function 
  
 getParam 
 () 
  
 { 
  
 // Construct the fully qualified parameter name 
  
 const 
  
 name 
  
 = 
  
 client 
 . 
  parameterPath 
 
 ( 
 projectId 
 , 
  
 'global' 
 , 
  
 parameterId 
 ); 
  
 // Get the parameter 
  
 const 
  
 [ 
 parameter 
 ] 
  
 = 
  
 await 
  
 client 
 . 
 getParameter 
 ({ 
  
 name 
 : 
  
 name 
 , 
  
 }); 
  
 // Find more details for the Parameter object here: 
  
 // https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters#Parameter 
  
 console 
 . 
 log 
 ( 
  
 `Found parameter 
 ${ 
 parameter 
 . 
 name 
 } 
 with format 
 ${ 
 parameter 
 . 
 format 
 } 
 ` 
  
 ); 
  
 return 
  
 parameter 
 ; 
 } 
 return 
  
 await 
  
 getParam 
 ();

    PHP

    To run this code, first learn about using PHP on Google Cloud and install the Parameter Manager PHP SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      // Import necessary classes for retrieve a parameter version. 
 use Google\Cloud\ParameterManager\V1\Client\ParameterManagerClient; 
 use Google\Cloud\ParameterManager\V1\GetParameterRequest; 
 use Google\Cloud\ParameterManager\V1\ParameterFormat; 
 /** 
 * Retrieves a parameter using the Parameter Manager SDK for GCP. 
 * 
 * @param string $projectId The Google Cloud Project ID (e.g. 'my-project') 
 * @param string $parameterId The Parameter ID (e.g. 'my-param') 
 */ 
 function get_param(string $projectId, string $parameterId): void 
 { 
 // Create a client for the Parameter Manager service. 
 $client = new ParameterManagerClient(); 
 // Build the resource name of the parameter. 
 $parameterName = $client->parameterName($projectId, 'global', $parameterId); 
 // Prepare the request to get the parameter. 
 $request = (new GetParameterRequest()) 
 ->setName($parameterName); 
 // Retrieve the parameter using the client. 
 $parameter = $client->getParameter($request); 
 // Print the retrieved parameter details. 
 printf('Found parameter %s with format %s' . PHP_EOL, $parameter->getName(), ParameterFormat::name($parameter->getFormat())); 
 }

    Python

    To run this code, first set up a Python development environment and install the Parameter Manager Python SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      def 
  
 get_param 
 ( 
 project_id 
 : 
 str 
 , 
 parameter_id 
 : 
 str 
 ) 
 - 
> parametermanager_v1 
 . 
 Parameter 
 : 
  
 """ 
 Retrieves a parameter from the global location of the specified 
 project using the Google Cloud Parameter Manager SDK. 
 Args: 
 project_id (str): The ID of the project where the parameter is located. 
 parameter_id (str): The ID of the parameter to retrieve. 
 Returns: 
 parametermanager_v1.Parameter: An object representing the parameter. 
 Example: 
 get_param( 
 "my-project", 
 "my-global-parameter" 
 ) 
 """ 
 # Import the necessary library for Google Cloud Parameter Manager. 
 from 
  
 google.cloud 
  
 import 
 parametermanager_v1 
 # Create the Parameter Manager client. 
 client 
 = 
 parametermanager_v1 
 . 
 ParameterManagerClient 
 () 
 # Build the resource name of the parameter. 
 name 
 = 
 client 
 . 
 parameter_path 
 ( 
 project_id 
 , 
 "global" 
 , 
 parameter_id 
 ) 
 # Retrieve the parameter. 
 parameter 
 = 
 client 
 . 
 get_parameter 
 ( 
 name 
 = 
 name 
 ) 
 # Show parameter details. 
 # Find more details for the Parameter object here: 
 # https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters#Parameter 
 print 
 ( 
 f 
 "Found the parameter 
 { 
 parameter 
 . 
 name 
 } 
 with format 
 { 
 parameter 
 . 
 format_ 
 . 
 name 
 } 
 " 
 )

    Ruby

    To run this code, first set up a Ruby development environment and install the Parameter Manager Ruby SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      require 
  
 "google/cloud/parameter_manager" 
 ## 
 # Retrieve a parameter 
 # 
 # @param project_id [String] The Google Cloud project (e.g. "my-project") 
 # @param parameter_id [String] The parameter name (e.g. "my-parameter") 
 # 
 def 
  
 get_param 
  
 project_id 
 :, 
  
 parameter_id 
 : 
  
 # Create a Parameter Manager client. 
  
 client 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  ParameterManager 
 
 . 
  parameter_manager 
 
  
 # Build the resource name of the parent project. 
  
 name 
  
 = 
  
 client 
 . 
  parameter_path 
 
  
 project 
 : 
  
 project_id 
 , 
  
 location 
 : 
  
 "global" 
 , 
  
 parameter 
 : 
  
 parameter_id 
  
 # Retrieve the parameter. 
  
 param 
  
 = 
  
 client 
 . 
 get_parameter 
  
 name 
 : 
  
 name 
  
 # Print the retrieved parameter name. 
  
 puts 
  
 "Found parameter 
 #{ 
 param 
 . 
 name 
 } 
 with format 
 #{ 
 param 
 . 
  format 
 
 } 
 " 
 end

    Regional parameters

    Console

    1. In the Google Cloud console, go to the Secret Manager page.

      Go to Secret Manager

    2. Click Parameter Manager to go to the Parameter Manager page. You'll see the list of parameters for that project.

    3. Click the name of the parameter to view its details.

    4. On the parameter details page, click the Overview tab. This tab displays the general details and metadata associated with the parameter.

    gcloud

    Before using any of the command data below, make the following replacements:

    • PARAMETER_ID : the name of the parameter
    • LOCATION : the Google Cloud location of the parameter

    Execute the following command:

    Linux, macOS, or Cloud Shell

    gcloud  
parametermanager  
parameters  
describe  
 PARAMETER_ID 
  
--location = 
 LOCATION

    Windows (PowerShell)

    gcloud  
parametermanager  
parameters  
describe  
 PARAMETER_ID 
  
--location = 
 LOCATION

    Windows (cmd.exe)

    gcloud  
parametermanager  
parameters  
describe  
 PARAMETER_ID 
  
--location = 
 LOCATION

    You should receive a response similar to the following:

    createTime: '2024-11-14T06:07:35.529019883Z'
format: UNFORMATTED
name: projects/production-1/locations/us-central1/parameters/app_config
policyMember:
  iamPolicyUidPrincipal: principal://parametermanager.googleapis.com/projects/567445493557/uid/locations/us-central1/parameters/307fa2aa-c769-496f-9362-f908d14bac71
updateTime: '2024-11-14T06:07:35.992040677Z'

    REST

    Before using any of the request data, make the following replacements:

    • LOCATION : the Google Cloud location of the parameter
    • PROJECT_ID : the Google Cloud project ID
    • PARAMETER_ID : the name of the parameter

    HTTP method and URL:

    GET https://parametermanager. LOCATION 
.rep.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION 
/parameters/ PARAMETER_ID

    Request JSON body:

    {}

    To send your request, choose one of these options:

    curl

    Save the request body in a file named request.json , and execute the following command:

    curl -X GET \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -d @request.json \
    "https://parametermanager. LOCATION 
.rep.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION 
/parameters/ PARAMETER_ID 
"

    PowerShell

    Save the request body in a file named request.json , and execute the following command:

    $cred = gcloud auth print-access-token
    $headers = @{ "Authorization" = "Bearer $cred" }

    Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://parametermanager. LOCATION 
.rep.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION 
/parameters/ PARAMETER_ID 
" | Select-Object -Expand Content

    You should receive a JSON response similar to the following:

    {
  "name": "projects/production-1/locations/us-central1/parameters/app_config",
  "createTime": "2024-10-15T08:39:05.191747694Z",
  "updateTime": "2024-10-15T08:39:05.530311092Z",
  "format": "YAML",
  "policyMember": {
    "iamPolicyUidPrincipal": "principal://parametermanager.googleapis.com/projects/567445493557/uid/locations/global/parameters/c86ca5bc-f4c2-439d-b62c-d578b4b78b12"
  }
}

    C#

    To run this code, first set up a C# development environment and install the Parameter Manager C# SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      using 
  
  Google.Cloud.ParameterManager.V1 
 
 ; 
 public 
  
 class 
  
 GetRegionalParameterSample 
 { 
  
 /// <summary> 
  
 /// This function retrieves a regional parameter using the Parameter Manager SDK for GCP. 
  
 /// </summary> 
  
 /// <param name="projectId">The ID of the project where the parameter is located.</param> 
  
 /// <param name="locationId">The ID of the region where the parameter is located.</param> 
  
 /// <param name="parameterId">The ID of the parameter to be retrieved.</param> 
  
 /// <returns>The retrieved Parameter object.</returns> 
  
 public 
  
 Parameter 
  
 GetRegionalParameter 
 ( 
  
 string 
  
 projectId 
 , 
  
 string 
  
 locationId 
 , 
  
 string 
  
 parameterId 
 ) 
  
 { 
  
 // Define the regional endpoint 
  
 string 
  
 regionalEndpoint 
  
 = 
  
 $"parametermanager.{locationId}.rep.googleapis.com" 
 ; 
  
 // Create the client with the regional endpoint 
  
  ParameterManagerClient 
 
  
 client 
  
 = 
  
 new 
  
  ParameterManagerClientBuilder 
 
  
 { 
  
 Endpoint 
  
 = 
  
 regionalEndpoint 
  
 }. 
  Build 
 
 (); 
  
 // Build the resource name for the parameter in the specified regional locationId 
  
  ParameterName 
 
  
 parameterName 
  
 = 
  
 new 
  
  ParameterName 
 
 ( 
 projectId 
 , 
  
 locationId 
 , 
  
 parameterId 
 ); 
  
 // Call the API to get the parameter 
  
 Parameter 
  
 parameter 
  
 = 
  
 client 
 . 
  GetParameter 
 
 ( 
 parameterName 
 ); 
  
 // Print the retrieved parameter name 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Found the regional parameter {parameter. Name 
} with format {parameter. Format 
}" 
 ); 
  
 // Return the retrieved parameter 
  
 return 
  
 parameter 
 ; 
  
 } 
 }

    Go

    To run this code, first set up a Go development environment and install the Parameter Manager Go SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 parametermanager 
  
 "cloud.google.com/go/parametermanager/apiv1" 
  
 parametermanagerpb 
  
 "cloud.google.com/go/parametermanager/apiv1/parametermanagerpb" 
  
 "google.golang.org/api/option" 
 ) 
 // getRegionalParam gets a parameter regional using the Parameter Manager SDK for GCP. 
 // 
 // w: The io.Writer object used to write the output. 
 // projectID: The ID of the project where the parameter is located. 
 // locationID: The ID of the region where the parameter is located. 
 // parameterID: The ID of the parameter to be retrieved. 
 // 
 // The function returns an error if the parameter retrieval fails. 
 func 
  
 getRegionalParam 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 locationID 
 , 
  
 parameterID 
  
 string 
 ) 
  
 error 
  
 { 
  
 // Create a new context. 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 // Create a Parameter Manager client. 
  
 endpoint 
  
 := 
  
 fmt 
 . 
 Sprintf 
 ( 
 "parametermanager.%s.rep.googleapis.com:443" 
 , 
  
 locationID 
 ) 
  
 client 
 , 
  
 err 
  
 := 
  
 parametermanager 
 . 
  NewClient 
 
 ( 
 ctx 
 , 
  
 option 
 . 
 WithEndpoint 
 ( 
 endpoint 
 )) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "failed to create Parameter Manager client: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
  Close 
 
 () 
  
 // Construct the name of the parameter to retrieve. 
  
 name 
  
 := 
  
 fmt 
 . 
 Sprintf 
 ( 
 "projects/%s/locations/%s/parameters/%s" 
 , 
  
 projectID 
 , 
  
 locationID 
 , 
  
 parameterID 
 ) 
  
 // Build the request to get the parameter. 
  
 req 
  
 := 
  
& parametermanagerpb 
 . 
 GetParameterRequest 
 { 
  
 Name 
 : 
  
 name 
 , 
  
 } 
  
 // Call the API to get the parameter. 
  
 param 
 , 
  
 err 
  
 := 
  
 client 
 . 
 GetParameter 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "failed to get parameter: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 // Find more details for the Parameter object here: 
  
 // https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters#Parameter 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Found regional parameter %s with format %s\n" 
 , 
  
 param 
 . 
 Name 
 , 
  
 param 
 . 
 Format 
 . 
 String 
 ()) 
  
 return 
  
 nil 
 }

    Java

    To run this code, first set up a Java development environment and install the Parameter Manager Java SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      import 
  
 com.google.cloud.parametermanager.v1. Parameter 
 
 ; 
 import 
  
 com.google.cloud.parametermanager.v1. ParameterManagerClient 
 
 ; 
 import 
  
 com.google.cloud.parametermanager.v1. ParameterManagerSettings 
 
 ; 
 import 
  
 com.google.cloud.parametermanager.v1. ParameterName 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 /** 
 * This class demonstrates how to get a regional parameter using the Parameter Manager SDK for GCP. 
 */ 
 public 
  
 class 
 GetRegionalParam 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ; 
  
 String 
  
 locationId 
  
 = 
  
 "your-location-id" 
 ; 
  
 String 
  
 parameterId 
  
 = 
  
 "your-parameter-id" 
 ; 
  
 // Call the method to get a regional parameter. 
  
 getRegionalParam 
 ( 
 projectId 
 , 
  
 locationId 
 , 
  
 parameterId 
 ); 
  
 } 
  
 // This is an example snippet that gets a regional parameter. 
  
 public 
  
 static 
  
  Parameter 
 
  
 getRegionalParam 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 locationId 
 , 
  
 String 
  
 parameterId 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // Endpoint to call the regional parameter manager server 
  
 String 
  
 apiEndpoint 
  
 = 
  
 String 
 . 
 format 
 ( 
 "parametermanager.%s.rep.googleapis.com:443" 
 , 
  
 locationId 
 ); 
  
  ParameterManagerSettings 
 
  
 parameterManagerSettings 
  
 = 
  
  ParameterManagerSettings 
 
 . 
 newBuilder 
 (). 
 setEndpoint 
 ( 
 apiEndpoint 
 ). 
 build 
 (); 
  
 // Initialize the client that will be used to send requests. This client only 
  
 // needs to be created once, and can be reused for multiple requests. 
  
 try 
  
 ( 
  ParameterManagerClient 
 
  
 client 
  
 = 
  
  ParameterManagerClient 
 
 . 
 create 
 ( 
 parameterManagerSettings 
 )) 
  
 { 
  
 // Build the parameter name. 
  
  ParameterName 
 
  
 parameterName 
  
 = 
  
  ParameterName 
 
 . 
 of 
 ( 
 projectId 
 , 
  
 locationId 
 , 
  
 parameterId 
 ); 
  
 // Get the parameter. 
  
  Parameter 
 
  
 parameter 
  
 = 
  
 client 
 . 
 getParameter 
 ( 
 parameterName 
 . 
  toString 
 
 ()); 
  
 // Find more details for the Parameter object here: 
  
 // https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters#Parameter 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
  
 "Found the regional parameter %s with format %s\n" 
 , 
  
 parameter 
 . 
  getName 
 
 (), 
  
 parameter 
 . 
  getFormat 
 
 ()); 
  
 return 
  
 parameter 
 ; 
  
 } 
  
 } 
 }

    Node.js

    To run this code, first set up a Node.js development environment and install the Parameter Manager Node.js SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      /** 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
 // const projectId = 'my-project'; 
 // const locationId = 'us-central1'; 
 // const parameterId = 'my-parameter'; 
 // Imports the Parameter Manager library 
 const 
  
 { 
 ParameterManagerClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/parametermanager 
' 
 ); 
 // Adding the endpoint to call the regional parameter manager server 
 const 
  
 options 
  
 = 
  
 { 
  
 apiEndpoint 
 : 
  
 `parametermanager. 
 ${ 
 locationId 
 } 
 .rep.googleapis.com` 
 , 
 }; 
 // Instantiates a client with regional endpoint 
 const 
  
 client 
  
 = 
  
 new 
  
  ParameterManagerClient 
 
 ( 
 options 
 ); 
 async 
  
 function 
  
 getRegionalParam 
 () 
  
 { 
  
 // Construct the fully qualified parameter name 
  
 const 
  
 name 
  
 = 
  
 client 
 . 
  parameterPath 
 
 ( 
 projectId 
 , 
  
 locationId 
 , 
  
 parameterId 
 ); 
  
 // Get the parameter 
  
 const 
  
 [ 
 parameter 
 ] 
  
 = 
  
 await 
  
 client 
 . 
 getParameter 
 ({ 
  
 name 
 : 
  
 name 
 , 
  
 }); 
  
 // Find more details for the Parameter object here: 
  
 // https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters#Parameter 
  
 console 
 . 
 log 
 ( 
  
 `Found regional parameter 
 ${ 
 parameter 
 . 
 name 
 } 
 with format 
 ${ 
 parameter 
 . 
 format 
 } 
 ` 
  
 ); 
  
 return 
  
 parameter 
 ; 
 } 
 return 
  
 await 
  
 getRegionalParam 
 ();

    PHP

    To run this code, first learn about using PHP on Google Cloud and install the Parameter Manager PHP SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      // Import necessary classes for retrieve a parameter version. 
 use Google\Cloud\ParameterManager\V1\Client\ParameterManagerClient; 
 use Google\Cloud\ParameterManager\V1\GetParameterRequest; 
 use Google\Cloud\ParameterManager\V1\ParameterFormat; 
 /** 
 * Retrieves a regional parameter using the Parameter Manager SDK for GCP. 
 * 
 * @param string $projectId The Google Cloud Project ID (e.g. 'my-project') 
 * @param string $locationId The Parameter Location (e.g. 'us-central1') 
 * @param string $parameterId The Parameter ID (e.g. 'my-param') 
 */ 
 function get_regional_param(string $projectId, string $locationId, string $parameterId): void 
 { 
 // Specify regional endpoint. 
 $options = ['apiEndpoint' => "parametermanager.$locationId.rep.googleapis.com"]; 
 // Create a client for the Parameter Manager service. 
 $client = new ParameterManagerClient($options); 
 // Build the resource name of the parameter. 
 $parameterName = $client->parameterName($projectId, $locationId, $parameterId); 
 // Prepare the request to get the parameter. 
 $request = (new GetParameterRequest()) 
 ->setName($parameterName); 
 // Retrieve the parameter using the client. 
 $parameter = $client->getParameter($request); 
 // Print the retrieved parameter details. 
 printf('Found regional parameter %s with format %s' . PHP_EOL, $parameter->getName(), ParameterFormat::name($parameter->getFormat())); 
 }

    Python

    To run this code, first set up a Python development environment and install the Parameter Manager Python SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      def 
  
 get_regional_param 
 ( 
 project_id 
 : 
 str 
 , 
 location_id 
 : 
 str 
 , 
 parameter_id 
 : 
 str 
 ) 
 - 
> parametermanager_v1 
 . 
 Parameter 
 : 
  
 """ 
 Retrieves a parameter from the specified region of the specified 
 project using the Google Cloud Parameter Manager SDK. 
 Args: 
 project_id (str): The ID of the project where the parameter is located. 
 location_id (str): The ID of the region where the parameter is located. 
 parameter_id (str): The ID of the parameter to retrieve. 
 Returns: 
 parametermanager_v1.Parameter: An object representing the parameter. 
 Example: 
 get_regional_param( 
 "my-project", 
 "us-central1", 
 "my-regional-parameter" 
 ) 
 """ 
 # Import the necessary library for Google Cloud Parameter Manager. 
 from 
  
 google.cloud 
  
 import 
  parametermanager_v1 
 
 # Create the Parameter Manager client with the regional endpoint. 
 api_endpoint 
 = 
 f 
 "parametermanager. 
 { 
 location_id 
 } 
 .rep.googleapis.com" 
 client 
 = 
  parametermanager_v1 
 
 . 
  ParameterManagerClient 
 
 ( 
 client_options 
 = 
 { 
 "api_endpoint" 
 : 
 api_endpoint 
 } 
 ) 
 # Build the resource name of the parameter. 
 name 
 = 
 client 
 . 
  parameter_path 
 
 ( 
 project_id 
 , 
 location_id 
 , 
 parameter_id 
 ) 
 # Retrieve the parameter. 
 parameter 
 = 
 client 
 . 
  get_parameter 
 
 ( 
 name 
 = 
 name 
 ) 
 # Show parameter details. 
 # Find more details for the Parameter object here: 
 # https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters#Parameter 
 print 
 ( 
 f 
 "Found the regional parameter 
 { 
 parameter 
 . 
 name 
 } 
 with format 
 { 
 parameter 
 . 
 format_ 
 . 
 name 
 } 
 " 
 )

    Ruby

    To run this code, first set up a Ruby development environment and install the Parameter Manager Ruby SDK . On Compute Engine or GKE, you must authenticate with the cloud-platform scope .

      require 
  
 "google/cloud/parameter_manager" 
 ## 
 # Retrieve a regional parameter 
 # 
 # @param project_id [String] The Google Cloud project (e.g. "my-project") 
 # @param location_id [String] The location name (e.g. "us-central1") 
 # @param parameter_id [String] The parameter name (e.g. "my-parameter") 
 # 
 def 
  
 get_regional_param 
  
 project_id 
 :, 
  
 location_id 
 :, 
  
 parameter_id 
 : 
  
 # Endpoint for the regional parameter manager service. 
  
 api_endpoint 
  
 = 
  
 "parametermanager. 
 #{ 
 location_id 
 } 
 .rep.googleapis.com" 
  
 # Create the Parameter Manager client. 
  
 client 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  ParameterManager 
 
 . 
  parameter_manager 
 
  
 do 
  
 | 
 config 
 | 
  
 config 
 . 
 endpoint 
  
 = 
  
 api_endpoint 
  
 end 
  
 # Build the resource name of the parent project. 
  
 name 
  
 = 
  
 client 
 . 
  parameter_path 
 
  
 project 
 : 
  
 project_id 
 , 
  
 location 
 : 
  
 location_id 
 , 
  
 parameter 
 : 
  
 parameter_id 
  
 # Retrieve the parameter. 
  
 param 
  
 = 
  
 client 
 . 
 get_parameter 
  
 name 
 : 
  
 name 
  
 # Print the retrieved parameter name. 
  
 puts 
  
 "Found regional parameter 
 #{ 
 param 
 . 
 name 
 } 
 with format 
 #{ 
 param 
 . 
  format 
 
 } 
 " 
 end

    The response is the parameter object, which contains the metadata of the parameter.

    What's next
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: