Package com.pulumi.gcp.firestore.inputs

Class IndexState

  • public final class IndexState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  IndexState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static IndexState Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> apiScope()  
      static IndexState.Builder builder()  
      static IndexState.Builder builder​(IndexState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> collection()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> database()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<IndexFieldArgs>>> fields()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> project()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> queryScope()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • apiScope

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> apiScope()
        Returns:
        The API scope at which a query is run. Default value is `ANY_API`. Possible values are: `ANY_API`, `DATASTORE_MODE_API`.

      • collection

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> collection()
        Returns:
        The collection being indexed.

      • database

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> database()
        Returns:
        The Firestore database id. Defaults to `"(default)"`.

      • fields

        public java.util.Optional<com.pulumi.core.Output<java.util.List<IndexFieldArgs>>> fields()
        Returns:
        The fields supported by this index. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered `"ASCENDING"` (unless explicitly specified otherwise). Structure is documented below.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        A server defined name for this index. Format: `projects/{{project}}/databases/{{database}}/collectionGroups/{{collection}}/indexes/{{server_generated_id}}`

      • project

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> project()
        Returns:
        The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

      • queryScope

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> queryScope()
        Returns:
        The scope at which a query is run. Default value is `COLLECTION`. Possible values are: `COLLECTION`, `COLLECTION_GROUP`, `COLLECTION_RECURSIVE`.