Package com.google.cloud.servicedirectory.v1

Class ResolveServiceRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.servicedirectory.v1.ResolveServiceRequest
All Implemented Interfaces:
ResolveServiceRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ResolveServiceRequest extends com.google.protobuf.GeneratedMessage 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ResolveServiceRequest.Builder
    The request message for [LookupService.ResolveService][google.cloud.servicedirectory.v1.LookupService.ResolveService].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ENDPOINT_FILTER_FIELD_NUMBER
     
    static final int
    MAX_ENDPOINTS_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ResolveServiceRequest
    getDefaultInstance()
     
    ResolveServiceRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getEndpointFilter()
    Optional.
    com.google.protobuf.ByteString
    getEndpointFilterBytes()
    Optional.
    int
    getMaxEndpoints()
    Optional.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    com.google.protobuf.Parser<ResolveServiceRequest>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ResolveServiceRequest.Builder
    newBuilder()
     
    static ResolveServiceRequest.Builder
    newBuilder(ResolveServiceRequest prototype)
     
    ResolveServiceRequest.Builder
    newBuilderForType()
     
    protected ResolveServiceRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ResolveServiceRequest
    parseDelimitedFrom(InputStream input)
     
    static ResolveServiceRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResolveServiceRequest
    parseFrom(byte[] data)
     
    static ResolveServiceRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResolveServiceRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ResolveServiceRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResolveServiceRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ResolveServiceRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResolveServiceRequest
    parseFrom(InputStream input)
     
    static ResolveServiceRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResolveServiceRequest
    parseFrom(ByteBuffer data)
     
    static ResolveServiceRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ResolveServiceRequest>
    parser()
     
    ResolveServiceRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • MAX_ENDPOINTS_FIELD_NUMBER

      public static final int MAX_ENDPOINTS_FIELD_NUMBER
      See Also:

    • ENDPOINT_FILTER_FIELD_NUMBER

      public static final int ENDPOINT_FILTER_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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

    • parseFrom

      public static ResolveServiceRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ResolveServiceRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ResolveServiceRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ResolveServiceRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ResolveServiceRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ResolveServiceRequest.Builder newBuilder()

    • newBuilder

      public static ResolveServiceRequest.Builder newBuilder(ResolveServiceRequest prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ResolveServiceRequest getDefaultInstance()

    • parser

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

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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