Package com.google.monitoring.v3

Class UptimeCheckConfig.HttpCheck

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getRequestMethodValue

        public int getRequestMethodValue()
         The HTTP request method to use for the check. If set to
 `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
        .google.monitoring.v3.UptimeCheckConfig.HttpCheck.RequestMethod request_method = 8;
        Specified by:
        getRequestMethodValue in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        The enum numeric value on the wire for requestMethod.

      • getPath

        public String getPath()
         Optional (defaults to "/"). The path to the page against which to run
 the check. Will be combined with the `host` (specified within the
 `monitored_resource`) and `port` to construct the full URL. If the
 provided path does not begin with "/", a "/" will be prepended
 automatically.
        string path = 2;
        Specified by:
        getPath in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        The path.

      • getPathBytes

        public com.google.protobuf.ByteString getPathBytes()
         Optional (defaults to "/"). The path to the page against which to run
 the check. Will be combined with the `host` (specified within the
 `monitored_resource`) and `port` to construct the full URL. If the
 provided path does not begin with "/", a "/" will be prepended
 automatically.
        string path = 2;
        Specified by:
        getPathBytes in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        The bytes for path.

      • getPort

        public int getPort()
         Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
 `use_ssl` is `true`). The TCP port on the HTTP server against which to
 run the check. Will be combined with host (specified within the
 `monitored_resource`) and `path` to construct the full URL.
        int32 port = 3;
        Specified by:
        getPort in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        The port.

      • hasAuthInfo

        public boolean hasAuthInfo()
         The authentication information. Optional when creating an HTTP check;
 defaults to empty.
        .google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication auth_info = 4;
        Specified by:
        hasAuthInfo in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        Whether the authInfo field is set.

      • getMaskHeaders

        public boolean getMaskHeaders()
         Boolean specifying whether to encrypt the header information.
 Encryption should be specified for any headers related to authentication
 that you do not wish to be seen when retrieving the configuration. The
 server will be responsible for encrypting the headers.
 On Get/List calls, if `mask_headers` is set to `true` then the headers
 will be obscured with `******.`
        bool mask_headers = 5;
        Specified by:
        getMaskHeaders in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        The maskHeaders.

      • getHeadersCount

        public int getHeadersCount()
        Description copied from interface: UptimeCheckConfig.HttpCheckOrBuilder
         The list of headers to send as part of the Uptime check request.
 If two headers have the same key and different values, they should
 be entered as a single header, with the value being a comma-separated
 list of all the desired values as described at
 https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
 Entering two separate headers with the same key in a Create call will
 cause the first to be overwritten by the second.
 The maximum number of headers allowed is 100.
        map<string, string> headers = 6;
        Specified by:
        getHeadersCount in interface UptimeCheckConfig.HttpCheckOrBuilder

      • containsHeaders

        public boolean containsHeaders​(String key)
         The list of headers to send as part of the Uptime check request.
 If two headers have the same key and different values, they should
 be entered as a single header, with the value being a comma-separated
 list of all the desired values as described at
 https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
 Entering two separate headers with the same key in a Create call will
 cause the first to be overwritten by the second.
 The maximum number of headers allowed is 100.
        map<string, string> headers = 6;
        Specified by:
        containsHeaders in interface UptimeCheckConfig.HttpCheckOrBuilder

      • getHeadersMap

        public Map<String,​String> getHeadersMap()
         The list of headers to send as part of the Uptime check request.
 If two headers have the same key and different values, they should
 be entered as a single header, with the value being a comma-separated
 list of all the desired values as described at
 https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
 Entering two separate headers with the same key in a Create call will
 cause the first to be overwritten by the second.
 The maximum number of headers allowed is 100.
        map<string, string> headers = 6;
        Specified by:
        getHeadersMap in interface UptimeCheckConfig.HttpCheckOrBuilder

      • getHeadersOrDefault

        public String getHeadersOrDefault​(String key,
                                  String defaultValue)
         The list of headers to send as part of the Uptime check request.
 If two headers have the same key and different values, they should
 be entered as a single header, with the value being a comma-separated
 list of all the desired values as described at
 https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
 Entering two separate headers with the same key in a Create call will
 cause the first to be overwritten by the second.
 The maximum number of headers allowed is 100.
        map<string, string> headers = 6;
        Specified by:
        getHeadersOrDefault in interface UptimeCheckConfig.HttpCheckOrBuilder

      • getHeadersOrThrow

        public String getHeadersOrThrow​(String key)
         The list of headers to send as part of the Uptime check request.
 If two headers have the same key and different values, they should
 be entered as a single header, with the value being a comma-separated
 list of all the desired values as described at
 https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
 Entering two separate headers with the same key in a Create call will
 cause the first to be overwritten by the second.
 The maximum number of headers allowed is 100.
        map<string, string> headers = 6;
        Specified by:
        getHeadersOrThrow in interface UptimeCheckConfig.HttpCheckOrBuilder

      • getContentTypeValue

        public int getContentTypeValue()
         The content type header to use for the check. The following
 configurations result in errors:
 1. Content type is specified in both the `headers` field and the
 `content_type` field.
 2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
 3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
 4. Request method is `POST` and a "Content-Type" header is provided via
 `headers` field. The `content_type` field should be used instead.
        .google.monitoring.v3.UptimeCheckConfig.HttpCheck.ContentType content_type = 9;
        Specified by:
        getContentTypeValue in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        The enum numeric value on the wire for contentType.

      • getContentType

        public UptimeCheckConfig.HttpCheck.ContentType getContentType()
         The content type header to use for the check. The following
 configurations result in errors:
 1. Content type is specified in both the `headers` field and the
 `content_type` field.
 2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
 3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
 4. Request method is `POST` and a "Content-Type" header is provided via
 `headers` field. The `content_type` field should be used instead.
        .google.monitoring.v3.UptimeCheckConfig.HttpCheck.ContentType content_type = 9;
        Specified by:
        getContentType in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        The contentType.

      • getCustomContentType

        public String getCustomContentType()
         A user provided content type header to use for the check. The invalid
 configurations outlined in the `content_type` field apply to
 `custom_content_type`, as well as the following:
 1. `content_type` is `URL_ENCODED` and `custom_content_type` is set.
 2. `content_type` is `USER_PROVIDED` and `custom_content_type` is not
 set.
        string custom_content_type = 13;
        Specified by:
        getCustomContentType in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        The customContentType.

      • getCustomContentTypeBytes

        public com.google.protobuf.ByteString getCustomContentTypeBytes()
         A user provided content type header to use for the check. The invalid
 configurations outlined in the `content_type` field apply to
 `custom_content_type`, as well as the following:
 1. `content_type` is `URL_ENCODED` and `custom_content_type` is set.
 2. `content_type` is `USER_PROVIDED` and `custom_content_type` is not
 set.
        string custom_content_type = 13;
        Specified by:
        getCustomContentTypeBytes in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        The bytes for customContentType.

      • getValidateSsl

        public boolean getValidateSsl()
         Boolean specifying whether to include SSL certificate validation as a
 part of the Uptime check. Only applies to checks where
 `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
 setting `validate_ssl` to `true` has no effect.
        bool validate_ssl = 7;
        Specified by:
        getValidateSsl in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        The validateSsl.

      • getBody

        public com.google.protobuf.ByteString getBody()
         The request body associated with the HTTP POST request. If `content_type`
 is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
 provide a `Content-Length` header via the `headers` field or the API will
 do so. If the `request_method` is `GET` and `body` is not empty, the API
 will return an error. The maximum byte size is 1 megabyte.

 Note: If client libraries aren't used (which performs the conversion
 automatically) base64 encode your `body` data since the field is of
 `bytes` type.
        bytes body = 10;
        Specified by:
        getBody in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        The body.

      • getAcceptedResponseStatusCodesCount

        public int getAcceptedResponseStatusCodesCount()
         If present, the check will only pass if the HTTP response status code is
 in this set of status codes. If empty, the HTTP status code will only
 pass if the HTTP status code is 200-299.
        repeated .google.monitoring.v3.UptimeCheckConfig.HttpCheck.ResponseStatusCode accepted_response_status_codes = 11;
        Specified by:
        getAcceptedResponseStatusCodesCount in interface UptimeCheckConfig.HttpCheckOrBuilder

      • hasPingConfig

        public boolean hasPingConfig()
         Contains information needed to add pings to an HTTP check.
        .google.monitoring.v3.UptimeCheckConfig.PingConfig ping_config = 12;
        Specified by:
        hasPingConfig in interface UptimeCheckConfig.HttpCheckOrBuilder
        Returns:
        Whether the pingConfig field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static UptimeCheckConfig.HttpCheck parseFrom​(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UptimeCheckConfig.HttpCheck parseFrom​(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UptimeCheckConfig.HttpCheck parseFrom​(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UptimeCheckConfig.HttpCheck parseFrom​(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UptimeCheckConfig.HttpCheck parseFrom​(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UptimeCheckConfig.HttpCheck parseFrom​(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public UptimeCheckConfig.HttpCheck.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public UptimeCheckConfig.HttpCheck.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected UptimeCheckConfig.HttpCheck.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<UptimeCheckConfig.HttpCheck> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public UptimeCheckConfig.HttpCheck getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder