Class ListDeploymentsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.apihub.v1.ListDeploymentsRequest
All Implemented Interfaces:
ListDeploymentsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class ListDeploymentsRequest extends com.google.protobuf.GeneratedMessage implements ListDeploymentsRequestOrBuilder
 The [ListDeployments][google.cloud.apihub.v1.ApiHub.ListDeployments] method's
 request.
 
Protobuf type google.cloud.apihub.v1.ListDeploymentsRequest
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    The [ListDeployments][google.cloud.apihub.v1.ApiHub.ListDeployments] method's request.

    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
     
    static final int
     
    static final int
     
    static final int
     

    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
     
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    Optional.
    com.google.protobuf.ByteString
    Optional.
    int
    Optional.
    Optional.
    com.google.protobuf.ByteString
    Optional.
    Required.
    com.google.protobuf.ByteString
    Required.
    com.google.protobuf.Parser<ListDeploymentsRequest>
     
    int
     
    int
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ListDeploymentsRequest>
     
     
    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

  • 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
    • getParent

      public String getParent()
       Required. The parent, which owns this collection of deployment resources.
       Format: `projects/{project}/locations/{location}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListDeploymentsRequestOrBuilder
      Returns:
      The parent.
    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The parent, which owns this collection of deployment resources.
       Format: `projects/{project}/locations/{location}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListDeploymentsRequestOrBuilder
      Returns:
      The bytes for parent.
    • getFilter

      public String getFilter()
       Optional. An expression that filters the list of Deployments.
      
       A filter expression consists of a field name, a comparison
       operator, and a value for filtering. The value must be a string. The
       comparison operator must be one of: `<`, `>` or
       `=`. Filters are not case sensitive.
      
       The following fields in the `Deployments` are eligible for filtering:
      
       * `display_name` - The display name of the Deployment. Allowed
       comparison operators: `=`.
       * `create_time` - The time at which the Deployment was created. The
       value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
       format. Allowed comparison operators: `>` and `<`.
       * `resource_uri` - A URI to the deployment resource. Allowed
       comparison operators: `=`.
       * `api_versions` - The API versions linked to this deployment. Allowed
       comparison operators: `:`.
       * `source_project` - The project/organization at source for the
       deployment. Allowed comparison operators: `=`.
       * `source_environment` - The environment at source for the
       deployment. Allowed comparison operators: `=`.
       * `deployment_type.enum_values.values.id` - The allowed value id of the
       deployment_type attribute associated with the Deployment. Allowed
       comparison operators: `:`.
       * `deployment_type.enum_values.values.display_name` - The allowed value
       display name of the deployment_type attribute associated with the
       Deployment. Allowed comparison operators: `:`.
       * `slo.string_values.values` -The allowed string value of the slo
       attribute associated with the deployment. Allowed comparison
       operators: `:`.
       * `environment.enum_values.values.id` - The allowed value id of the
       environment attribute associated with the deployment. Allowed
       comparison operators: `:`.
       * `environment.enum_values.values.display_name` - The allowed value
       display name of the environment attribute associated with the deployment.
       Allowed comparison operators: `:`.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.enum_values.values.id` - The
       allowed value id of the user defined enum attribute associated with the
       Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-enum-id is a placeholder that can be replaced with
       any user defined enum attribute name.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.enum_values.values.display_name`
       - The allowed value display name of the user defined enum attribute
       associated with the Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-enum-display-name is a placeholder that can be
       replaced with any user defined enum attribute enum name.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.string_values.values` - The
       allowed value of the user defined string attribute associated with the
       Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-string is a placeholder that can be replaced with
       any user defined string attribute name.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.json_values.values` - The
       allowed value of the user defined JSON attribute associated with the
       Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-json is a placeholder that can be replaced with
       any user defined JSON attribute name.
      
       A filter function is also supported in the filter string. The filter
       function is `id(name)`. The `id(name)` function returns the id of the
       resource name. For example, `id(name) = \"deployment-1\"` is equivalent to
       `name =
       \"projects/test-project-id/locations/test-location-id/deployments/deployment-1\"`
       provided the parent is
       `projects/test-project-id/locations/test-location-id`.
      
       Expressions are combined with either `AND` logic operator or `OR` logical
       operator but not both of them together i.e. only one of the `AND` or `OR`
       operator can be used throughout the filter string and both the operators
       cannot be used together. No other logical operators are supported. At most
       three filter fields are allowed in the filter string and if provided
       more than that then `INVALID_ARGUMENT` error is returned by the API.
      
       Here are a few examples:
      
       * `environment.enum_values.values.id: staging-id` - The allowed value id
       of the environment attribute associated with the Deployment is
       _staging-id_.
       * `environment.enum_values.values.display_name: \"Staging Deployment\"` -
       The allowed value display name of the environment attribute associated
       with the Deployment is `Staging Deployment`.
       * `environment.enum_values.values.id: production-id AND create_time <
       \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` -
       The allowed value id of the environment attribute associated with the
       Deployment is _production-id_ and Deployment was created before
       _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.
       * `environment.enum_values.values.id: production-id OR
       slo.string_values.values: \"99.99%\"`
       - The allowed value id of the environment attribute Deployment is
       _production-id_ or string value of the slo attribute is _99.99%_.
       * `environment.enum_values.values.id: staging-id AND
       attributes.projects/test-project-id/locations/test-location-id/
       attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values:
       test`  - The filter string specifies that the allowed value id of the
       environment attribute associated with the Deployment is _staging-id_ and
       the value of the user defined attribute of type string is _test_.
       
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilter in interface ListDeploymentsRequestOrBuilder
      Returns:
      The filter.
    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Optional. An expression that filters the list of Deployments.
      
       A filter expression consists of a field name, a comparison
       operator, and a value for filtering. The value must be a string. The
       comparison operator must be one of: `<`, `>` or
       `=`. Filters are not case sensitive.
      
       The following fields in the `Deployments` are eligible for filtering:
      
       * `display_name` - The display name of the Deployment. Allowed
       comparison operators: `=`.
       * `create_time` - The time at which the Deployment was created. The
       value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
       format. Allowed comparison operators: `>` and `<`.
       * `resource_uri` - A URI to the deployment resource. Allowed
       comparison operators: `=`.
       * `api_versions` - The API versions linked to this deployment. Allowed
       comparison operators: `:`.
       * `source_project` - The project/organization at source for the
       deployment. Allowed comparison operators: `=`.
       * `source_environment` - The environment at source for the
       deployment. Allowed comparison operators: `=`.
       * `deployment_type.enum_values.values.id` - The allowed value id of the
       deployment_type attribute associated with the Deployment. Allowed
       comparison operators: `:`.
       * `deployment_type.enum_values.values.display_name` - The allowed value
       display name of the deployment_type attribute associated with the
       Deployment. Allowed comparison operators: `:`.
       * `slo.string_values.values` -The allowed string value of the slo
       attribute associated with the deployment. Allowed comparison
       operators: `:`.
       * `environment.enum_values.values.id` - The allowed value id of the
       environment attribute associated with the deployment. Allowed
       comparison operators: `:`.
       * `environment.enum_values.values.display_name` - The allowed value
       display name of the environment attribute associated with the deployment.
       Allowed comparison operators: `:`.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.enum_values.values.id` - The
       allowed value id of the user defined enum attribute associated with the
       Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-enum-id is a placeholder that can be replaced with
       any user defined enum attribute name.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.enum_values.values.display_name`
       - The allowed value display name of the user defined enum attribute
       associated with the Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-enum-display-name is a placeholder that can be
       replaced with any user defined enum attribute enum name.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.string_values.values` - The
       allowed value of the user defined string attribute associated with the
       Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-string is a placeholder that can be replaced with
       any user defined string attribute name.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.json_values.values` - The
       allowed value of the user defined JSON attribute associated with the
       Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-json is a placeholder that can be replaced with
       any user defined JSON attribute name.
      
       A filter function is also supported in the filter string. The filter
       function is `id(name)`. The `id(name)` function returns the id of the
       resource name. For example, `id(name) = \"deployment-1\"` is equivalent to
       `name =
       \"projects/test-project-id/locations/test-location-id/deployments/deployment-1\"`
       provided the parent is
       `projects/test-project-id/locations/test-location-id`.
      
       Expressions are combined with either `AND` logic operator or `OR` logical
       operator but not both of them together i.e. only one of the `AND` or `OR`
       operator can be used throughout the filter string and both the operators
       cannot be used together. No other logical operators are supported. At most
       three filter fields are allowed in the filter string and if provided
       more than that then `INVALID_ARGUMENT` error is returned by the API.
      
       Here are a few examples:
      
       * `environment.enum_values.values.id: staging-id` - The allowed value id
       of the environment attribute associated with the Deployment is
       _staging-id_.
       * `environment.enum_values.values.display_name: \"Staging Deployment\"` -
       The allowed value display name of the environment attribute associated
       with the Deployment is `Staging Deployment`.
       * `environment.enum_values.values.id: production-id AND create_time <
       \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` -
       The allowed value id of the environment attribute associated with the
       Deployment is _production-id_ and Deployment was created before
       _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.
       * `environment.enum_values.values.id: production-id OR
       slo.string_values.values: \"99.99%\"`
       - The allowed value id of the environment attribute Deployment is
       _production-id_ or string value of the slo attribute is _99.99%_.
       * `environment.enum_values.values.id: staging-id AND
       attributes.projects/test-project-id/locations/test-location-id/
       attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values:
       test`  - The filter string specifies that the allowed value id of the
       environment attribute associated with the Deployment is _staging-id_ and
       the value of the user defined attribute of type string is _test_.
       
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterBytes in interface ListDeploymentsRequestOrBuilder
      Returns:
      The bytes for filter.
    • getPageSize

      public int getPageSize()
       Optional. The maximum number of deployment resources to return. The service
       may return fewer than this value. If unspecified, at most 50 deployments
       will be returned. The maximum value is 1000; values above 1000 will be
       coerced to 1000.
       
      int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageSize in interface ListDeploymentsRequestOrBuilder
      Returns:
      The pageSize.
    • getPageToken

      public String getPageToken()
       Optional. A page token, received from a previous `ListDeployments` call.
       Provide this to retrieve the subsequent page.
      
       When paginating, all other parameters (except page_size) provided to
       `ListDeployments` must match the call that provided the page token.
       
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface ListDeploymentsRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. A page token, received from a previous `ListDeployments` call.
       Provide this to retrieve the subsequent page.
      
       When paginating, all other parameters (except page_size) provided to
       `ListDeployments` must match the call that provided the page token.
       
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface ListDeploymentsRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • 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 ListDeploymentsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

      public static ListDeploymentsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

      public static ListDeploymentsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static ListDeploymentsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static ListDeploymentsRequest.Builder newBuilder()
    • newBuilder

      public static ListDeploymentsRequest.Builder newBuilder(ListDeploymentsRequest prototype)
    • toBuilder

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

      protected ListDeploymentsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static ListDeploymentsRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<ListDeploymentsRequest> parser()
    • getParserForType

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