Class: Google::Cloud::DataCatalog::V1::RoutineSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/datacatalog/v1/datacatalog.rb

Overview

Specification that applies to a routine. Valid only for entries with the ROUTINE type.

Defined Under Namespace

Modules: RoutineType Classes: Argument

Instance Attribute Summary collapse

Instance Attribute Details

#bigquery_routine_spec ⇒ ::Google::Cloud::DataCatalog::V1::BigQueryRoutineSpec

Returns Fields specific for BigQuery routines.

Returns:



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 617

class RoutineSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Input or output argument of a function or stored procedure.
  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the argument. A return argument of a function might not have
  #     a name.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DataCatalog::V1::RoutineSpec::Argument::Mode]
  #     Specifies whether the argument is input or output.
  # @!attribute [rw] type
  #   @return [::String]
  #     Type of the argument. The exact value depends on the source system and
  #     the language.
  class Argument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The input or output mode of the argument.
    module Mode
      # Unspecified mode.
      MODE_UNSPECIFIED = 0

      # The argument is input-only.
      IN = 1

      # The argument is output-only.
      OUT = 2

      # The argument is both an input and an output.
      INOUT = 3
    end
  end

  # The fine-grained type of the routine.
  module RoutineType
    # Unspecified type.
    ROUTINE_TYPE_UNSPECIFIED = 0

    # Non-builtin permanent scalar function.
    SCALAR_FUNCTION = 1

    # Stored procedure.
    PROCEDURE = 2
  end
end

#definition_body ⇒ ::String

Returns The body of the routine.

Returns:

  • (::String) —

    The body of the routine.



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 617

class RoutineSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Input or output argument of a function or stored procedure.
  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the argument. A return argument of a function might not have
  #     a name.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DataCatalog::V1::RoutineSpec::Argument::Mode]
  #     Specifies whether the argument is input or output.
  # @!attribute [rw] type
  #   @return [::String]
  #     Type of the argument. The exact value depends on the source system and
  #     the language.
  class Argument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The input or output mode of the argument.
    module Mode
      # Unspecified mode.
      MODE_UNSPECIFIED = 0

      # The argument is input-only.
      IN = 1

      # The argument is output-only.
      OUT = 2

      # The argument is both an input and an output.
      INOUT = 3
    end
  end

  # The fine-grained type of the routine.
  module RoutineType
    # Unspecified type.
    ROUTINE_TYPE_UNSPECIFIED = 0

    # Non-builtin permanent scalar function.
    SCALAR_FUNCTION = 1

    # Stored procedure.
    PROCEDURE = 2
  end
end

#language ⇒ ::String

Returns The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are:

  • SQL
  • JAVASCRIPT.

Returns:

  • (::String) —

    The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are:

    • SQL
    • JAVASCRIPT


617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 617

class RoutineSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Input or output argument of a function or stored procedure.
  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the argument. A return argument of a function might not have
  #     a name.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DataCatalog::V1::RoutineSpec::Argument::Mode]
  #     Specifies whether the argument is input or output.
  # @!attribute [rw] type
  #   @return [::String]
  #     Type of the argument. The exact value depends on the source system and
  #     the language.
  class Argument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The input or output mode of the argument.
    module Mode
      # Unspecified mode.
      MODE_UNSPECIFIED = 0

      # The argument is input-only.
      IN = 1

      # The argument is output-only.
      OUT = 2

      # The argument is both an input and an output.
      INOUT = 3
    end
  end

  # The fine-grained type of the routine.
  module RoutineType
    # Unspecified type.
    ROUTINE_TYPE_UNSPECIFIED = 0

    # Non-builtin permanent scalar function.
    SCALAR_FUNCTION = 1

    # Stored procedure.
    PROCEDURE = 2
  end
end

#return_type ⇒ ::String

Return type of the argument. The exact value depends on the source system and the language.

Returns:

  • (::String) —

    Return type of the argument. The exact value depends on the source system and the language.



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 617

class RoutineSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Input or output argument of a function or stored procedure.
  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the argument. A return argument of a function might not have
  #     a name.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DataCatalog::V1::RoutineSpec::Argument::Mode]
  #     Specifies whether the argument is input or output.
  # @!attribute [rw] type
  #   @return [::String]
  #     Type of the argument. The exact value depends on the source system and
  #     the language.
  class Argument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The input or output mode of the argument.
    module Mode
      # Unspecified mode.
      MODE_UNSPECIFIED = 0

      # The argument is input-only.
      IN = 1

      # The argument is output-only.
      OUT = 2

      # The argument is both an input and an output.
      INOUT = 3
    end
  end

  # The fine-grained type of the routine.
  module RoutineType
    # Unspecified type.
    ROUTINE_TYPE_UNSPECIFIED = 0

    # Non-builtin permanent scalar function.
    SCALAR_FUNCTION = 1

    # Stored procedure.
    PROCEDURE = 2
  end
end

#routine_arguments ⇒ ::Array<::Google::Cloud::DataCatalog::V1::RoutineSpec::Argument>

Returns Arguments of the routine.

Returns:



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 617

class RoutineSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Input or output argument of a function or stored procedure.
  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the argument. A return argument of a function might not have
  #     a name.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DataCatalog::V1::RoutineSpec::Argument::Mode]
  #     Specifies whether the argument is input or output.
  # @!attribute [rw] type
  #   @return [::String]
  #     Type of the argument. The exact value depends on the source system and
  #     the language.
  class Argument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The input or output mode of the argument.
    module Mode
      # Unspecified mode.
      MODE_UNSPECIFIED = 0

      # The argument is input-only.
      IN = 1

      # The argument is output-only.
      OUT = 2

      # The argument is both an input and an output.
      INOUT = 3
    end
  end

  # The fine-grained type of the routine.
  module RoutineType
    # Unspecified type.
    ROUTINE_TYPE_UNSPECIFIED = 0

    # Non-builtin permanent scalar function.
    SCALAR_FUNCTION = 1

    # Stored procedure.
    PROCEDURE = 2
  end
end

#routine_type ⇒ ::Google::Cloud::DataCatalog::V1::RoutineSpec::RoutineType

Returns The type of the routine.

Returns:



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 617

class RoutineSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Input or output argument of a function or stored procedure.
  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the argument. A return argument of a function might not have
  #     a name.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DataCatalog::V1::RoutineSpec::Argument::Mode]
  #     Specifies whether the argument is input or output.
  # @!attribute [rw] type
  #   @return [::String]
  #     Type of the argument. The exact value depends on the source system and
  #     the language.
  class Argument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The input or output mode of the argument.
    module Mode
      # Unspecified mode.
      MODE_UNSPECIFIED = 0

      # The argument is input-only.
      IN = 1

      # The argument is output-only.
      OUT = 2

      # The argument is both an input and an output.
      INOUT = 3
    end
  end

  # The fine-grained type of the routine.
  module RoutineType
    # Unspecified type.
    ROUTINE_TYPE_UNSPECIFIED = 0

    # Non-builtin permanent scalar function.
    SCALAR_FUNCTION = 1

    # Stored procedure.
    PROCEDURE = 2
  end
end