Package com.google.cloud.servicedirectory.v1

Class ResolveServiceRequest

  • All Implemented Interfaces:
    ResolveServiceRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ResolveServiceRequest
extends com.google.protobuf.GeneratedMessageV3
implements ResolveServiceRequestOrBuilder
     The request message for
 [LookupService.ResolveService][google.cloud.servicedirectory.v1.LookupService.ResolveService].
 Looks up a service by its name, returns the service and its endpoints.
    Protobuf type google.cloud.servicedirectory.v1.ResolveServiceRequest
    See Also:
    Serialized Form

    • 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()

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Required. The name of the service to resolve.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface ResolveServiceRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The name of the service to resolve.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface ResolveServiceRequestOrBuilder
        Returns:
        The bytes for name.

      • getMaxEndpoints

        public int getMaxEndpoints()
         Optional. The maximum number of endpoints to return. Defaults to 25.
 Maximum is 100. If a value less than one is specified, the Default is used.
 If a value greater than the Maximum is specified, the Maximum is used.
        int32 max_endpoints = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMaxEndpoints in interface ResolveServiceRequestOrBuilder
        Returns:
        The maxEndpoints.

      • getEndpointFilter

        public String getEndpointFilter()
         Optional. The filter applied to the endpoints of the resolved service.

 General `filter` string syntax:
 `<field> <operator> <value> (<logical connector>)`

 *   `<field>` can be `name`, `address`, `port`, or `annotations.<key>` for
     map field
 *   `<operator>` can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:`
     means `HAS`, and is roughly the same as `=`
 *   `<value>` must be the same data type as field
 *   `<logical connector>` can be `AND`, `OR`, `NOT`

 Examples of valid filters:

 *   `annotations.owner` returns endpoints that have a annotation with the
     key `owner`, this is the same as `annotations:owner`
 *   `annotations.protocol=gRPC` returns endpoints that have key/value
     `protocol=gRPC`
 *   `address=192.108.1.105` returns endpoints that have this address
 *   `port>8080` returns endpoints that have port number larger than 8080
 *
 `name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/my-service/endpoints/endpoint-c`
     returns endpoints that have name that is alphabetically later than the
     string, so "endpoint-e" is returned but "endpoint-a" is not
 *
 `name=projects/my-project/locations/us-central1/namespaces/my-namespace/services/my-service/endpoints/ep-1`
      returns the endpoint that has an endpoint_id equal to `ep-1`
 *   `annotations.owner!=sd AND annotations.foo=bar` returns endpoints that
     have `owner` in annotation key but value is not `sd` AND have
     key/value `foo=bar`
 *   `doesnotexist.foo=bar` returns an empty list. Note that endpoint
     doesn't have a field called "doesnotexist". Since the filter does not
     match any endpoint, it returns no results

 For more information about filtering, see
 [API Filtering](https://aip.dev/160).
        string endpoint_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEndpointFilter in interface ResolveServiceRequestOrBuilder
        Returns:
        The endpointFilter.

      • getEndpointFilterBytes

        public com.google.protobuf.ByteString getEndpointFilterBytes()
         Optional. The filter applied to the endpoints of the resolved service.

 General `filter` string syntax:
 `<field> <operator> <value> (<logical connector>)`

 *   `<field>` can be `name`, `address`, `port`, or `annotations.<key>` for
     map field
 *   `<operator>` can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:`
     means `HAS`, and is roughly the same as `=`
 *   `<value>` must be the same data type as field
 *   `<logical connector>` can be `AND`, `OR`, `NOT`

 Examples of valid filters:

 *   `annotations.owner` returns endpoints that have a annotation with the
     key `owner`, this is the same as `annotations:owner`
 *   `annotations.protocol=gRPC` returns endpoints that have key/value
     `protocol=gRPC`
 *   `address=192.108.1.105` returns endpoints that have this address
 *   `port>8080` returns endpoints that have port number larger than 8080
 *
 `name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/my-service/endpoints/endpoint-c`
     returns endpoints that have name that is alphabetically later than the
     string, so "endpoint-e" is returned but "endpoint-a" is not
 *
 `name=projects/my-project/locations/us-central1/namespaces/my-namespace/services/my-service/endpoints/ep-1`
      returns the endpoint that has an endpoint_id equal to `ep-1`
 *   `annotations.owner!=sd AND annotations.foo=bar` returns endpoints that
     have `owner` in annotation key but value is not `sd` AND have
     key/value `foo=bar`
 *   `doesnotexist.foo=bar` returns an empty list. Note that endpoint
     doesn't have a field called "doesnotexist". Since the filter does not
     match any endpoint, it returns no results

 For more information about filtering, see
 [API Filtering](https://aip.dev/160).
        string endpoint_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEndpointFilterBytes in interface ResolveServiceRequestOrBuilder
        Returns:
        The bytes for endpointFilter.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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