Apigee.Organizations.UpdateControlPlaneAccess (Apigee API v1-rev20251125-2.0.0)

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.apigee.v1.ApigeeRequest<GoogleLongrunningOperation>
        
        com.google.api.services.apigee.v1.Apigee.Organizations.UpdateControlPlaneAccess

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Apigee.Organizations

public class Apigee.Organizations.UpdateControlPlaneAccess
extends ApigeeRequest<GoogleLongrunningOperation>

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`	`UpdateControlPlaneAccess(String name, GoogleCloudApigeeV1ControlPlaneAccess content)` Updates the permissions required to allow Apigee runtime-plane components access to the control plane.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getName()` Identifier.
`String`	`getUpdateMask()` List of fields to be updated.
`Apigee.Organizations.UpdateControlPlaneAccess`	`set(String parameterName, Object value)`
`Apigee.Organizations.UpdateControlPlaneAccess`	`set$Xgafv(String $Xgafv)` V1 error format.
`Apigee.Organizations.UpdateControlPlaneAccess`	`setAccessToken(String accessToken)` OAuth access token.
`Apigee.Organizations.UpdateControlPlaneAccess`	`setAlt(String alt)` Data format for response.
`Apigee.Organizations.UpdateControlPlaneAccess`	`setCallback(String callback)` JSONP
`Apigee.Organizations.UpdateControlPlaneAccess`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Apigee.Organizations.UpdateControlPlaneAccess`	`setKey(String key)` API key.
`Apigee.Organizations.UpdateControlPlaneAccess`	`setName(String name)` Identifier.
`Apigee.Organizations.UpdateControlPlaneAccess`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Apigee.Organizations.UpdateControlPlaneAccess`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Apigee.Organizations.UpdateControlPlaneAccess`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Apigee.Organizations.UpdateControlPlaneAccess`	`setUpdateMask(String updateMask)` List of fields to be updated.
`Apigee.Organizations.UpdateControlPlaneAccess`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Apigee.Organizations.UpdateControlPlaneAccess`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.apigee.v1.ApigeeRequest
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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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
  - UpdateControlPlaneAccess
```
protected UpdateControlPlaneAccess(String name,
                                   GoogleCloudApigeeV1ControlPlaneAccess content)
```
    Updates the permissions required to allow Apigee runtime-plane components access to the control plane. Currently, the permissions required are to: 1. Allow runtime components to publish analytics data to the control plane. **Note**: Available to Apigee hybrid only. Create a request for the method "organizations.updateControlPlaneAccess". This request holds the parameters needed by the the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    UpdateControlPlaneAccess#initialize(com.google.api.client.googleapis.serv ices.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    name - Identifier. The resource name of the ControlPlaneAccess. Format: "organizations/{org}/controlPlaneAccess"
    
    content - the GoogleCloudApigeeV1ControlPlaneAccess
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Apigee.Organizations.UpdateControlPlaneAccess set$Xgafv(String $Xgafv)
```
    Description copied from class: ApigeeRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ApigeeRequest<GoogleLongrunningOperation>
  - setAccessToken
```
public Apigee.Organizations.UpdateControlPlaneAccess setAccessToken(String accessToken)
```
    Description copied from class: ApigeeRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ApigeeRequest<GoogleLongrunningOperation>
  - setAlt
```
public Apigee.Organizations.UpdateControlPlaneAccess setAlt(String alt)
```
    Description copied from class: ApigeeRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ApigeeRequest<GoogleLongrunningOperation>
  - setCallback
```
public Apigee.Organizations.UpdateControlPlaneAccess setCallback(String callback)
```
    Description copied from class: ApigeeRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ApigeeRequest<GoogleLongrunningOperation>
  - setFields
```
public Apigee.Organizations.UpdateControlPlaneAccess setFields(String fields)
```
    Description copied from class: ApigeeRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ApigeeRequest<GoogleLongrunningOperation>
  - setKey
```
public Apigee.Organizations.UpdateControlPlaneAccess setKey(String key)
```
    Description copied from class: ApigeeRequest
    
    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 ApigeeRequest<GoogleLongrunningOperation>
  - setOauthToken
```
public Apigee.Organizations.UpdateControlPlaneAccess setOauthToken(String oauthToken)
```
    Description copied from class: ApigeeRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ApigeeRequest<GoogleLongrunningOperation>
  - setPrettyPrint
```
public Apigee.Organizations.UpdateControlPlaneAccess setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ApigeeRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ApigeeRequest<GoogleLongrunningOperation>
  - setQuotaUser
```
public Apigee.Organizations.UpdateControlPlaneAccess setQuotaUser(String quotaUser)
```
    Description copied from class: ApigeeRequest
    
    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 ApigeeRequest<GoogleLongrunningOperation>
  - setUploadType
```
public Apigee.Organizations.UpdateControlPlaneAccess setUploadType(String uploadType)
```
    Description copied from class: ApigeeRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ApigeeRequest<GoogleLongrunningOperation>
  - setUploadProtocol
```
public Apigee.Organizations.UpdateControlPlaneAccess setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ApigeeRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ApigeeRequest<GoogleLongrunningOperation>
  - getName
```
public String getName()
```
    Identifier. The resource name of the ControlPlaneAccess. Format: "organizations/{org}/controlPlaneAccess"
  - setName
```
public Apigee.Organizations.UpdateControlPlaneAccess setName(String name)
```
    Identifier. The resource name of the ControlPlaneAccess. Format: "organizations/{org}/controlPlaneAccess"
  - getUpdateMask
```
public String getUpdateMask()
```
    List of fields to be updated. Fields that can be updated: synchronizer_identities, publisher_identities.
  - setUpdateMask
```
public Apigee.Organizations.UpdateControlPlaneAccess setUpdateMask(String updateMask)
```
    List of fields to be updated. Fields that can be updated: synchronizer_identities, publisher_identities.
  - set
```
public Apigee.Organizations.UpdateControlPlaneAccess set(String parameterName,
                                                         Object value)
```
    Overrides:
    
    set in class ApigeeRequest<GoogleLongrunningOperation>

Class Apigee.Organizations.UpdateControlPlaneAccess

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.apigee.v1.ApigeeRequest

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

UpdateControlPlaneAccess

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getName

setName

getUpdateMask

setUpdateMask

set