Class PscConfig (0.1.0)

public final class PscConfig extends GeneratedMessage implements PscConfigOrBuilder

PSC settings for a Cloud SQL instance.

Protobuf type google.cloud.sql.v1beta4.PscConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > PscConfig

Implements

PscConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALLOWED_CONSUMER_PROJECTS_FIELD_NUMBER

public static final int ALLOWED_CONSUMER_PROJECTS_FIELD_NUMBER

Field Value
Type	Description
int

NETWORK_ATTACHMENT_URI_FIELD_NUMBER

public static final int NETWORK_ATTACHMENT_URI_FIELD_NUMBER

Field Value
Type	Description
int

PSC_AUTO_CONNECTIONS_FIELD_NUMBER

public static final int PSC_AUTO_CONNECTIONS_FIELD_NUMBER

Field Value
Type	Description
int

PSC_AUTO_CONNECTION_POLICY_ENABLED_FIELD_NUMBER

public static final int PSC_AUTO_CONNECTION_POLICY_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

PSC_AUTO_DNS_ENABLED_FIELD_NUMBER

public static final int PSC_AUTO_DNS_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

PSC_ENABLED_FIELD_NUMBER

public static final int PSC_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

PSC_WRITE_ENDPOINT_DNS_ENABLED_FIELD_NUMBER

public static final int PSC_WRITE_ENDPOINT_DNS_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static PscConfig getDefaultInstance()

Returns
Type	Description
PscConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static PscConfig.Builder newBuilder()

Returns
Type	Description
PscConfig.Builder

newBuilder(PscConfig prototype)

public static PscConfig.Builder newBuilder(PscConfig prototype)

Parameter
Name	Description
prototype	PscConfig

Returns
Type	Description
PscConfig.Builder

parseDelimitedFrom(InputStream input)

public static PscConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
PscConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PscConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PscConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static PscConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
PscConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PscConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PscConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PscConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
PscConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PscConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PscConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PscConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
PscConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PscConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PscConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static PscConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
PscConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PscConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PscConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static PscConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
PscConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PscConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PscConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<PscConfig> parser()

Returns
Type	Description
Parser<PscConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAllowedConsumerProjects(int index)

public String getAllowedConsumerProjects(int index)

Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects.

Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).

repeated string allowed_consumer_projects = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The allowedConsumerProjects at the given index.

getAllowedConsumerProjectsBytes(int index)

public ByteString getAllowedConsumerProjectsBytes(int index)

Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects.

Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).

repeated string allowed_consumer_projects = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the allowedConsumerProjects at the given index.

getAllowedConsumerProjectsCount()

public int getAllowedConsumerProjectsCount()

Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects.

Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).

repeated string allowed_consumer_projects = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of allowedConsumerProjects.

getAllowedConsumerProjectsList()

public ProtocolStringList getAllowedConsumerProjectsList()

Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects.

Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).

repeated string allowed_consumer_projects = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProtocolStringList	A list containing the allowedConsumerProjects.

getDefaultInstanceForType()

public PscConfig getDefaultInstanceForType()

Returns
Type	Description
PscConfig

getNetworkAttachmentUri()

public String getNetworkAttachmentUri()

Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID

string network_attachment_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The networkAttachmentUri.

getNetworkAttachmentUriBytes()

public ByteString getNetworkAttachmentUriBytes()

Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID

string network_attachment_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for networkAttachmentUri.

getParserForType()

public Parser<PscConfig> getParserForType()

Returns
Type	Description
Parser<PscConfig>

Overrides

GeneratedMessage.getParserForType()

getPscAutoConnectionPolicyEnabled()

public boolean getPscAutoConnectionPolicyEnabled()

Optional. Whether to set up the PSC service connection policy automatically.

optional bool psc_auto_connection_policy_enabled = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The pscAutoConnectionPolicyEnabled.

getPscAutoConnections(int index)

public PscAutoConnectionConfig getPscAutoConnections(int index)

Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.

repeated .google.cloud.sql.v1beta4.PscAutoConnectionConfig psc_auto_connections = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
PscAutoConnectionConfig

getPscAutoConnectionsCount()

public int getPscAutoConnectionsCount()

Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.

repeated .google.cloud.sql.v1beta4.PscAutoConnectionConfig psc_auto_connections = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getPscAutoConnectionsList()

public List<PscAutoConnectionConfig> getPscAutoConnectionsList()

Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.

repeated .google.cloud.sql.v1beta4.PscAutoConnectionConfig psc_auto_connections = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<PscAutoConnectionConfig>

getPscAutoConnectionsOrBuilder(int index)

public PscAutoConnectionConfigOrBuilder getPscAutoConnectionsOrBuilder(int index)

Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.

repeated .google.cloud.sql.v1beta4.PscAutoConnectionConfig psc_auto_connections = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
PscAutoConnectionConfigOrBuilder

getPscAutoConnectionsOrBuilderList()

public List<? extends PscAutoConnectionConfigOrBuilder> getPscAutoConnectionsOrBuilderList()

Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.

repeated .google.cloud.sql.v1beta4.PscAutoConnectionConfig psc_auto_connections = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.sql.v1beta4.PscAutoConnectionConfigOrBuilder>

getPscAutoDnsEnabled()

public boolean getPscAutoDnsEnabled()

Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled.

optional bool psc_auto_dns_enabled = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The pscAutoDnsEnabled.

getPscEnabled()

public boolean getPscEnabled()

Whether PSC connectivity is enabled for this instance.

optional bool psc_enabled = 1;

Returns
Type	Description
boolean	The pscEnabled.

getPscWriteEndpointDnsEnabled()

public boolean getPscWriteEndpointDnsEnabled()

Optional. Indicates whether Private Service Connect write endpoint DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal global DNS record across all networks configured with Private Service Connect auto-connections that points to the cluster primary instance. This feature is only supported for Enterprise Plus edition. This will default to true for new enterprise plus instances when psc_auto_dns_enabled is enabled.

optional bool psc_write_endpoint_dns_enabled = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The pscWriteEndpointDnsEnabled.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hasPscAutoConnectionPolicyEnabled()

public boolean hasPscAutoConnectionPolicyEnabled()

Optional. Whether to set up the PSC service connection policy automatically.

optional bool psc_auto_connection_policy_enabled = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the pscAutoConnectionPolicyEnabled field is set.

hasPscAutoDnsEnabled()

public boolean hasPscAutoDnsEnabled()

Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled.

optional bool psc_auto_dns_enabled = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the pscAutoDnsEnabled field is set.

hasPscEnabled()

public boolean hasPscEnabled()

Whether PSC connectivity is enabled for this instance.

optional bool psc_enabled = 1;

Returns
Type	Description
boolean	Whether the pscEnabled field is set.

hasPscWriteEndpointDnsEnabled()

public boolean hasPscWriteEndpointDnsEnabled()

Optional. Indicates whether Private Service Connect write endpoint DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal global DNS record across all networks configured with Private Service Connect auto-connections that points to the cluster primary instance. This feature is only supported for Enterprise Plus edition. This will default to true for new enterprise plus instances when psc_auto_dns_enabled is enabled.

optional bool psc_write_endpoint_dns_enabled = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the pscWriteEndpointDnsEnabled field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public PscConfig.Builder newBuilderForType()

Returns
Type	Description
PscConfig.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected PscConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
PscConfig.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public PscConfig.Builder toBuilder()

Returns
Type	Description
PscConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException