GoogleCloudApigeeV1Instance (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.GoogleCloudApigeeV1Instance

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudApigeeV1Instance
extends com.google.api.client.json.GenericJson
```
Apigee runtime instance.
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

GoogleCloudApigeeV1Instance()

Constructors
Constructor and Description
`GoogleCloudApigeeV1Instance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudApigeeV1Instance`	`clone()`
`GoogleCloudApigeeV1AccessLoggingConfig`	`getAccessLoggingConfig()` Optional.
`List<String>`	`getConsumerAcceptList()` Optional.
`Long`	`getCreatedAt()` Output only.
`String`	`getDescription()` Optional.
`String`	`getDiskEncryptionKeyName()` Optional.
`String`	`getDisplayName()` Optional.
`String`	`getHost()` Output only.
`String`	`getIpRange()` Optional.
`Boolean`	`getIsVersionLocked()` Output only.
`Long`	`getLastModifiedAt()` Output only.
`String`	`getLocation()` Required.
`GoogleCloudApigeeV1MaintenanceUpdatePolicy`	`getMaintenanceUpdatePolicy()` Optional.
`String`	`getName()` Required.
`String`	`getPeeringCidrRange()` Optional.
`String`	`getPort()` Output only.
`String`	`getRuntimeVersion()` Output only.
`GoogleCloudApigeeV1ScheduledMaintenance`	`getScheduledMaintenance()` Output only.
`String`	`getServiceAttachment()` Output only.
`String`	`getState()` Output only.
`GoogleCloudApigeeV1Instance`	`set(String fieldName, Object value)`
`GoogleCloudApigeeV1Instance`	`setAccessLoggingConfig(GoogleCloudApigeeV1AccessLoggingConfig accessLoggingConfig)` Optional.
`GoogleCloudApigeeV1Instance`	`setConsumerAcceptList(List<String> consumerAcceptList)` Optional.
`GoogleCloudApigeeV1Instance`	`setCreatedAt(Long createdAt)` Output only.
`GoogleCloudApigeeV1Instance`	`setDescription(String description)` Optional.
`GoogleCloudApigeeV1Instance`	`setDiskEncryptionKeyName(String diskEncryptionKeyName)` Optional.
`GoogleCloudApigeeV1Instance`	`setDisplayName(String displayName)` Optional.
`GoogleCloudApigeeV1Instance`	`setHost(String host)` Output only.
`GoogleCloudApigeeV1Instance`	`setIpRange(String ipRange)` Optional.
`GoogleCloudApigeeV1Instance`	`setIsVersionLocked(Boolean isVersionLocked)` Output only.
`GoogleCloudApigeeV1Instance`	`setLastModifiedAt(Long lastModifiedAt)` Output only.
`GoogleCloudApigeeV1Instance`	`setLocation(String location)` Required.
`GoogleCloudApigeeV1Instance`	`setMaintenanceUpdatePolicy(GoogleCloudApigeeV1MaintenanceUpdatePolicy maintenanceUpdatePolicy)` Optional.
`GoogleCloudApigeeV1Instance`	`setName(String name)` Required.
`GoogleCloudApigeeV1Instance`	`setPeeringCidrRange(String peeringCidrRange)` Optional.
`GoogleCloudApigeeV1Instance`	`setPort(String port)` Output only.
`GoogleCloudApigeeV1Instance`	`setRuntimeVersion(String runtimeVersion)` Output only.
`GoogleCloudApigeeV1Instance`	`setScheduledMaintenance(GoogleCloudApigeeV1ScheduledMaintenance scheduledMaintenance)` Output only.
`GoogleCloudApigeeV1Instance`	`setServiceAttachment(String serviceAttachment)` Output only.
`GoogleCloudApigeeV1Instance`	`setState(String state)` Output only.

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
  - GoogleCloudApigeeV1Instance
```
public GoogleCloudApigeeV1Instance()
```
- Method Detail
  - getAccessLoggingConfig
```
public GoogleCloudApigeeV1AccessLoggingConfig getAccessLoggingConfig()
```
    Optional. Access logging configuration enables the access logging feature at the instance. Apigee customers can enable access logging to ship the access logs to their own project's cloud logging.
    
    Returns:
    
    value or null for none
  - setAccessLoggingConfig
```
public GoogleCloudApigeeV1Instance setAccessLoggingConfig(GoogleCloudApigeeV1AccessLoggingConfig accessLoggingConfig)
```
    Optional. Access logging configuration enables the access logging feature at the instance. Apigee customers can enable access logging to ship the access logs to their own project's cloud logging.
    
    Parameters:
    
    accessLoggingConfig - accessLoggingConfig or null for none
  - getConsumerAcceptList
```
public List<String> getConsumerAcceptList()
```
    Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.
    
    Returns:
    
    value or null for none
  - setConsumerAcceptList
```
public GoogleCloudApigeeV1Instance setConsumerAcceptList(List<String> consumerAcceptList)
```
    Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.
    
    Parameters:
    
    consumerAcceptList - consumerAcceptList or null for none
  - getCreatedAt
```
public Long getCreatedAt()
```
    Output only. Time the instance was created in milliseconds since epoch.
    
    Returns:
    
    value or null for none
  - setCreatedAt
```
public GoogleCloudApigeeV1Instance setCreatedAt(Long createdAt)
```
    Output only. Time the instance was created in milliseconds since epoch.
    
    Parameters:
    
    createdAt - createdAt or null for none
  - getDescription
```
public String getDescription()
```
    Optional. Description of the instance.
    
    Returns:
    
    value or null for none
  - setDescription
```
public GoogleCloudApigeeV1Instance setDescription(String description)
```
    Optional. Description of the instance.
    
    Parameters:
    
    description - description or null for none
  - getDiskEncryptionKeyName
```
public String getDiskEncryptionKeyName()
```
    Optional. Customer Managed Encryption Key (CMEK) used for disk and volume encryption. If not specified, a Google-Managed encryption key will be used. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`
    
    Returns:
    
    value or null for none
  - setDiskEncryptionKeyName
```
public GoogleCloudApigeeV1Instance setDiskEncryptionKeyName(String diskEncryptionKeyName)
```
    Optional. Customer Managed Encryption Key (CMEK) used for disk and volume encryption. If not specified, a Google-Managed encryption key will be used. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`
    
    Parameters:
    
    diskEncryptionKeyName - diskEncryptionKeyName or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Optional. Display name for the instance.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public GoogleCloudApigeeV1Instance setDisplayName(String displayName)
```
    Optional. Display name for the instance.
    
    Parameters:
    
    displayName - displayName or null for none
  - getHost
```
public String getHost()
```
    Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    
    Returns:
    
    value or null for none
  - setHost
```
public GoogleCloudApigeeV1Instance setHost(String host)
```
    Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    
    Parameters:
    
    host - host or null for none
  - getIpRange
```
public String getIpRange()
```
    Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28`
    
    Returns:
    
    value or null for none
  - setIpRange
```
public GoogleCloudApigeeV1Instance setIpRange(String ipRange)
```
    Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28`
    
    Parameters:
    
    ipRange - ipRange or null for none
  - getIsVersionLocked
```
public Boolean getIsVersionLocked()
```
    Output only. Indicates whether the instance is version locked. If true, the instance will not be updated by automated runtime rollouts. This is only supported for Apigee X instances.
    
    Returns:
    
    value or null for none
  - setIsVersionLocked
```
public GoogleCloudApigeeV1Instance setIsVersionLocked(Boolean isVersionLocked)
```
    Output only. Indicates whether the instance is version locked. If true, the instance will not be updated by automated runtime rollouts. This is only supported for Apigee X instances.
    
    Parameters:
    
    isVersionLocked - isVersionLocked or null for none
  - getLastModifiedAt
```
public Long getLastModifiedAt()
```
    Output only. Time the instance was last modified in milliseconds since epoch.
    
    Returns:
    
    value or null for none
  - setLastModifiedAt
```
public GoogleCloudApigeeV1Instance setLastModifiedAt(Long lastModifiedAt)
```
    Output only. Time the instance was last modified in milliseconds since epoch.
    
    Parameters:
    
    lastModifiedAt - lastModifiedAt or null for none
  - getLocation
```
public String getLocation()
```
    Required. Compute Engine location where the instance resides.
    
    Returns:
    
    value or null for none
  - setLocation
```
public GoogleCloudApigeeV1Instance setLocation(String location)
```
    Required. Compute Engine location where the instance resides.
    
    Parameters:
    
    location - location or null for none
  - getMaintenanceUpdatePolicy
```
public GoogleCloudApigeeV1MaintenanceUpdatePolicy getMaintenanceUpdatePolicy()
```
    Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day).
    
    Returns:
    
    value or null for none
  - setMaintenanceUpdatePolicy
