Method: managedZoneOperations.list

Enumerates Operations for the given ManagedZone.

HTTP request

GET https://dns.googleapis.com/dns/v1/projects/{project}/managedZones/{managedZone}/operations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Identifies the project addressed by this request.

managedZone

string

Identifies the managed zone addressed by this request.

Query parameters

Parameters
maxResults

integer

Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.

pageToken

string

Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.

sortBy

enum (SortBy)

Sorting criterion. The only supported values are START_TIME and ID.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "operations": [
    {
      object (Operation)
    }
  ],
  "nextPageToken": string,
  "kind": string
}
Fields
operations[]

object (Operation)

The operation resources.

nextPageToken

string

This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time.

However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.

kind

string

Type of resource.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/ndev.clouddns.readonly
  • https://www.googleapis.com/auth/ndev.clouddns.readwrite

For more information, see the Authentication Overview.

SortBy

Enums
startTime
id

Examples

Uses the .NET client library.

// BEFORE RUNNING:
// ---------------
// 1. If not already done, enable the Google Cloud DNS API
//    and check the quota for your project at
//    https://console.developers.google.com/apis/api/dns
// 2. This sample uses Application Default Credentials for authentication.
//    If not already done, install the gcloud CLI from
//    https://cloud.google.com/sdk and run
//    `gcloud beta auth application-default login`.
//    For more information, see
//    https://developers.google.com/identity/protocols/application-default-credentials
// 3. Install the C# client library by adding a dependency on the relevant NuGet
//    package. Libraries published by Google are owned by google-apis-packages:
//    https://www.nuget.org/profiles/google-apis-packages

using Google.Apis.Auth.OAuth2;
using Google.Apis.Dns.v1;
using Google.Apis.Services;
using Newtonsoft.Json;
using System;
using System.Threading.Tasks;

using Data = Google.Apis.Dns.v1.Data;

namespace DnsSample
{
   
public class DnsExample
   
{
       
public static void Main(string[] args)
       
{
           
DnsService dnsService = new DnsService(new BaseClientService.Initializer
           
{
               
HttpClientInitializer = GetCredential(),
               
ApplicationName = "Google-DnsSample/0.1",
           
});

           
// Identifies the project addressed by this request.
           
string project = "my-project";  // TODO: Update placeholder value.

           
// Identifies the managed zone addressed by this request.
           
string managedZone = "my-managed-zone";  // TODO: Update placeholder value.

           
ManagedZoneOperationsResource.ListRequest request = dnsService.ManagedZoneOperations.List(project, managedZone);

           
Data.ManagedZoneOperationsListResponse response;
           
do
           
{
               
// To execute asynchronously in an async method, replace `request.Execute()` as shown:
                response
= request.Execute();
               
// response = await request.ExecuteAsync();

               
if (response.Operations == null)
               
{
                   
continue;
               
}
               
foreach (Data.Operation operation in response.Operations)
               
{
                   
// TODO: Change code below to process each `operation` resource:
                   
Console.WriteLine(JsonConvert.SerializeObject(operation));
               
}
                request
.PageToken = response.NextPageToken;
           
} while (response.NextPageToken != null);
       
}

       
public static GoogleCredential GetCredential()
       
{
           
GoogleCredential credential = Task.Run(() => GoogleCredential.GetApplicationDefaultAsync()).Result;
           
if (credential.IsCreateScopedRequired)
           
{
                credential
= credential.CreateScoped("https://www.googleapis.com/auth/cloud-platform");
           
}
           
return credential;
       
}
   
}
}

Uses the Java client library.

/*
 * BEFORE RUNNING:
 * ---------------
 * 1. If not already done, enable the Google Cloud DNS API
 *    and check the quota for your project at
 *    https://console.developers.google.com/apis/api/dns
 * 2. This sample uses Application Default Credentials for authentication.
 *    If not already done, install the gcloud CLI from
 *    https://cloud.google.com/sdk and run
 *    `gcloud beta auth application-default login`.
 *    For more information, see
 *    https://developers.google.com/identity/protocols/application-default-credentials
 * 3. Install the Java client library on Maven or Gradle. Check installation
 *    instructions at https://github.com/google/google-api-java-client.
 *    On other build systems, you can add the jar files to your project from
 *    https://developers.google.com/resources/api-libraries/download/dns/v1/java
 */

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.dns.Dns;
import com.google.api.services.dns.model.ManagedZoneOperationsListResponse;
import com.google.api.services.dns.model.Operation;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.util.Arrays;

