Class JavaSettings (2.15.0)

public sealed class JavaSettings : IMessage<JavaSettings>, IEquatable<JavaSettings>, IDeepCloneable<JavaSettings>, IBufferMessage, IMessage

Settings for Java client libraries.

Inheritance

object > JavaSettings

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

JavaSettings()

public JavaSettings()

JavaSettings(JavaSettings)

public JavaSettings(JavaSettings other)
Parameter
Name Description
other JavaSettings

Fields

CommonFieldNumber

public const int CommonFieldNumber = 3

Field number for the "common" field.

Field Value
Type Description
int

LibraryPackageFieldNumber

public const int LibraryPackageFieldNumber = 1

Field number for the "library_package" field.

Field Value
Type Description
int

ServiceClassNamesFieldNumber

public const int ServiceClassNamesFieldNumber = 2

Field number for the "service_class_names" field.

Field Value
Type Description
int

Properties

Common

public CommonLanguageSettings Common { get; set; }

Some settings.

Property Value
Type Description
CommonLanguageSettings

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

LibraryPackage

public string LibraryPackage { get; set; }

The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used only by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible.

Example of a YAML configuration::

publishing: java_settings: library_package: com.google.cloud.pubsub.v1

Property Value
Type Description
string

Parser

public static MessageParser<JavaSettings> Parser { get; }
Property Value
Type Description
MessageParserJavaSettings

ServiceClassNames

public MapField<string, string> ServiceClassNames { get; }

Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf.

Example of a YAML configuration::

publishing: java_settings: service_class_names:

  • google.pubsub.v1.Publisher: TopicAdmin
  • google.pubsub.v1.Subscriber: SubscriptionAdmin
Property Value
Type Description
MapFieldstringstring

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type Description
int

The number of bytes required to write this message to a coded output stream.

Clone()

public JavaSettings Clone()

Creates a deep clone of this object.

Returns
Type Description
JavaSettings

A deep clone of this object.

Equals(JavaSettings)

public bool Equals(JavaSettings other)
Parameter
Name Description
other JavaSettings
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(JavaSettings)

public void MergeFrom(JavaSettings other)

Merges the given message into this one.

Parameter
Name Description
other JavaSettings
Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name Description
input CodedInputStream
Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name Description
output CodedOutputStream

Coded output stream to write the data to. Must not be null.