```
public GoogleCloudApigeeV1Instance setMaintenanceUpdatePolicy(GoogleCloudApigeeV1MaintenanceUpdatePolicy maintenanceUpdatePolicy)
```
    Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day).
    
    Parameters:
    
    maintenanceUpdatePolicy - maintenanceUpdatePolicy or null for none
  - getName
```
public String getName()
```
    Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudApigeeV1Instance setName(String name)
```
    Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
    
    Parameters:
    
    name - name or null for none
  - getPeeringCidrRange
```
public String getPeeringCidrRange()
```
    Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`.
    
    Returns:
    
    value or null for none
  - setPeeringCidrRange
```
public GoogleCloudApigeeV1Instance setPeeringCidrRange(String peeringCidrRange)
```
    Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`.
    
    Parameters:
    
    peeringCidrRange - peeringCidrRange or null for none
  - getPort
```
public String getPort()
```
    Output only. Port number of the exposed Apigee endpoint.
    
    Returns:
    
    value or null for none
  - setPort
```
public GoogleCloudApigeeV1Instance setPort(String port)
```
    Output only. Port number of the exposed Apigee endpoint.
    
    Parameters:
    
    port - port or null for none
  - getRuntimeVersion
```
public String getRuntimeVersion()
```
    Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments.
    
    Returns:
    
    value or null for none
  - setRuntimeVersion
```
public GoogleCloudApigeeV1Instance setRuntimeVersion(String runtimeVersion)
```
    Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments.
    
    Parameters:
    
    runtimeVersion - runtimeVersion or null for none
  - getScheduledMaintenance
```
public GoogleCloudApigeeV1ScheduledMaintenance getScheduledMaintenance()
```
    Output only. Time and date of the scheduled maintenance for this instance. This field is only populated for instances that have opted into Maintenance Window and if there is an upcoming maintenance. Cleared once the maintenance is complete.
    
    Returns:
    
    value or null for none
  - setScheduledMaintenance
```
public GoogleCloudApigeeV1Instance setScheduledMaintenance(GoogleCloudApigeeV1ScheduledMaintenance scheduledMaintenance)
```
    Output only. Time and date of the scheduled maintenance for this instance. This field is only populated for instances that have opted into Maintenance Window and if there is an upcoming maintenance. Cleared once the maintenance is complete.
    
    Parameters:
    
    scheduledMaintenance - scheduledMaintenance or null for none
  - getServiceAttachment
```
public String getServiceAttachment()
```
    Output only. Resource name of the service attachment created for the instance in the format: `projects/regions/serviceAttachments` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.
    
    Returns:
    
    value or null for none
  - setServiceAttachment
```
public GoogleCloudApigeeV1Instance setServiceAttachment(String serviceAttachment)
```
    Output only. Resource name of the service attachment created for the instance in the format: `projects/regions/serviceAttachments` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.
    
    Parameters:
    
    serviceAttachment - serviceAttachment or null for none
  - getState
```
public String getState()
```
    Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use.
    
    Returns:
    
    value or null for none
  - setState
```
public GoogleCloudApigeeV1Instance setState(String state)
```
    Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use.
    
    Parameters:
    
    state - state or null for none
  - set
```
public GoogleCloudApigeeV1Instance set(String fieldName,
                                       Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudApigeeV1Instance clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudApigeeV1Instance

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

GoogleCloudApigeeV1Instance

Method Detail

getAccessLoggingConfig

setAccessLoggingConfig

getConsumerAcceptList

setConsumerAcceptList

getCreatedAt

setCreatedAt

getDescription

setDescription

getDiskEncryptionKeyName

setDiskEncryptionKeyName

getDisplayName

setDisplayName

getHost

setHost

getIpRange

setIpRange

getIsVersionLocked

setIsVersionLocked

getLastModifiedAt

setLastModifiedAt

getLocation

setLocation

getMaintenanceUpdatePolicy

setMaintenanceUpdatePolicy

getName

setName

getPeeringCidrRange

setPeeringCidrRange

getPort

setPort

getRuntimeVersion

setRuntimeVersion

getScheduledMaintenance

setScheduledMaintenance

getServiceAttachment

setServiceAttachment

getState

setState

set

clone