public class DnsExample {
 
public static void main(String args[]) throws IOException, GeneralSecurityException {
   
// Identifies the project addressed by this request.
   
String project = "my-project"; // TODO: Update placeholder value.

   
// Identifies the managed zone addressed by this request.
   
String managedZone = "my-managed-zone"; // TODO: Update placeholder value.

   
Dns dnsService = createDnsService();
   
Dns.ManagedZoneOperations.List request =
        dnsService
.managedZoneOperations().list(project, managedZone);

   
ManagedZoneOperationsListResponse response;
   
do {
      response
= request.execute();
     
if (response.getOperations() == null) {
       
continue;
     
}
     
for (Operation operation : response.getOperations()) {
       
// TODO: Change code below to process each `operation` resource:
       
System.out.println(operation);
     
}
      request
.setPageToken(response.getNextPageToken());
   
} while (response.getNextPageToken() != null);
 
}

 
public static Dns createDnsService() throws IOException, GeneralSecurityException {
   
HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
   
JsonFactory jsonFactory = JacksonFactory.getDefaultInstance();

   
GoogleCredential credential = GoogleCredential.getApplicationDefault();
   
if (credential.createScopedRequired()) {
      credential
=
          credential
.createScoped(Arrays.asList("https://www.googleapis.com/auth/cloud-platform"));
   
}

   
return new Dns.Builder(httpTransport, jsonFactory, credential)
       
.setApplicationName("Google-DnsSample/0.1")
       
.build();
 
}
}

Uses the Node.js client library.

// BEFORE RUNNING:
// ---------------
// 1. If not already done, enable the Google Cloud DNS API
//    and check the quota for your project at
//    https://console.developers.google.com/apis/api/dns
// 2. This sample uses Application Default Credentials for authentication.
//    If not already done, install the gcloud CLI from
//    https://cloud.google.com/sdk and run
//    `gcloud beta auth application-default login`.
//    For more information, see
//    https://developers.google.com/identity/protocols/application-default-credentials
// 3. Install the Node.js client library by running
//    `npm install googleapis --save`

const {google} = require('googleapis');
const dns = google.dns('v1');

async
function main () {
 
const authClient = await authorize();
 
const request = {
   
// Identifies the project addressed by this request.
    project
: 'my-project',  // TODO: Update placeholder value.

   
// Identifies the managed zone addressed by this request.
    managedZone
: 'my-managed-zone',  // TODO: Update placeholder value.

    auth
: authClient,
 
};

  let response
;
 
do {
   
if (response && response.nextPageToken) {
      request
.pageToken = response.nextPageToken;
   
}
    response
= (await dns.managedZoneOperations.list(request)).data;
   
const operationsPage = response.operations;
   
if (operationsPage) {
     
for (let i = 0; i < operationsPage.length; i++) {
       
// TODO: Change code below to process each resource in `operationsPage`:
        console
.log(JSON.stringify(operationsPage[i], null, 2));
     
}
   
}
 
} while (response.nextPageToken);
}
main
();

async
function authorize() {
 
const auth = new google.auth.GoogleAuth({
    scopes
: ['https://www.googleapis.com/auth/cloud-platform']
 
});
 
return await auth.getClient();
}

Uses the Python client library.

"""
BEFORE RUNNING:
---------------
1. If not already done, enable the Google Cloud DNS API
   and check the quota for your project at
   https://console.developers.google.com/apis/api/dns
2. This sample uses Application Default Credentials for authentication.
   If not already done, install the gcloud CLI from
   https://cloud.google.com/sdk and run
   `gcloud beta auth application-default login`.
   For more information, see
   https://developers.google.com/identity/protocols/application-default-credentials
3. Install the Python client library for Google APIs by running
   `pip install --upgrade google-api-python-client`
"""

from pprint import pprint

from googleapiclient import discovery
from oauth2client.client import GoogleCredentials

credentials
= GoogleCredentials.get_application_default()

service
= discovery.build('dns', 'v1', credentials=credentials)

# Identifies the project addressed by this request.
project
= 'my-project'  # TODO: Update placeholder value.

# Identifies the managed zone addressed by this request.
managed_zone
= 'my-managed-zone'  # TODO: Update placeholder value.

request
= service.managedZoneOperations().list(project=project, managedZone=managed_zone)
while request is not None:
    response
= request.execute()

   
for operation in response['operations']:
       
# TODO: Change code below to process each `operation` resource:
        pprint
(operation)

    request
= service.managedZoneOperations().list_next(previous_request=request, previous_response=response)