view release on metacpan or  search on metacpan

lib/Google/ProtocolBuffers/Dynamic/Introspection.pod  view on Meta::CPAN

The short name of this service (the one used in the message definition).

=head2 full_name

    $name = $service_def->full_name;

The fully-qualified name of this service (including package).

=head2 methods

    $method_defs = $service_def->methods;

Returns all methods as an array reference.

=head2 file

    $file_def = $service_def->file;

Returns the file this service was defined in.

=head2 options

    $options = $service_def->options;

Describes the options set on the service, see L<OPTIONS|/OPTIONS>.
Always returns a value, even if no options are set.

=head1 Google::ProtocolBuffers::Dynamic::MethodDef

=head2 name

    $name = $method_def->name;

The short name of this method (the one used in the service definition).

=head2 full_name

    $name = $method_def->full_name;

The fully-qualified name of this method (including package and service name).

=head2 containing_service

    $service_def = $method_def->containing_service;

Containing service definition.

=head2 input_type

    $message_def = $method_def->input_type;

Input type for the method.

=head2 output_type

    $message_def = $method_def->output_type;

Output type for the method.

=head2 client_streaming

    $is_streaming_client = $method_def->client_streaming.

True if the service accepts streaming input (i.e. the input type has
the C<stream> annotation in the method definition).

=head2 server_streaming

    $is_streaming_server = $method_def->server_streaming.

True if the service produces streaming output (i.e. the output type has
the C<stream> annotation in the method definition).

=head2 file

    $file_def = $method_def->file;

Returns the file this method was defined in.

=head2 options

    $options = $method_def->options;

Describes the options set on the method, see L<OPTIONS|/OPTIONS>.
Always returns a value, even if no options are set.

=head1 Google::ProtocolBuffers::Dynamic::FileDef

=head2 name

    $name = $file_def->name;

The file name relative to the search path.

=head2 package

    $package = $file_def->package;

The Protocol Buffers package declared in the file.

=head2 dependencies, public_dependencies, messages, enums, services, extensions

    $message_defs = $file_def->messages;
    $enum_defs = $file_def->enums;
    $service_defs = $file_def->servicess;
    $field_defs = $file_def->extensionss;
    $file_defs = $file_def->dependencies;
    $file_defs = $file_def->public_dependencies;

Returns all messages/enums/services/extensions/dependencies and
public dependencies as an array reference.

=head2 options

    $options = $file_def->options;

Describes the options set on the file, see L<OPTIONS|/OPTIONS>.
Always returns a value, even if no options are set.

=head1 OPTIONS

This section documents the option objects returned by the vairous
C<options()> methods.

Standard Protocol Buffers options can be accessed by using a method
with the same name of the option (e.g. C<<< $options->java_package >>>.

In addition to that, all option objects provide the following methods.

=head2 custom_option_by_name