com.google.api.services.cloudbuild.v2

Class CloudBuild.Projects.Locations.List

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.cloudbuild.v2.CloudBuildRequest<ListLocationsResponse>

com.google.api.services.cloudbuild.v2.CloudBuild.Projects.Locations.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudBuild.Projects.Locations

public class CloudBuild.Projects.Locations.List
extends CloudBuildRequest<ListLocationsResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List(String name) Lists information about the supported locations for this service.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
List<String>	getExtraLocationTypes() Optional.
String	getFilter() A filter to narrow down results to a preferred subset.
String	getName() The resource that owns the locations collection, if applicable.
Integer	getPageSize() The maximum number of results to return.
String	getPageToken() A page token received from the `next_page_token` field in the response.
CloudBuild.Projects.Locations.List	set(String parameterName, Object value)
CloudBuild.Projects.Locations.List	set$Xgafv(String $Xgafv) V1 error format.
CloudBuild.Projects.Locations.List	setAccessToken(String accessToken) OAuth access token.
CloudBuild.Projects.Locations.List	setAlt(String alt) Data format for response.
CloudBuild.Projects.Locations.List	setCallback(String callback) JSONP
CloudBuild.Projects.Locations.List	setExtraLocationTypes(List<String> extraLocationTypes) Optional.
CloudBuild.Projects.Locations.List	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudBuild.Projects.Locations.List	setFilter(String filter) A filter to narrow down results to a preferred subset.
CloudBuild.Projects.Locations.List	setKey(String key) API key.
CloudBuild.Projects.Locations.List	setName(String name) The resource that owns the locations collection, if applicable.
CloudBuild.Projects.Locations.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudBuild.Projects.Locations.List	setPageSize(Integer pageSize) The maximum number of results to return.
CloudBuild.Projects.Locations.List	setPageToken(String pageToken) A page token received from the `next_page_token` field in the response.
CloudBuild.Projects.Locations.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudBuild.Projects.Locations.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudBuild.Projects.Locations.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudBuild.Projects.Locations.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.cloudbuild.v2.CloudBuildRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

List

protected List(String name)

Lists information about the supported locations for this service. Create a request for the method "locations.list". This request holds the parameters needed by the the cloudbuild server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

CloudBuild.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

name - The resource that owns the locations collection, if applicable.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListLocationsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListLocationsResponse>

Throws:

IOException

set$Xgafv

public CloudBuild.Projects.Locations.List set$Xgafv(String $Xgafv)

Description copied from class: CloudBuildRequest

V1 error format.

Overrides:

set$Xgafv in class CloudBuildRequest<ListLocationsResponse>

setAccessToken

public CloudBuild.Projects.Locations.List setAccessToken(String accessToken)

Description copied from class: CloudBuildRequest

OAuth access token.

Overrides:

setAccessToken in class CloudBuildRequest<ListLocationsResponse>

setAlt

public CloudBuild.Projects.Locations.List setAlt(String alt)

Description copied from class: CloudBuildRequest

Data format for response.

Overrides:

setAlt in class CloudBuildRequest<ListLocationsResponse>

setCallback

public CloudBuild.Projects.Locations.List setCallback(String callback)

Description copied from class: CloudBuildRequest

JSONP

Overrides:

setCallback in class CloudBuildRequest<ListLocationsResponse>

setFields

public CloudBuild.Projects.Locations.List setFields(String fields)

Description copied from class: CloudBuildRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudBuildRequest<ListLocationsResponse>

setKey

public CloudBuild.Projects.Locations.List setKey(String key)

Description copied from class: CloudBuildRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class CloudBuildRequest<ListLocationsResponse>

setOauthToken

public CloudBuild.Projects.Locations.List setOauthToken(String oauthToken)

Description copied from class: CloudBuildRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudBuildRequest<ListLocationsResponse>

setPrettyPrint

public CloudBuild.Projects.Locations.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudBuildRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudBuildRequest<ListLocationsResponse>

setQuotaUser

public CloudBuild.Projects.Locations.List setQuotaUser(String quotaUser)

Description copied from class: CloudBuildRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class CloudBuildRequest<ListLocationsResponse>

setUploadType

public CloudBuild.Projects.Locations.List setUploadType(String uploadType)

Description copied from class: CloudBuildRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class CloudBuildRequest<ListLocationsResponse>

setUploadProtocol

public CloudBuild.Projects.Locations.List setUploadProtocol(String uploadProtocol)

Description copied from class: CloudBuildRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class CloudBuildRequest<ListLocationsResponse>

getName

public String getName()

The resource that owns the locations collection, if applicable.

setName

public CloudBuild.Projects.Locations.List setName(String name)

The resource that owns the locations collection, if applicable.

getExtraLocationTypes

public List<String> getExtraLocationTypes()

Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

setExtraLocationTypes

public CloudBuild.Projects.Locations.List setExtraLocationTypes(List<String> extraLocationTypes)

Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

getFilter

public String getFilter()

A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

setFilter

public CloudBuild.Projects.Locations.List setFilter(String filter)

A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

getPageSize

public Integer getPageSize()

The maximum number of results to return. If not set, the service selects a default.

setPageSize

public CloudBuild.Projects.Locations.List setPageSize(Integer pageSize)

The maximum number of results to return. If not set, the service selects a default.

getPageToken

public String getPageToken()

A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

setPageToken

public CloudBuild.Projects.Locations.List setPageToken(String pageToken)

A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

set

public CloudBuild.Projects.Locations.List set(String parameterName,
                                              Object value)

Overrides:

set in class CloudBuildRequest<ListLocationsResponse>