.TH "GCLOUD_ALPHA_RESOURCE\-MANAGER_FOLDERS_SEARCH" 1



.SH "NAME"
.HP
gcloud alpha resource\-manager folders search \- search folders matching the specified query



.SH "SYNOPSIS"
.HP
\f5gcloud alpha resource\-manager folders search\fR [\fB\-\-query\fR=\fIQUERY\fR] [\fB\-\-limit\fR=\fILIMIT\fR] [\fB\-\-page\-size\fR=\fIPAGE_SIZE\fR] [\fB\-\-sort\-by\fR=[\fIFIELD\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR You can specify the maximum number of folders to return in the
result using the \f5\-\-limit`flag.


\fR

.SH "EXAMPLES"

The following command lists the folders that have been marked for deletion:

.RS 2m
$ gcloud alpha resource\-manager folders search \e
    \-\-query='state:DELETE_REQUESTED'
.RE

Folders with their displayNames starting with sun like sunflower\-folder,
sunburn\-folder etc. can be listed using the below command

.RS 2m
$ gcloud alpha resource\-manager folders search \e
    \-\-query='displayName:sun*'
.RE



.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-query\fR=\fIQUERY\fR

A boolean expression for the search criteria used to select the folders to
return. If no search criteria is specified then all accessible projects will be
returned. Query expressions can be used to restrict results based upon
displayName, state and parent, where the operators \f5=\fR (\f5:\fR) \f5NOT\fR,
\f5AND\fR and \f5OR\fR can be used along with the suffix wildcard symbol
\f5*\fR. The \f5displayName\fR field in a query expression should use escaped
quotes for values that include whitespace to prevent unexpected behavior.

For more details and fields supported by the query expression please refer query
parameters section \f5[here]
(https://cloud.google.com/resource\-manager/reference/rest/v3/folders/search#query\-parameters)\fR


.RE
.sp

.SH "LIST COMMAND FLAGS"

.RS 2m
.TP 2m
\fB\-\-limit\fR=\fILIMIT\fR

Maximum number of resources to list. The default is \fBunlimited\fR. This flag
interacts with other flags that are applied in this order: \fB\-\-flatten\fR,
\fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.

.TP 2m
\fB\-\-page\-size\fR=\fIPAGE_SIZE\fR

This flag specifies the maximum number of folders per page.

.TP 2m
\fB\-\-sort\-by\fR=[\fIFIELD\fR,...]

Comma\-separated list of resource field key names to sort by. The default order
is ascending. Prefix a field with ``~'' for descending order on that field. This
flag interacts with other flags that are applied in this order:
\fB\-\-flatten\fR, \fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.


.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist.