Class ServiceConnectionMap.ConsumerPscConfig (1.61.0)

public static final class ServiceConnectionMap.ConsumerPscConfig extends GeneratedMessageV3 implements ServiceConnectionMap.ConsumerPscConfigOrBuilder

Allow the producer to specify which consumers can connect to it.

Protobuf type google.cloud.networkconnectivity.v1.ServiceConnectionMap.ConsumerPscConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ServiceConnectionMap.ConsumerPscConfig

Static Fields

CONSUMER_INSTANCE_PROJECT_FIELD_NUMBER

public static final int CONSUMER_INSTANCE_PROJECT_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_GLOBAL_ACCESS_FIELD_NUMBER

public static final int DISABLE_GLOBAL_ACCESS_FIELD_NUMBER
Field Value
Type Description
int

IP_VERSION_FIELD_NUMBER

public static final int IP_VERSION_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
Type Description
int

PRODUCER_INSTANCE_ID_FIELD_NUMBER

public static final int PRODUCER_INSTANCE_ID_FIELD_NUMBER
Field Value
Type Description
int

PRODUCER_INSTANCE_METADATA_FIELD_NUMBER

public static final int PRODUCER_INSTANCE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ATTACHMENT_IP_ADDRESS_MAP_FIELD_NUMBER

public static final int SERVICE_ATTACHMENT_IP_ADDRESS_MAP_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ServiceConnectionMap.ConsumerPscConfig getDefaultInstance()
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ServiceConnectionMap.ConsumerPscConfig.Builder newBuilder()
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig.Builder

newBuilder(ServiceConnectionMap.ConsumerPscConfig prototype)

public static ServiceConnectionMap.ConsumerPscConfig.Builder newBuilder(ServiceConnectionMap.ConsumerPscConfig prototype)
Parameter
Name Description
prototype ServiceConnectionMap.ConsumerPscConfig
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig.Builder

parseDelimitedFrom(InputStream input)

public static ServiceConnectionMap.ConsumerPscConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServiceConnectionMap.ConsumerPscConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ServiceConnectionMap.ConsumerPscConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ServiceConnectionMap.ConsumerPscConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ServiceConnectionMap.ConsumerPscConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ServiceConnectionMap.ConsumerPscConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ServiceConnectionMap.ConsumerPscConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ServiceConnectionMap.ConsumerPscConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ServiceConnectionMap.ConsumerPscConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServiceConnectionMap.ConsumerPscConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ServiceConnectionMap.ConsumerPscConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ServiceConnectionMap.ConsumerPscConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ServiceConnectionMap.ConsumerPscConfig> parser()
Returns
Type Description
Parser<ConsumerPscConfig>

Methods

containsProducerInstanceMetadata(String key)

public boolean containsProducerInstanceMetadata(String key)

Immutable. An immutable map for the producer instance metadata.

map<string, string> producer_instance_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsServiceAttachmentIpAddressMap(String key)

public boolean containsServiceAttachmentIpAddressMap(String key)

Output only. A map to store mapping between customer vip and target service attachment. Only service attachment with producer specified ip addresses are stored here.

map<string, string> service_attachment_ip_address_map = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConsumerInstanceProject()

public String getConsumerInstanceProject()

Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/<project_id_or_number>' Eg. 'projects/consumer-project' or 'projects/1234'

string consumer_instance_project = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The consumerInstanceProject.

getConsumerInstanceProjectBytes()

public ByteString getConsumerInstanceProjectBytes()

Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/<project_id_or_number>' Eg. 'projects/consumer-project' or 'projects/1234'

string consumer_instance_project = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for consumerInstanceProject.

getDefaultInstanceForType()

public ServiceConnectionMap.ConsumerPscConfig getDefaultInstanceForType()
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig

getDisableGlobalAccess()

public boolean getDisableGlobalAccess()

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

bool disable_global_access = 3;

Returns
Type Description
boolean

The disableGlobalAccess.

getIpVersion()

public IPVersion getIpVersion()

The requested IP version for the PSC connection.

optional .google.cloud.networkconnectivity.v1.IPVersion ip_version = 9;

Returns
Type Description
IPVersion

The ipVersion.

getIpVersionValue()

public int getIpVersionValue()

The requested IP version for the PSC connection.

optional .google.cloud.networkconnectivity.v1.IPVersion ip_version = 9;

Returns
Type Description
int

The enum numeric value on the wire for ipVersion.

getNetwork()

public String getNetwork()

The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}.

string network = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}.

string network = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for network.

getParserForType()

