Skip to content

Commit dd1714b

Browse files
tseavertseaver
authored
Expose 'to_api_repr' method for jobs. (googleapis#6176)
Leave '_build_resource' behind as a backward-compatibility alias. Closes googleapis#5866.
1 parent a39348a commit dd1714b

4 files changed

Lines changed: 20 additions & 12 deletions

File tree

‎bigquery/google/cloud/bigquery/client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -949,7 +949,7 @@ def load_table_from_file(
949949

950950
job_ref = job._JobReference(job_id, project=project, location=location)
951951
load_job = job.LoadJob(job_ref, None, destination, self, job_config)
952-
job_resource = load_job._build_resource()
952+
job_resource = load_job.to_api_repr()
953953

954954
if rewind:
955955
file_obj.seek(0, os.SEEK_SET)

‎bigquery/google/cloud/bigquery/job.py‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -519,10 +519,12 @@ def _get_resource_config(cls, resource):
519519
'["configuration"]["%s"]' % cls._JOB_TYPE)
520520
return job_id, resource['configuration']
521521

522-
def _build_resource(self):
523-
"""Helper: Generate a resource for :meth:`_begin`."""
522+
def to_api_repr(self):
523+
"""Generate a resource for the job."""
524524
raise NotImplementedError("Abstract")
525525

526+
_build_resource = to_api_repr # backward-compatibility alias
527+
526528
def _begin(self, client=None, retry=DEFAULT_RETRY):
527529
"""API call: begin the job via a POST request
528530
@@ -549,7 +551,7 @@ def _begin(self, client=None, retry=DEFAULT_RETRY):
549551
# job has an ID.
550552
api_response = client._call_api(
551553
retry,
552-
method='POST', path=path, data=self._build_resource())
554+
method='POST', path=path, data=self.to_api_repr())
553555
self._set_properties(api_response)
554556

555557
def exists(self, client=None, retry=DEFAULT_RETRY):
@@ -1367,7 +1369,7 @@ def output_rows(self):
13671369
if statistics is not None:
13681370
return int(statistics['load']['outputRows'])
13691371

1370-
def _build_resource(self):
1372+
def to_api_repr(self):
13711373
"""Generate a resource for :meth:`_begin`."""
13721374
configuration = self._configuration.to_api_repr()
13731375
if self.source_uris is not None:
@@ -1543,7 +1545,7 @@ def destination_encryption_configuration(self):
15431545
"""
15441546
return self._configuration.destination_encryption_configuration
15451547

1546-
def _build_resource(self):
1548+
def to_api_repr(self):
15471549
"""Generate a resource for :meth:`_begin`."""
15481550

15491551
source_refs = [{
@@ -1761,7 +1763,7 @@ def destination_uri_file_counts(self):
17611763
return [int(count) for count in counts]
17621764
return None
17631765

1764-
def _build_resource(self):
1766+
def to_api_repr(self):
17651767
"""Generate a resource for :meth:`_begin`."""
17661768

17671769
source_ref = {
@@ -2367,7 +2369,7 @@ def schema_update_options(self):
23672369
"""
23682370
return self._configuration.schema_update_options
23692371

2370-
def _build_resource(self):
2372+
def to_api_repr(self):
23712373
"""Generate a resource for :meth:`_begin`."""
23722374
configuration = self._configuration.to_api_repr()
23732375

‎bigquery/tests/unit/test_client.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2214,7 +2214,7 @@ def _initiate_resumable_upload_helper(self, num_retries=None):
22142214
config = LoadJobConfig()
22152215
config.source_format = SourceFormat.CSV
22162216
job = LoadJob(None, None, self.TABLE_REF, client, job_config=config)
2217-
metadata = job._build_resource()
2217+
metadata = job.to_api_repr()
22182218
upload, transport = client._initiate_resumable_upload(
22192219
stream, metadata, num_retries)
22202220

@@ -2279,7 +2279,7 @@ def _do_multipart_upload_success_helper(
22792279
config = LoadJobConfig()
22802280
config.source_format = SourceFormat.CSV
22812281
job = LoadJob(None, None, self.TABLE_REF, client, job_config=config)
2282-
metadata = job._build_resource()
2282+
metadata = job.to_api_repr()
22832283
size = len(data)
22842284
response = client._do_multipart_upload(
22852285
stream, metadata, size, num_retries)

‎bigquery/tests/unit/test_job.py‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -522,6 +522,12 @@ def test__build_resource(self):
522522
with self.assertRaises(NotImplementedError):
523523
job._build_resource()
524524

525+
def test_to_api_repr(self):
526+
client = _make_client(project=self.PROJECT)
527+
job = self._make_one(self.JOB_ID, client)
528+
with self.assertRaises(NotImplementedError):
529+
job.to_api_repr()
530+
525531
def test__begin_already(self):
526532
job = self._set_properties_job()
527533
job._properties['status'] = {'state': 'WHATEVER'}
@@ -543,7 +549,7 @@ def test__begin_defaults(self):
543549
}
544550
}
545551
job = self._set_properties_job()
546-
builder = job._build_resource = mock.Mock()
552+
builder = job.to_api_repr = mock.Mock()
547553
builder.return_value = resource
548554
call_api = job._client._call_api = mock.Mock()
549555
call_api.return_value = resource
@@ -573,7 +579,7 @@ def test__begin_explicit(self):
573579
}
574580
}
575581
job = self._set_properties_job()
576-
builder = job._build_resource = mock.Mock()
582+
builder = job.to_api_repr = mock.Mock()
577583
builder.return_value = resource
578584
client = _make_client(project=other_project)
579585
call_api = client._call_api = mock.Mock()

0 commit comments

Comments
 (0)