Class AlertPolicy.Documentation (3.32.0)

public static final class AlertPolicy.Documentation extends GeneratedMessageV3 implements AlertPolicy.DocumentationOrBuilder

A content string and a MIME type that describes the content string's format.

Protobuf type google.monitoring.v3.AlertPolicy.Documentation

Static Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
TypeDescription
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

SUBJECT_FIELD_NUMBER

public static final int SUBJECT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AlertPolicy.Documentation getDefaultInstance()
Returns
TypeDescription
AlertPolicy.Documentation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AlertPolicy.Documentation.Builder newBuilder()
Returns
TypeDescription
AlertPolicy.Documentation.Builder

newBuilder(AlertPolicy.Documentation prototype)

public static AlertPolicy.Documentation.Builder newBuilder(AlertPolicy.Documentation prototype)
Parameter
NameDescription
prototypeAlertPolicy.Documentation
Returns
TypeDescription
AlertPolicy.Documentation.Builder

parseDelimitedFrom(InputStream input)

public static AlertPolicy.Documentation parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AlertPolicy.Documentation
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Documentation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AlertPolicy.Documentation
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AlertPolicy.Documentation parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AlertPolicy.Documentation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Documentation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AlertPolicy.Documentation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AlertPolicy.Documentation parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AlertPolicy.Documentation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Documentation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AlertPolicy.Documentation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AlertPolicy.Documentation parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AlertPolicy.Documentation
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Documentation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AlertPolicy.Documentation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AlertPolicy.Documentation parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AlertPolicy.Documentation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Documentation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AlertPolicy.Documentation
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AlertPolicy.Documentation parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AlertPolicy.Documentation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Documentation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AlertPolicy.Documentation
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AlertPolicy.Documentation> parser()
Returns
TypeDescription
Parser<Documentation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getContent()

public String getContent()

The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables.

string content = 1;

Returns
TypeDescription
String

The content.

getContentBytes()

public ByteString getContentBytes()

The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables.

string content = 1;

Returns
TypeDescription
ByteString

The bytes for content.

getDefaultInstanceForType()

public AlertPolicy.Documentation getDefaultInstanceForType()
Returns
TypeDescription
AlertPolicy.Documentation

getMimeType()

public String getMimeType()

The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown for more information.

string mime_type = 2;

Returns
TypeDescription
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown for more information.

string mime_type = 2;

Returns
TypeDescription
ByteString

The bytes for mimeType.

getParserForType()

public Parser<AlertPolicy.Documentation> getParserForType()
Returns
TypeDescription
Parser<Documentation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSubject()

public String getSubject()

Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread. It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).

The contents of the subject line can be templatized by using variables. If this field is missing or empty, a default subject line will be generated.

string subject = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The subject.

getSubjectBytes()

public ByteString getSubjectBytes()

Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread. It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).

The contents of the subject line can be templatized by using variables. If this field is missing or empty, a default subject line will be generated.

string subject = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for subject.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AlertPolicy.Documentation.Builder newBuilderForType()
Returns
TypeDescription
AlertPolicy.Documentation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AlertPolicy.Documentation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AlertPolicy.Documentation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AlertPolicy.Documentation.Builder toBuilder()
Returns
TypeDescription
AlertPolicy.Documentation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException