GoogleCloudApigeeV1Environment (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.json.GenericJson
    - - com.google.api.services.apigee.v1.model.GoogleCloudApigeeV1Environment

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudApigeeV1Environment
extends com.google.api.client.json.GenericJson
```
Model definition for GoogleCloudApigeeV1Environment.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Apigee API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudApigeeV1Environment()

Constructors
Constructor and Description
`GoogleCloudApigeeV1Environment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudApigeeV1Environment`	`clone()`
`String`	`getApiProxyType()` Optional.
`GoogleCloudApigeeV1EnvironmentClientIPResolutionConfig`	`getClientIpResolutionConfig()` Optional.
`Long`	`getCreatedAt()` Output only.
`String`	`getDeploymentType()` Optional.
`String`	`getDescription()` Optional.
`String`	`getDisplayName()` Optional.
`String`	`getForwardProxyUri()` Optional.
`Boolean`	`getHasAttachedFlowHooks()`
`Long`	`getLastModifiedAt()` Output only.
`String`	`getName()` Required.
`GoogleCloudApigeeV1NodeConfig`	`getNodeConfig()` Optional.
`GoogleCloudApigeeV1Properties`	`getProperties()` Optional.
`String`	`getState()` Output only.
`String`	`getType()` Optional.
`GoogleCloudApigeeV1Environment`	`set(String fieldName, Object value)`
`GoogleCloudApigeeV1Environment`	`setApiProxyType(String apiProxyType)` Optional.
`GoogleCloudApigeeV1Environment`	`setClientIpResolutionConfig(GoogleCloudApigeeV1EnvironmentClientIPResolutionConfig clientIpResolutionConfig)` Optional.
`GoogleCloudApigeeV1Environment`	`setCreatedAt(Long createdAt)` Output only.
`GoogleCloudApigeeV1Environment`	`setDeploymentType(String deploymentType)` Optional.
`GoogleCloudApigeeV1Environment`	`setDescription(String description)` Optional.
`GoogleCloudApigeeV1Environment`	`setDisplayName(String displayName)` Optional.
`GoogleCloudApigeeV1Environment`	`setForwardProxyUri(String forwardProxyUri)` Optional.
`GoogleCloudApigeeV1Environment`	`setHasAttachedFlowHooks(Boolean hasAttachedFlowHooks)`
`GoogleCloudApigeeV1Environment`	`setLastModifiedAt(Long lastModifiedAt)` Output only.
`GoogleCloudApigeeV1Environment`	`setName(String name)` Required.
`GoogleCloudApigeeV1Environment`	`setNodeConfig(GoogleCloudApigeeV1NodeConfig nodeConfig)` Optional.
`GoogleCloudApigeeV1Environment`	`setProperties(GoogleCloudApigeeV1Properties properties)` Optional.
`GoogleCloudApigeeV1Environment`	`setState(String state)` Output only.
`GoogleCloudApigeeV1Environment`	`setType(String type)` Optional.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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
  - GoogleCloudApigeeV1Environment
```
public GoogleCloudApigeeV1Environment()
```
- Method Detail
  - getApiProxyType
```
public String getApiProxyType()
```
    Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
    
    Returns:
    
    value or null for none
  - setApiProxyType
```
public GoogleCloudApigeeV1Environment setApiProxyType(String apiProxyType)
```
    Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
    
    Parameters:
    
    apiProxyType - apiProxyType or null for none
  - getClientIpResolutionConfig
```
public GoogleCloudApigeeV1EnvironmentClientIPResolutionConfig getClientIpResolutionConfig()
```
    Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution.
    
    Returns:
    
    value or null for none
  - setClientIpResolutionConfig
```
public GoogleCloudApigeeV1Environment setClientIpResolutionConfig(GoogleCloudApigeeV1EnvironmentClientIPResolutionConfig clientIpResolutionConfig)
```
    Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution.
    
    Parameters:
    
    clientIpResolutionConfig - clientIpResolutionConfig or null for none
  - getCreatedAt
```
public Long getCreatedAt()
```
    Output only. Creation time of this environment as milliseconds since epoch.
    
    Returns:
    
    value or null for none
  - setCreatedAt
```
public GoogleCloudApigeeV1Environment setCreatedAt(Long createdAt)
```
    Output only. Creation time of this environment as milliseconds since epoch.
    
    Parameters:
    
    createdAt - createdAt or null for none
  - getDeploymentType
```
public String getDeploymentType()
```
    Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local- development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
    
    Returns:
    
    value or null for none
  - setDeploymentType
```
public GoogleCloudApigeeV1Environment setDeploymentType(String deploymentType)
```
    Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local- development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
    
    Parameters:
    
    deploymentType - deploymentType or null for none
  - getDescription
```
public String getDescription()
```
    Optional. Description of the environment.
    
    Returns:
    
    value or null for none
  - setDescription
```
public GoogleCloudApigeeV1Environment setDescription(String description)
```
    Optional. Description of the environment.
    
    Parameters:
    
    description - description or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Optional. Display name for this environment.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public GoogleCloudApigeeV1Environment setDisplayName(String displayName)
```
    Optional. Display name for this environment.
    
    Parameters:
    
    displayName - displayName or null for none
  - getForwardProxyUri
```
public String getForwardProxyUri()
```
    Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the only supported scheme is "http". The port must be supplied. To remove a forward proxy setting, update the field to an empty value. Note: At this time, PUT operations to add forwardProxyUri to an existing environment fail if the environment has nodeConfig set up. To successfully add the forwardProxyUri setting in this case, include the NodeConfig details with the request.
    
    Returns:
    
    value or null for none
  - setForwardProxyUri
```
public GoogleCloudApigeeV1Environment setForwardProxyUri(String forwardProxyUri)
```
    Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the only supported scheme is "http". The port must be supplied. To remove a forward proxy setting, update the field to an empty value. Note: At this time, PUT operations to add forwardProxyUri to an existing environment fail if the environment has nodeConfig set up. To successfully add the forwardProxyUri setting in this case, include the NodeConfig details with the request.
    
    Parameters:
    
    forwardProxyUri - forwardProxyUri or null for none
  - getHasAttachedFlowHooks
```
public Boolean getHasAttachedFlowHooks()
```
    Returns:
    
    value or null for none
  - setHasAttachedFlowHooks
```
public GoogleCloudApigeeV1Environment setHasAttachedFlowHooks(Boolean hasAttachedFlowHooks)
```
    Parameters:
    
    hasAttachedFlowHooks - hasAttachedFlowHooks or null for none
  - getLastModifiedAt
```
public Long getLastModifiedAt()
```
    Output only. Last modification time of this environment as milliseconds since epoch.
    
    Returns:
    
    value or null for none
  - setLastModifiedAt
```
public GoogleCloudApigeeV1Environment setLastModifiedAt(Long lastModifiedAt)
```
    Output only. Last modification time of this environment as milliseconds since epoch.
    
    Parameters:
    
    lastModifiedAt - lastModifiedAt or null for none
  - getName
```
public String getName()
```
    Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudApigeeV1Environment setName(String name)
```
    Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
    
    Parameters:
    
    name - name or null for none
  - getNodeConfig
```
public GoogleCloudApigeeV1NodeConfig getNodeConfig()
```
    Optional. NodeConfig of the environment.
    
    Returns:
    
    value or null for none
  - setNodeConfig
```
public GoogleCloudApigeeV1Environment setNodeConfig(GoogleCloudApigeeV1NodeConfig nodeConfig)
```
    Optional. NodeConfig of the environment.
    
    Parameters:
    
    nodeConfig - nodeConfig or null for none
  - getProperties
```
public GoogleCloudApigeeV1Properties getProperties()
```
    Optional. Key-value pairs that may be used for customizing the environment.
    
    Returns:
    
    value or null for none
  - setProperties
```
public GoogleCloudApigeeV1Environment setProperties(GoogleCloudApigeeV1Properties properties)
```
    Optional. Key-value pairs that may be used for customizing the environment.
    
    Parameters:
    
    properties - properties or null for none
  - getState
```
public String getState()
```
    Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
    
    Returns:
    
    value or null for none
  - setState
```
public GoogleCloudApigeeV1Environment setState(String state)
```
    Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
    
    Parameters:
    
    state - state or null for none
  - getType
```
public String getType()
```
    Optional. EnvironmentType selected for the environment.
    
    Returns:
    
    value or null for none
  - setType
```
public GoogleCloudApigeeV1Environment setType(String type)
```
    Optional. EnvironmentType selected for the environment.
    
    Parameters:
    
    type - type or null for none
  - set
```
public GoogleCloudApigeeV1Environment set(String fieldName,
                                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudApigeeV1Environment clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudApigeeV1Environment

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

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

GoogleCloudApigeeV1Environment

Method Detail

getApiProxyType

setApiProxyType

getClientIpResolutionConfig

setClientIpResolutionConfig

getCreatedAt

setCreatedAt

getDeploymentType

setDeploymentType

getDescription

setDescription

getDisplayName

setDisplayName

getForwardProxyUri

setForwardProxyUri

getHasAttachedFlowHooks

setHasAttachedFlowHooks

getLastModifiedAt

setLastModifiedAt

getName

setName

getNodeConfig

setNodeConfig

getProperties

setProperties

getState

setState

getType

setType

set

clone