com.google.api.services.servicenetworking.v1beta.model

Class AddSubnetworkRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.servicenetworking.v1beta.model.AddSubnetworkRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AddSubnetworkRequest
extends com.google.api.client.json.GenericJson

Request to create a subnetwork in a previously peered service network.

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 Service Networking 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
AddSubnetworkRequest()

Method Summary

Modifier and Type	Method and Description
AddSubnetworkRequest	clone()
String	getConsumer() Required.
String	getConsumerNetwork() Required.
String	getDescription() An optional description of the subnet.
Integer	getIpPrefixLength() Required.
String	getRegion() Required.
String	getRequestedAddress() Optional.
String	getSubnetwork() Required.
List<String>	getSubnetworkUsers() A list of members that are granted the `compute.networkUser` role on the subnet.
AddSubnetworkRequest	set(String fieldName, Object value)
AddSubnetworkRequest	setConsumer(String consumer) Required.
AddSubnetworkRequest	setConsumerNetwork(String consumerNetwork) Required.
AddSubnetworkRequest	setDescription(String description) An optional description of the subnet.
AddSubnetworkRequest	setIpPrefixLength(Integer ipPrefixLength) Required.
AddSubnetworkRequest	setRegion(String region) Required.
AddSubnetworkRequest	setRequestedAddress(String requestedAddress) Optional.
AddSubnetworkRequest	setSubnetwork(String subnetwork) Required.
AddSubnetworkRequest	setSubnetworkUsers(List<String> subnetworkUsers) A list of members that are granted the `compute.networkUser` role on the subnet.

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

AddSubnetworkRequest

public AddSubnetworkRequest()

Method Detail

getConsumer

public String getConsumer()

Required. A resource that represents the service consumer, such as `projects/123456`. The project number can be different from the value in the consumer network parameter. For example, the network might be part of a Shared VPC network. In those cases, Service Networking validates that this resource belongs to that Shared VPC.

Returns:

value or null for none

setConsumer

public AddSubnetworkRequest setConsumer(String consumer)

Required. A resource that represents the service consumer, such as `projects/123456`. The project number can be different from the value in the consumer network parameter. For example, the network might be part of a Shared VPC network. In those cases, Service Networking validates that this resource belongs to that Shared VPC.

Parameters:

consumer - consumer or null for none

getConsumerNetwork

public String getConsumerNetwork()

Required. The name of the service consumer's VPC network. The network must have an existing private connection that was provisioned through the connections.create method. The name must be in the following format: `projects/{project}/global/networks/{network}`, where {project} is a project number, such as `12345`. {network} is the name of a VPC network in the project.

Returns:

value or null for none

setConsumerNetwork

public AddSubnetworkRequest setConsumerNetwork(String consumerNetwork)

Required. The name of the service consumer's VPC network. The network must have an existing private connection that was provisioned through the connections.create method. The name must be in the following format: `projects/{project}/global/networks/{network}`, where {project} is a project number, such as `12345`. {network} is the name of a VPC network in the project.

Parameters:

consumerNetwork - consumerNetwork or null for none

getDescription

public String getDescription()

An optional description of the subnet.

Returns:

value or null for none

setDescription

public AddSubnetworkRequest setDescription(String description)

An optional description of the subnet.

Parameters:

description - description or null for none

getIpPrefixLength

public Integer getIpPrefixLength()

Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as `30` to provision a subnet with an `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range.

Returns:

value or null for none

setIpPrefixLength

public AddSubnetworkRequest setIpPrefixLength(Integer ipPrefixLength)

Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as `30` to provision a subnet with an `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range.

Parameters:

ipPrefixLength - ipPrefixLength or null for none

getRegion

public String getRegion()

Required. The name of a [region](/compute/docs/regions-zones) for the subnet, such `europe- west1`.

Returns:

value or null for none

setRegion

public AddSubnetworkRequest setRegion(String region)

Required. The name of a [region](/compute/docs/regions-zones) for the subnet, such `europe- west1`.

Parameters:

region - region or null for none

getRequestedAddress

public String getRequestedAddress()

Optional. The starting address of a range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix range is the CIDR range for the subnet. The range must be within the allocated range that is assigned to the private connection. If the CIDR range isn't available, the call fails.

Returns:

value or null for none

setRequestedAddress

public AddSubnetworkRequest setRequestedAddress(String requestedAddress)

Optional. The starting address of a range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix range is the CIDR range for the subnet. The range must be within the allocated range that is assigned to the private connection. If the CIDR range isn't available, the call fails.

Parameters:

requestedAddress - requestedAddress or null for none

getSubnetwork

public String getSubnetwork()

Required. A name for the new subnet. For information about the naming requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation.

Returns:

value or null for none

setSubnetwork

public AddSubnetworkRequest setSubnetwork(String subnetwork)

Required. A name for the new subnet. For information about the naming requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation.

Parameters:

subnetwork - subnetwork or null for none

getSubnetworkUsers

public List<String> getSubnetworkUsers()

A list of members that are granted the `compute.networkUser` role on the subnet.

Returns:

value or null for none

setSubnetworkUsers

public AddSubnetworkRequest setSubnetworkUsers(List<String> subnetworkUsers)

A list of members that are granted the `compute.networkUser` role on the subnet.

Parameters:

subnetworkUsers - subnetworkUsers or null for none

set

public AddSubnetworkRequest set(String fieldName,
                                Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public AddSubnetworkRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson