Package com.google.appengine.v1

Class Service

  • All Implemented Interfaces:
    ServiceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Service
extends com.google.protobuf.GeneratedMessageV3
implements ServiceOrBuilder
     A Service resource is a logical component of an application that can share
 state and communicate in a secure fashion with other services.
 For example, an application that handles customer requests might
 include separate services to handle tasks such as backend data
 analysis or API requests from mobile devices. Each service has a
 collection of versions that define a specific set of code used to
 implement the functionality of that service.
    Protobuf type google.appengine.v1.Service
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Service.Builder
      A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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

      • getName

        public String getName()
         Full path to the Service resource in the API.
 Example: `apps/myapp/services/default`.

 @OutputOnly
        string name = 1;
        Specified by:
        getName in interface ServiceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Full path to the Service resource in the API.
 Example: `apps/myapp/services/default`.

 @OutputOnly
        string name = 1;
        Specified by:
        getNameBytes in interface ServiceOrBuilder
        Returns:
        The bytes for name.

      • getId

        public String getId()
         Relative name of the service within the application.
 Example: `default`.

 @OutputOnly
        string id = 2;
        Specified by:
        getId in interface ServiceOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Relative name of the service within the application.
 Example: `default`.

 @OutputOnly
        string id = 2;
        Specified by:
        getIdBytes in interface ServiceOrBuilder
        Returns:
        The bytes for id.

      • hasSplit

        public boolean hasSplit()
         Mapping that defines fractional HTTP traffic diversion to
 different versions within the service.
        .google.appengine.v1.TrafficSplit split = 3;
        Specified by:
        hasSplit in interface ServiceOrBuilder
        Returns:
        Whether the split field is set.

      • getSplit

        public TrafficSplit getSplit()
         Mapping that defines fractional HTTP traffic diversion to
 different versions within the service.
        .google.appengine.v1.TrafficSplit split = 3;
        Specified by:
        getSplit in interface ServiceOrBuilder
        Returns:
        The split.

      • getSplitOrBuilder

        public TrafficSplitOrBuilder getSplitOrBuilder()
         Mapping that defines fractional HTTP traffic diversion to
 different versions within the service.
        .google.appengine.v1.TrafficSplit split = 3;
        Specified by:
        getSplitOrBuilder in interface ServiceOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: ServiceOrBuilder
         A set of labels to apply to this service. Labels are key/value pairs that
 describe the service and all resources that belong to it (e.g.,
 versions). The labels can be used to search and group resources, and are
 propagated to the usage and billing reports, enabling fine-grain analysis
 of costs. An example of using labels is to tag resources belonging to
 different environments (e.g., "env=prod", "env=qa").

 <p>Label keys and values can be no longer than 63 characters and can only
 contain lowercase letters, numeric characters, underscores, dashes, and
 international characters. Label keys must start with a lowercase letter
 or an international character. Each service can have at most 32 labels.
        map<string, string> labels = 4;
        Specified by:
        getLabelsCount in interface ServiceOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         A set of labels to apply to this service. Labels are key/value pairs that
 describe the service and all resources that belong to it (e.g.,
 versions). The labels can be used to search and group resources, and are
 propagated to the usage and billing reports, enabling fine-grain analysis
 of costs. An example of using labels is to tag resources belonging to
 different environments (e.g., "env=prod", "env=qa").

 <p>Label keys and values can be no longer than 63 characters and can only
 contain lowercase letters, numeric characters, underscores, dashes, and
 international characters. Label keys must start with a lowercase letter
 or an international character. Each service can have at most 32 labels.
        map<string, string> labels = 4;
        Specified by:
        containsLabels in interface ServiceOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         A set of labels to apply to this service. Labels are key/value pairs that
 describe the service and all resources that belong to it (e.g.,
 versions). The labels can be used to search and group resources, and are
 propagated to the usage and billing reports, enabling fine-grain analysis
 of costs. An example of using labels is to tag resources belonging to
 different environments (e.g., "env=prod", "env=qa").

 <p>Label keys and values can be no longer than 63 characters and can only
 contain lowercase letters, numeric characters, underscores, dashes, and
 international characters. Label keys must start with a lowercase letter
 or an international character. Each service can have at most 32 labels.
        map<string, string> labels = 4;
        Specified by:
        getLabelsMap in interface ServiceOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         A set of labels to apply to this service. Labels are key/value pairs that
 describe the service and all resources that belong to it (e.g.,
 versions). The labels can be used to search and group resources, and are
 propagated to the usage and billing reports, enabling fine-grain analysis
 of costs. An example of using labels is to tag resources belonging to
 different environments (e.g., "env=prod", "env=qa").

 <p>Label keys and values can be no longer than 63 characters and can only
 contain lowercase letters, numeric characters, underscores, dashes, and
 international characters. Label keys must start with a lowercase letter
 or an international character. Each service can have at most 32 labels.
        map<string, string> labels = 4;
        Specified by:
        getLabelsOrDefault in interface ServiceOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         A set of labels to apply to this service. Labels are key/value pairs that
 describe the service and all resources that belong to it (e.g.,
 versions). The labels can be used to search and group resources, and are
 propagated to the usage and billing reports, enabling fine-grain analysis
 of costs. An example of using labels is to tag resources belonging to
 different environments (e.g., "env=prod", "env=qa").

 <p>Label keys and values can be no longer than 63 characters and can only
 contain lowercase letters, numeric characters, underscores, dashes, and
 international characters. Label keys must start with a lowercase letter
 or an international character. Each service can have at most 32 labels.
        map<string, string> labels = 4;
        Specified by:
        getLabelsOrThrow in interface ServiceOrBuilder

      • hasNetworkSettings

        public boolean hasNetworkSettings()
         Ingress settings for this service. Will apply to all versions.
        .google.appengine.v1.NetworkSettings network_settings = 6;
        Specified by:
        hasNetworkSettings in interface ServiceOrBuilder
        Returns:
        Whether the networkSettings field is set.

      • getNetworkSettings

        public NetworkSettings getNetworkSettings()
         Ingress settings for this service. Will apply to all versions.
        .google.appengine.v1.NetworkSettings network_settings = 6;
        Specified by:
        getNetworkSettings in interface ServiceOrBuilder
        Returns:
        The networkSettings.

      • 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 Service parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Service parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Service getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Service> parser()

      • getParserForType

        public com.google.protobuf.Parser<Service> 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 Service getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder