.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "GitLab::API::v4::Config 3pm"
.TH GitLab::API::v4::Config 3pm "2019-01-28" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
GitLab::API::v4::Config \- Load configuration from a file, environment,
and/or CLI options.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use GitLab::API::v4;
\&    use GitLab::API::v4::Config;
\&    
\&    my $config = GitLab::API::v4::Config\->new();
\&    my $api = GitLab::API::v4\->new( $config\->args() );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is used by gitlab\-api\-v4 to load configuration.
.PP
If you are using GitLab::API::v4 directly then this module will not be
automatically used, but you are welcome to explicitly use it as shown in the
\&\*(L"\s-1SYNOPSIS\*(R"\s0.
.SH "ARGUMENTS"
.IX Header "ARGUMENTS"
.SS "file"
.IX Subsection "file"
The file to load configuration from.  The file should hold valid \s-1JSON.\s0
.PP
By default this will be set to \f(CW\*(C`.gitlab\-api\-v4\-config\*(C'\fR in the current
user's home directory.
.PP
This can be overridden with the \f(CW\*(C`GITLAB_API_V4_CONFIG_FILE\*(C'\fR environment
variable or the \f(CW\*(C`\-\-config\-file=...\*(C'\fR command line argument.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "opt_args"
.IX Subsection "opt_args"
Returns a hashref of arguments derived from command line options.
.PP
Supported options are:
.PP
.Vb 5
\&    \-\-config_file=...
\&    \-\-url=...
\&    \-\-private\-token=...
\&    \-\-access\-token=...
\&    \-\-retries=...
.Ve
.PP
Note that the options are read from, and removed from, \f(CW@ARGV\fR.  Due
to this the arguments are saved internally and re-used for all instances
of this class so that there are no weird race conditions.
.SS "env_args"
.IX Subsection "env_args"
Returns a hashref of arguments derived from environment variables.
.PP
Supported environment variables are:
.PP
.Vb 5
\&    GITLAB_API_V4_CONFIG_FILE
\&    GITLAB_API_V4_URL
\&    GITLAB_API_V4_PRIVATE_TOKEN
\&    GITLAB_API_V4_ACCESS_TOKEN
\&    GITLAB_API_V4_RETRIES
.Ve
.SS "file_args"
.IX Subsection "file_args"
Returns a hashref of arguments gotten by decoding the \s-1JSON\s0 in the \*(L"file\*(R".
.SS "args"
.IX Subsection "args"
Returns a final, combined, hashref of arguments containing everything in
\&\*(L"opt_args\*(R", \*(L"env_args\*(R", and \*(L"file_args\*(R".  If there are any duplicate
arguments then \*(L"opt_args\*(R" has highest precedence, \*(L"env_args\*(R" is next, and
at the bottom is \*(L"file_args\*(R".
.SH "METHODS"
.IX Header "METHODS"
.SS "get_options"
.IX Subsection "get_options"
.SS "configure"
.IX Subsection "configure"
When called this method interactively prompts the user for argument values
and then encodes them as \s-1JSON\s0 and stores them in \*(L"file\*(R".  The file will
be chmod'ed \f(CW0600\fR so that only the current user may read or write to the
file.
.SH "AUTHORS"
.IX Header "AUTHORS"
See \*(L"\s-1AUTHOR\*(R"\s0 in GitLab::API::v4 and \*(L"\s-1CONTRIBUTORS\*(R"\s0 in GitLab::API::v4.
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.