- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.6
- 3.3.6
- 3.2.10
public static final class AlertPolicy.Documentation.Builder extends GeneratedMessageV3.Builder<AlertPolicy.Documentation.Builder> implements AlertPolicy.DocumentationOrBuilder
Documentation that is included in the notifications and incidents pertaining to this policy.
Protobuf type google.monitoring.v3.AlertPolicy.Documentation
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AlertPolicy.Documentation.BuilderImplements
AlertPolicy.DocumentationOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllLinks(Iterable<? extends AlertPolicy.Documentation.Link> values)
public AlertPolicy.Documentation.Builder addAllLinks(Iterable<? extends AlertPolicy.Documentation.Link> values)
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.monitoring.v3.AlertPolicy.Documentation.Link> |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
addLinks(AlertPolicy.Documentation.Link value)
public AlertPolicy.Documentation.Builder addLinks(AlertPolicy.Documentation.Link value)
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AlertPolicy.Documentation.Link |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
addLinks(AlertPolicy.Documentation.Link.Builder builderForValue)
public AlertPolicy.Documentation.Builder addLinks(AlertPolicy.Documentation.Link.Builder builderForValue)
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
AlertPolicy.Documentation.Link.Builder |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
addLinks(int index, AlertPolicy.Documentation.Link value)
public AlertPolicy.Documentation.Builder addLinks(int index, AlertPolicy.Documentation.Link value)
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
AlertPolicy.Documentation.Link |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
addLinks(int index, AlertPolicy.Documentation.Link.Builder builderForValue)
public AlertPolicy.Documentation.Builder addLinks(int index, AlertPolicy.Documentation.Link.Builder builderForValue)
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
AlertPolicy.Documentation.Link.Builder |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
addLinksBuilder()
public AlertPolicy.Documentation.Link.Builder addLinksBuilder()
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Link.Builder |
addLinksBuilder(int index)
public AlertPolicy.Documentation.Link.Builder addLinksBuilder(int index)
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Link.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AlertPolicy.Documentation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
build()
public AlertPolicy.Documentation build()
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation |
buildPartial()
public AlertPolicy.Documentation buildPartial()
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation |
clear()
public AlertPolicy.Documentation.Builder clear()
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
clearContent()
public AlertPolicy.Documentation.Builder clearContent()
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 | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public AlertPolicy.Documentation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
clearLinks()
public AlertPolicy.Documentation.Builder clearLinks()
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
clearMimeType()
public AlertPolicy.Documentation.Builder clearMimeType()
The format of the content
field. Presently, only the value
"text/markdown"
is supported. See
Markdown for more information.
string mime_type = 2;
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public AlertPolicy.Documentation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
clearSubject()
public AlertPolicy.Documentation.Builder clearSubject()
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 | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
This builder for chaining. |
clone()
public AlertPolicy.Documentation.Builder clone()
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ByteString |
The bytes for content. |
getDefaultInstanceForType()
public AlertPolicy.Documentation getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getLinks(int index)
public AlertPolicy.Documentation.Link getLinks(int index)
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Link |
getLinksBuilder(int index)
public AlertPolicy.Documentation.Link.Builder getLinksBuilder(int index)
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Link.Builder |
getLinksBuilderList()
public List<AlertPolicy.Documentation.Link.Builder> getLinksBuilderList()
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Builder> |
getLinksCount()
public int getLinksCount()
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getLinksList()
public List<AlertPolicy.Documentation.Link> getLinksList()
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Link> |
getLinksOrBuilder(int index)
public AlertPolicy.Documentation.LinkOrBuilder getLinksOrBuilder(int index)
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.LinkOrBuilder |
getLinksOrBuilderList()
public List<? extends AlertPolicy.Documentation.LinkOrBuilder> getLinksOrBuilderList()
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<? extends com.google.monitoring.v3.AlertPolicy.Documentation.LinkOrBuilder> |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ByteString |
The bytes for mimeType. |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ByteString |
The bytes for subject. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(AlertPolicy.Documentation other)
public AlertPolicy.Documentation.Builder mergeFrom(AlertPolicy.Documentation other)
Parameter | |
---|---|
Name | Description |
other |
AlertPolicy.Documentation |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AlertPolicy.Documentation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public AlertPolicy.Documentation.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AlertPolicy.Documentation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
removeLinks(int index)
public AlertPolicy.Documentation.Builder removeLinks(int index)
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
setContent(String value)
public AlertPolicy.Documentation.Builder setContent(String value)
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;
Parameter | |
---|---|
Name | Description |
value |
String The content to set. |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
This builder for chaining. |
setContentBytes(ByteString value)
public AlertPolicy.Documentation.Builder setContentBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for content to set. |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public AlertPolicy.Documentation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
setLinks(int index, AlertPolicy.Documentation.Link value)
public AlertPolicy.Documentation.Builder setLinks(int index, AlertPolicy.Documentation.Link value)
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
AlertPolicy.Documentation.Link |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
setLinks(int index, AlertPolicy.Documentation.Link.Builder builderForValue)
public AlertPolicy.Documentation.Builder setLinks(int index, AlertPolicy.Documentation.Link.Builder builderForValue)
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
AlertPolicy.Documentation.Link.Builder |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
setMimeType(String value)
public AlertPolicy.Documentation.Builder setMimeType(String value)
The format of the content
field. Presently, only the value
"text/markdown"
is supported. See
Markdown for more information.
string mime_type = 2;
Parameter | |
---|---|
Name | Description |
value |
String The mimeType to set. |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
This builder for chaining. |
setMimeTypeBytes(ByteString value)
public AlertPolicy.Documentation.Builder setMimeTypeBytes(ByteString value)
The format of the content
field. Presently, only the value
"text/markdown"
is supported. See
Markdown for more information.
string mime_type = 2;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for mimeType to set. |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AlertPolicy.Documentation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
setSubject(String value)
public AlertPolicy.Documentation.Builder setSubject(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The subject to set. |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
This builder for chaining. |
setSubjectBytes(ByteString value)
public AlertPolicy.Documentation.Builder setSubjectBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for subject to set. |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final AlertPolicy.Documentation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
AlertPolicy.Documentation.Builder |