@dataform/core 3.0.0-beta.1 → 3.0.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/bundle.d.ts CHANGED
@@ -84,8 +84,8 @@ namespace dataform {
84
84
  /** WorkflowSettings namePrefix */
85
85
  namePrefix?: (string|null);
86
86
 
87
- /** WorkflowSettings defaultNotebookOutputBucket */
88
- defaultNotebookOutputBucket?: (string|null);
87
+ /** WorkflowSettings defaultNotebookRuntimeOptions */
88
+ defaultNotebookRuntimeOptions?: (dataform.INotebookRuntimeOptionsConfig|null);
89
89
  }
90
90
 
91
91
  /** Represents a WorkflowSettings. */
@@ -124,8 +124,8 @@ namespace dataform {
124
124
  /** WorkflowSettings namePrefix. */
125
125
  public namePrefix: string;
126
126
 
127
- /** WorkflowSettings defaultNotebookOutputBucket. */
128
- public defaultNotebookOutputBucket: string;
127
+ /** WorkflowSettings defaultNotebookRuntimeOptions. */
128
+ public defaultNotebookRuntimeOptions?: (dataform.INotebookRuntimeOptionsConfig|null);
129
129
 
130
130
  /**
131
131
  * Creates a new WorkflowSettings instance using the specified properties.
@@ -1788,6 +1788,106 @@ namespace dataform {
1788
1788
  }
1789
1789
  }
1790
1790
 
1791
+ /** Properties of a NotebookRuntimeOptionsConfig. */
1792
+ interface INotebookRuntimeOptionsConfig {
1793
+
1794
+ /** NotebookRuntimeOptionsConfig outputBucket */
1795
+ outputBucket?: (string|null);
1796
+ }
1797
+
1798
+ /** Represents a NotebookRuntimeOptionsConfig. */
1799
+ class NotebookRuntimeOptionsConfig implements INotebookRuntimeOptionsConfig {
1800
+
1801
+ /**
1802
+ * Constructs a new NotebookRuntimeOptionsConfig.
1803
+ * @param [properties] Properties to set
1804
+ */
1805
+ constructor(properties?: dataform.INotebookRuntimeOptionsConfig);
1806
+
1807
+ /** NotebookRuntimeOptionsConfig outputBucket. */
1808
+ public outputBucket?: (string|null);
1809
+
1810
+ /** NotebookRuntimeOptionsConfig outputSink. */
1811
+ public outputSink?: "outputBucket";
1812
+
1813
+ /**
1814
+ * Creates a new NotebookRuntimeOptionsConfig instance using the specified properties.
1815
+ * @param [properties] Properties to set
1816
+ * @returns NotebookRuntimeOptionsConfig instance
1817
+ */
1818
+ public static create(properties?: dataform.INotebookRuntimeOptionsConfig): dataform.NotebookRuntimeOptionsConfig;
1819
+
1820
+ /**
1821
+ * Encodes the specified NotebookRuntimeOptionsConfig message. Does not implicitly {@link dataform.NotebookRuntimeOptionsConfig.verify|verify} messages.
1822
+ * @param message NotebookRuntimeOptionsConfig message or plain object to encode
1823
+ * @param [writer] Writer to encode to
1824
+ * @returns Writer
1825
+ */
1826
+ public static encode(message: dataform.INotebookRuntimeOptionsConfig, writer?: Writer): Writer;
1827
+
1828
+ /**
1829
+ * Encodes the specified NotebookRuntimeOptionsConfig message, length delimited. Does not implicitly {@link dataform.NotebookRuntimeOptionsConfig.verify|verify} messages.
1830
+ * @param message NotebookRuntimeOptionsConfig message or plain object to encode
1831
+ * @param [writer] Writer to encode to
1832
+ * @returns Writer
1833
+ */
1834
+ public static encodeDelimited(message: dataform.INotebookRuntimeOptionsConfig, writer?: Writer): Writer;
1835
+
1836
+ /**
1837
+ * Decodes a NotebookRuntimeOptionsConfig message from the specified reader or buffer.
1838
+ * @param reader Reader or buffer to decode from
1839
+ * @param [length] Message length if known beforehand
1840
+ * @returns NotebookRuntimeOptionsConfig
1841
+ * @throws {Error} If the payload is not a reader or valid buffer
1842
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
1843
+ */
1844
+ public static decode(reader: (Reader|Uint8Array), length?: number): dataform.NotebookRuntimeOptionsConfig;
1845
+
1846
+ /**
1847
+ * Decodes a NotebookRuntimeOptionsConfig message from the specified reader or buffer, length delimited.
1848
+ * @param reader Reader or buffer to decode from
1849
+ * @returns NotebookRuntimeOptionsConfig
1850
+ * @throws {Error} If the payload is not a reader or valid buffer
1851
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
1852
+ */
1853
+ public static decodeDelimited(reader: (Reader|Uint8Array)): dataform.NotebookRuntimeOptionsConfig;
1854
+
1855
+ /**
1856
+ * Verifies a NotebookRuntimeOptionsConfig message.
1857
+ * @param message Plain object to verify
1858
+ * @returns `null` if valid, otherwise the reason why it is not
1859
+ */
1860
+ public static verify(message: { [k: string]: any }): (string|null);
1861
+
1862
+ /**
1863
+ * Creates a NotebookRuntimeOptionsConfig message from a plain object. Also converts values to their respective internal types.
1864
+ * @param object Plain object
1865
+ * @returns NotebookRuntimeOptionsConfig
1866
+ */
1867
+ public static fromObject(object: { [k: string]: any }): dataform.NotebookRuntimeOptionsConfig;
1868
+
1869
+ /**
1870
+ * Creates a plain object from a NotebookRuntimeOptionsConfig message. Also converts values to other types if specified.
1871
+ * @param message NotebookRuntimeOptionsConfig
1872
+ * @param [options] Conversion options
1873
+ * @returns Plain object
1874
+ */
1875
+ public static toObject(message: dataform.NotebookRuntimeOptionsConfig, options?: IConversionOptions): { [k: string]: any };
1876
+
1877
+ /**
1878
+ * Converts this NotebookRuntimeOptionsConfig to JSON.
1879
+ * @returns JSON object
1880
+ */
1881
+ public toJSON(): { [k: string]: any };
1882
+
1883
+ /**
1884
+ * Gets the default type url for NotebookRuntimeOptionsConfig
1885
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
1886
+ * @returns The default type url
1887
+ */
1888
+ public static getTypeUrl(typeUrlPrefix?: string): string;
1889
+ }
1890
+
1791
1891
  /** Properties of a ProjectConfig. */
1792
1892
  interface IProjectConfig {
1793
1893
 
@@ -1818,8 +1918,8 @@ namespace dataform {
1818
1918
  /** ProjectConfig tablePrefix */
1819
1919
  tablePrefix?: (string|null);
1820
1920
 
1821
- /** ProjectConfig defaultNotebookOutputBucket */
1822
- defaultNotebookOutputBucket?: (string|null);
1921
+ /** ProjectConfig defaultNotebookRuntimeOptions */
1922
+ defaultNotebookRuntimeOptions?: (dataform.INotebookRuntimeOptions|null);
1823
1923
  }
1824
1924
 
1825
1925
  /** Represents a ProjectConfig. */
@@ -1858,8 +1958,8 @@ namespace dataform {
1858
1958
  /** ProjectConfig tablePrefix. */
1859
1959
  public tablePrefix: string;
1860
1960
 
1861
- /** ProjectConfig defaultNotebookOutputBucket. */
1862
- public defaultNotebookOutputBucket: string;
1961
+ /** ProjectConfig defaultNotebookRuntimeOptions. */
1962
+ public defaultNotebookRuntimeOptions?: (dataform.INotebookRuntimeOptions|null);
1863
1963
 
1864
1964
  /**
1865
1965
  * Creates a new ProjectConfig instance using the specified properties.
@@ -3641,6 +3741,106 @@ namespace dataform {
3641
3741
  public static getTypeUrl(typeUrlPrefix?: string): string;
3642
3742
  }
3643
3743
 
3744
+ /** Properties of a NotebookRuntimeOptions. */
3745
+ interface INotebookRuntimeOptions {
3746
+
3747
+ /** NotebookRuntimeOptions outputBucket */
3748
+ outputBucket?: (string|null);
3749
+ }
3750
+
3751
+ /** Represents a NotebookRuntimeOptions. */
3752
+ class NotebookRuntimeOptions implements INotebookRuntimeOptions {
3753
+
3754
+ /**
3755
+ * Constructs a new NotebookRuntimeOptions.
3756
+ * @param [properties] Properties to set
3757
+ */
3758
+ constructor(properties?: dataform.INotebookRuntimeOptions);
3759
+
3760
+ /** NotebookRuntimeOptions outputBucket. */
3761
+ public outputBucket?: (string|null);
3762
+
3763
+ /** NotebookRuntimeOptions outputSink. */
3764
+ public outputSink?: "outputBucket";
3765
+
3766
+ /**
3767
+ * Creates a new NotebookRuntimeOptions instance using the specified properties.
3768
+ * @param [properties] Properties to set
3769
+ * @returns NotebookRuntimeOptions instance
3770
+ */
3771
+ public static create(properties?: dataform.INotebookRuntimeOptions): dataform.NotebookRuntimeOptions;
3772
+
3773
+ /**
3774
+ * Encodes the specified NotebookRuntimeOptions message. Does not implicitly {@link dataform.NotebookRuntimeOptions.verify|verify} messages.
3775
+ * @param message NotebookRuntimeOptions message or plain object to encode
3776
+ * @param [writer] Writer to encode to
3777
+ * @returns Writer
3778
+ */
3779
+ public static encode(message: dataform.INotebookRuntimeOptions, writer?: Writer): Writer;
3780
+
3781
+ /**
3782
+ * Encodes the specified NotebookRuntimeOptions message, length delimited. Does not implicitly {@link dataform.NotebookRuntimeOptions.verify|verify} messages.
3783
+ * @param message NotebookRuntimeOptions message or plain object to encode
3784
+ * @param [writer] Writer to encode to
3785
+ * @returns Writer
3786
+ */
3787
+ public static encodeDelimited(message: dataform.INotebookRuntimeOptions, writer?: Writer): Writer;
3788
+
3789
+ /**
3790
+ * Decodes a NotebookRuntimeOptions message from the specified reader or buffer.
3791
+ * @param reader Reader or buffer to decode from
3792
+ * @param [length] Message length if known beforehand
3793
+ * @returns NotebookRuntimeOptions
3794
+ * @throws {Error} If the payload is not a reader or valid buffer
3795
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
3796
+ */
3797
+ public static decode(reader: (Reader|Uint8Array), length?: number): dataform.NotebookRuntimeOptions;
3798
+
3799
+ /**
3800
+ * Decodes a NotebookRuntimeOptions message from the specified reader or buffer, length delimited.
3801
+ * @param reader Reader or buffer to decode from
3802
+ * @returns NotebookRuntimeOptions
3803
+ * @throws {Error} If the payload is not a reader or valid buffer
3804
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
3805
+ */
3806
+ public static decodeDelimited(reader: (Reader|Uint8Array)): dataform.NotebookRuntimeOptions;
3807
+
3808
+ /**
3809
+ * Verifies a NotebookRuntimeOptions message.
3810
+ * @param message Plain object to verify
3811
+ * @returns `null` if valid, otherwise the reason why it is not
3812
+ */
3813
+ public static verify(message: { [k: string]: any }): (string|null);
3814
+
3815
+ /**
3816
+ * Creates a NotebookRuntimeOptions message from a plain object. Also converts values to their respective internal types.
3817
+ * @param object Plain object
3818
+ * @returns NotebookRuntimeOptions
3819
+ */
3820
+ public static fromObject(object: { [k: string]: any }): dataform.NotebookRuntimeOptions;
3821
+
3822
+ /**
3823
+ * Creates a plain object from a NotebookRuntimeOptions message. Also converts values to other types if specified.
3824
+ * @param message NotebookRuntimeOptions
3825
+ * @param [options] Conversion options
3826
+ * @returns Plain object
3827
+ */
3828
+ public static toObject(message: dataform.NotebookRuntimeOptions, options?: IConversionOptions): { [k: string]: any };
3829
+
3830
+ /**
3831
+ * Converts this NotebookRuntimeOptions to JSON.
3832
+ * @returns JSON object
3833
+ */
3834
+ public toJSON(): { [k: string]: any };
3835
+
3836
+ /**
3837
+ * Gets the default type url for NotebookRuntimeOptions
3838
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
3839
+ * @returns The default type url
3840
+ */
3841
+ public static getTypeUrl(typeUrlPrefix?: string): string;
3842
+ }
3843
+
3644
3844
  /** Properties of a CompiledGraph. */
3645
3845
  interface ICompiledGraph {
3646
3846
 
@@ -6536,7 +6736,7 @@ declare class Assertion extends ActionBuilder<dataform.Assertion> {
6536
6736
  query(query: AContextable<string>): this;
6537
6737
  dependencies(value: Resolvable | Resolvable[]): this;
6538
6738
  hermetic(hermetic: boolean): void;
6539
- disabled(): this;
6739
+ disabled(disabled?: boolean): this;
6540
6740
  tags(value: string | string[]): this;
6541
6741
  description(description: string): this;
6542
6742
  database(database: string): this;
@@ -6597,7 +6797,7 @@ declare class Operation extends ActionBuilder<dataform.Operation> {
6597
6797
  queries(queries: Contextable<ICommonContext, string | string[]>): this;
6598
6798
  dependencies(value: Resolvable | Resolvable[]): this;
6599
6799
  hermetic(hermetic: boolean): void;
6600
- disabled(): this;
6800
+ disabled(disabled?: boolean): this;
6601
6801
  tags(value: string | string[]): this;
6602
6802
  hasOutput(hasOutput: boolean): this;
6603
6803
  description(description: string): this;
@@ -6673,7 +6873,7 @@ declare class Table extends ActionBuilder<dataform.Table> {
6673
6873
  where(where: Contextable<ITableContext, string>): this;
6674
6874
  preOps(pres: Contextable<ITableContext, string | string[]>): this;
6675
6875
  postOps(posts: Contextable<ITableContext, string | string[]>): this;
6676
- disabled(): this;
6876
+ disabled(disabled?: boolean): this;
6677
6877
  protected(): this;
6678
6878
  uniqueKey(uniqueKey: string[]): void;
6679
6879
  materialized(materialized: boolean): void;
@@ -6774,7 +6974,7 @@ declare abstract class ActionBuilder<T> {
6774
6974
  session: Session;
6775
6975
  constructor(session?: Session);
6776
6976
  applySessionCanonicallyToTarget(targetFromConfig: dataform.Target): dataform.Target;
6777
- applySessionToTarget(targetFromConfig: dataform.Target): dataform.Target;
6977
+ applySessionToTarget(targetFromConfig: dataform.Target, fileName?: string): dataform.Target;
6778
6978
  abstract config(config: any): ActionBuilder<T>;
6779
6979
  abstract getFileName(): string;
6780
6980
  abstract getTarget(): dataform.Target;
@@ -6850,7 +7050,7 @@ declare class ActionIndex {
6850
7050
  find(target: dataform.ITarget): Action[];
6851
7051
  }
6852
7052
 
6853
- declare const version = "3.0.0-beta.1";
7053
+ declare const version = "3.0.0-beta.3";
6854
7054
 
6855
7055
  declare const session: Session;
6856
7056
  declare const supportedFeatures: dataform.SupportedFeatures[];