public Parser<ServiceConnectionMap.ConsumerPscConfig> getParserForType()
Returns
Type Description
Parser<ConsumerPscConfig>
Overrides

getProducerInstanceId() (deprecated)

public String getProducerInstanceId()

Deprecated. google.cloud.networkconnectivity.v1.ServiceConnectionMap.ConsumerPscConfig.producer_instance_id is deprecated. See google/cloud/networkconnectivity/v1/cross_network_automation.proto;l=363

Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.

string producer_instance_id = 5 [deprecated = true, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The producerInstanceId.

getProducerInstanceIdBytes() (deprecated)

public ByteString getProducerInstanceIdBytes()

Deprecated. google.cloud.networkconnectivity.v1.ServiceConnectionMap.ConsumerPscConfig.producer_instance_id is deprecated. See google/cloud/networkconnectivity/v1/cross_network_automation.proto;l=363

Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.

string producer_instance_id = 5 [deprecated = true, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for producerInstanceId.

getProducerInstanceMetadata() (deprecated)

public Map<String,String> getProducerInstanceMetadata()
Returns
Type Description
Map<String,String>

getProducerInstanceMetadataCount()

public int getProducerInstanceMetadataCount()

Immutable. An immutable map for the producer instance metadata.

map<string, string> producer_instance_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

getProducerInstanceMetadataMap()

public Map<String,String> getProducerInstanceMetadataMap()

Immutable. An immutable map for the producer instance metadata.

map<string, string> producer_instance_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Map<String,String>

getProducerInstanceMetadataOrDefault(String key, String defaultValue)

public String getProducerInstanceMetadataOrDefault(String key, String defaultValue)

Immutable. An immutable map for the producer instance metadata.

map<string, string> producer_instance_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getProducerInstanceMetadataOrThrow(String key)

public String getProducerInstanceMetadataOrThrow(String key)

Immutable. An immutable map for the producer instance metadata.

map<string, string> producer_instance_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
key String
Returns
Type Description
String

getProject()

public String getProject()

The consumer project where PSC connections are allowed to be created in.

string project = 1;

Returns
Type Description
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

The consumer project where PSC connections are allowed to be created in.

string project = 1;

Returns
Type Description
ByteString

The bytes for project.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAttachmentIpAddressMap() (deprecated)

public Map<String,String> getServiceAttachmentIpAddressMap()
Returns
Type Description
Map<String,String>

getServiceAttachmentIpAddressMapCount()

public int getServiceAttachmentIpAddressMapCount()

Output only. A map to store mapping between customer vip and target service attachment. Only service attachment with producer specified ip addresses are stored here.

map<string, string> service_attachment_ip_address_map = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getServiceAttachmentIpAddressMapMap()

public Map<String,String> getServiceAttachmentIpAddressMapMap()

Output only. A map to store mapping between customer vip and target service attachment. Only service attachment with producer specified ip addresses are stored here.

map<string, string> service_attachment_ip_address_map = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Map<String,String>

getServiceAttachmentIpAddressMapOrDefault(String key, String defaultValue)

public String getServiceAttachmentIpAddressMapOrDefault(String key, String defaultValue)

Output only. A map to store mapping between customer vip and target service attachment. Only service attachment with producer specified ip addresses are stored here.

map<string, string> service_attachment_ip_address_map = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getServiceAttachmentIpAddressMapOrThrow(String key)

public String getServiceAttachmentIpAddressMapOrThrow(String key)

Output only. A map to store mapping between customer vip and target service attachment. Only service attachment with producer specified ip addresses are stored here.

map<string, string> service_attachment_ip_address_map = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
String

getState()

public ServiceConnectionMap.ConsumerPscConfig.State getState()

Output only. Overall state of PSC Connections management for this consumer psc config.

.google.cloud.networkconnectivity.v1.ServiceConnectionMap.ConsumerPscConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig.State

The state.

getStateValue()

public int getStateValue()

Output only. Overall state of PSC Connections management for this consumer psc config.

.google.cloud.networkconnectivity.v1.ServiceConnectionMap.ConsumerPscConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

hasIpVersion()

public boolean hasIpVersion()

The requested IP version for the PSC connection.

optional .google.cloud.networkconnectivity.v1.IPVersion ip_version = 9;

Returns
Type Description
boolean

Whether the ipVersion field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ServiceConnectionMap.ConsumerPscConfig.Builder newBuilderForType()
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ServiceConnectionMap.ConsumerPscConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ServiceConnectionMap.ConsumerPscConfig.Builder toBuilder()
Returns
Type Description
ServiceConnectionMap.ConsumerPscConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException